X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=6d5e15b2f028a757dbbce104d53aba3f9fafbfbf;hb=394676d15b59b7013b9d95889e47a4a49860b057;hp=61bccb2799b6ab5ea6ecd5caee796a6e6d5b0a9b;hpb=dbf662afd2c11c4d18c4e648f90d392528a715f8;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 61bccb27..6d5e15b2 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,220 +1,25 @@ -IWorkerChoiceStrategy | poolifier - v2.7.0
-
- -
-
-
-
- -

Interface IWorkerChoiceStrategyInternal

-
-

Worker choice strategy interface.

-
-
-
-

Hierarchy

-
    -
  • IWorkerChoiceStrategy
-
-
-
- -
-
-

Properties

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

Properties

-
-

Readonly choose

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

Type declaration

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

      Chooses a worker node in the pool and returns its key. -If the worker node is not eligible, undefined is returned.

      -
      -

      Returns undefined | number

      The worker node key or undefined.

      - -
-
-

Readonly remove

-
remove: ((workerNodeKey) => boolean)
-
-

Type declaration

-
    -
  • -
      -
    • (workerNodeKey): boolean
      • -
    • -

      Removes the worker node key from strategy internals.

      -
      -
      -

      Parameters

      -
        -
      • -
        workerNodeKey: number
        -

        The worker node key.

        -
        -
      -

      Returns boolean

      true if the worker node key is removed, false otherwise.

      - -
-
-

Readonly reset

-
reset: (() => boolean)
-
-

Type declaration

-
    -
  • -
      -
    • (): boolean
      • -
    • -

      Resets strategy internals.

      -
      -

      Returns boolean

      true if the reset is successful, false otherwise.

      - -
-
-

Readonly setOptions

-
setOptions: ((opts) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (opts): void
      • -
    • -

      Sets the worker choice strategy options.

      -
      -
      -

      Parameters

      -
      -

      Returns void

      -
-
-

Readonly strategyPolicy

-
strategyPolicy: StrategyPolicy
-

Strategy policy.

-
-
-
-

Readonly taskStatisticsRequirements

-
taskStatisticsRequirements: TaskStatisticsRequirements
-

Tasks statistics requirements.

-
-
-
-

Readonly update

-
update: ((workerNodeKey) => boolean)
-
-

Type declaration

-
    -
  • -
      -
    • (workerNodeKey): boolean
      • -
    • -

      Updates the worker node key strategy internals.

      -
      -
      -

      Parameters

      -
        -
      • -
        workerNodeKey: number
      -

      Returns boolean

      true if the update is successful, false otherwise.

      - -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +IWorkerChoiceStrategy | poolifier - v3.1.29

Interface IWorkerChoiceStrategyInternal

Worker choice strategy interface.

+
interface IWorkerChoiceStrategy {
    choose: (() => undefined | number);
    remove: ((workerNodeKey) => boolean);
    reset: (() => boolean);
    setOptions: ((opts) => void);
    strategyPolicy: StrategyPolicy;
    taskStatisticsRequirements: TaskStatisticsRequirements;
    update: ((workerNodeKey) => boolean);
}

Properties

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

Properties

Readonly choose

choose: (() => undefined | number)

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.

+

Type declaration

    • (): undefined | number

    • Returns undefined | number

Returns

The worker node key or undefined.

+

Readonly remove

remove: ((workerNodeKey) => boolean)

Removes the worker node key from strategy internals.

+

Type declaration

    • (workerNodeKey): boolean

    • Parameters

      • workerNodeKey: number

        The worker node key.

        +

      Returns boolean

Returns

true if the worker node key is removed, false otherwise.

+

Readonly reset

reset: (() => boolean)

Resets strategy internals.

+

Type declaration

    • (): boolean

    • Returns boolean

Returns

true if the reset is successful, false otherwise.

+

Readonly setOptions

setOptions: ((opts) => void)

Sets the worker choice strategy options.

+

Type declaration

Readonly strategyPolicy

strategyPolicy: StrategyPolicy

Strategy policy.

+

Readonly taskStatisticsRequirements

taskStatisticsRequirements: TaskStatisticsRequirements

Tasks statistics requirements.

+

Readonly update

update: ((workerNodeKey) => boolean)

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

+

Type declaration

    • (workerNodeKey): boolean

    • Parameters

      • workerNodeKey: number

      Returns boolean

Returns

true if the update is successful, false otherwise.

+

Settings

Member Visibility

Theme

On This Page

chooseremoveresetsetOptionsstrategyPolicytaskStatisticsRequirementsupdate

Generated using TypeDoc

\ No newline at end of file