X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=b72eb92e730b6fec1ee83e6b6c6bbf5be4f43cac;hb=90e3ad3a6abc5f39b81fb32e32d1d787bf85cf5d;hp=2abdec279d26236f8e4ce3d9692d23b71fab38f0;hpb=cd3135e48c6ba3fb7bdfe3da9ac47ad6805e8797;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 2abdec27..b72eb92e 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,5 +1,6 @@ -IWorkerChoiceStrategy | poolifier - v3.0.9

Interface IWorkerChoiceStrategyInternal

Worker choice strategy interface.

-

Hierarchy

  • IWorkerChoiceStrategy

Properties

choose +IWorkerChoiceStrategy | poolifier - v3.1.11

Interface IWorkerChoiceStrategyInternal

Worker choice strategy interface.

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

Properties

choose +hasPoolWorkerNodesReady remove reset setOptions @@ -10,16 +11,18 @@ If no worker nodes are not eligible, undefined is returned. If undefined is returned, the caller retry.

Returns undefined | number

The worker node key or undefined.

-
remove: ((workerNodeKey) => boolean)

Type declaration

    • (workerNodeKey): boolean
    • Removes the worker node key from strategy internals.

      +
hasPoolWorkerNodesReady: (() => boolean)

Type declaration

    • (): boolean
    • Whether the pool has worker nodes ready or not.

      +

      Returns boolean

      Whether the pool has worker nodes ready or not.

      +
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.

      -
reset: (() => boolean)

Type declaration

    • (): boolean
    • Resets strategy internals.

      +
reset: (() => boolean)

Type declaration

    • (): boolean
    • Resets strategy internals.

      Returns boolean

      true if the reset is successful, false otherwise.

      -
setOptions: ((opts) => void)

Type declaration

    • (opts): void
    • Sets the worker choice strategy options.

      +
setOptions: ((opts) => void)

Type declaration

    • (opts): void
    • Sets the worker choice strategy options.

      Parameters

      Returns void

strategyPolicy: StrategyPolicy

Strategy policy.

-
taskStatisticsRequirements: TaskStatisticsRequirements

Tasks statistics requirements.

-
update: ((workerNodeKey) => boolean)

Type declaration

    • (workerNodeKey): boolean
    • Updates the worker node key strategy internals. +

Returns void

strategyPolicy: StrategyPolicy

Strategy policy.

+
taskStatisticsRequirements: TaskStatisticsRequirements

Tasks statistics requirements.

+
update: ((workerNodeKey) => boolean)

Type declaration

    • (workerNodeKey): boolean
    • Updates the worker node key strategy internals. This is called after a task has been executed on a worker node.

      Parameters

      • workerNodeKey: number

      Returns boolean

      true if the update is successful, false otherwise.

      -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file