X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=9cd1e2749f322c4dc32c0c840336f63995fc0b11;hb=b9f66dae32dbfe46e83c7a498c133855fc6af2a2;hp=437990330491452ea1c1d7cfbbcbd719bb689e39;hpb=afa30fd0dd5bbc5d305cc30be663966a449efc08;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 43799033..9cd1e274 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,20 +1,20 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v3.0.0
-
+
  • The search index is not available
    • poolifier - v3.0.0 +
    -

    Interface IWorkerChoiceStrategy

    +

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

    @@ -24,42 +24,45 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
    • - +

    Properties

    -
    choose +
    choose remove reset setOptions -taskStatistics +strategyPolicy +taskStatisticsRequirements update

    Properties

    -

    choose

    -
    choose: (() => number)
    +

    Readonly choose

    +
    choose: (() => undefined | number)

    Type declaration

      • -
      • (): number
        • +
      • (): undefined | number
      • -

        Chooses a worker node in the pool and returns its key.

        +

        Chooses a worker node in the pool and returns its key. +If no worker nodes are not eligible, undefined is returned. +If undefined is returned, the caller retry.

        -

        Returns number

        The worker node key.

        +

        Returns undefined | number

        The worker node key or undefined.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:197
    • -

    remove

    +

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Type declaration

    @@ -82,9 +85,9 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:204
    • -

    reset

    +

    Readonly reset

    reset: (() => boolean)

    Type declaration

    @@ -99,9 +102,9 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
    • -

    setOptions

    +

    Readonly setOptions

    setOptions: ((opts) => void)

    Type declaration

    @@ -123,17 +126,25 @@

    Returns void

    -
    -

    Readonly taskStatistics

    -
    taskStatistics: TaskStatistics
    -

    Required tasks statistics.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:210
    • +
    +

    Readonly strategyPolicy

    +
    strategyPolicy: StrategyPolicy
    +

    Strategy policy.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
    • +
    +

    Readonly taskStatisticsRequirements

    +
    taskStatisticsRequirements: TaskStatisticsRequirements
    +

    Tasks statistics requirements.

    +
    +
    -

    update

    +

    Readonly update

    update: ((workerNodeKey) => boolean)

    Type declaration

    @@ -142,7 +153,8 @@
    • (workerNodeKey): boolean
    • -

      Updates the worker node key strategy internals.

      +

      Updates the worker node key strategy internals. +This is called after a task has been executed on a worker node.

      Parameters

      @@ -153,12 +165,12 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:189
    • -

    Settings

     +

    Settings

    Member Visibility

    @@ -177,58 +189,34 @@
  • remove
  • reset
  • setOptions
    • -
  • taskStatistics
    • +
  • strategyPolicy
    • +
  • taskStatisticsRequirements
  • update
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file