X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=a5d3659cb4c07061c2bd57454c20cacb21e78cc7;hb=b20bf19abbcc1fb78e71f843d6eb56ad8c4c630c;hp=ea73872408247cf22292f784223244815390c4d1;hpb=9ad272eaf0cded8c7e70f1fe6f075c99f23619fa;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index ea738724..a5d3659c 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,5 +1,6 @@ -IWorkerChoiceStrategy | poolifier - v3.0.8

Interface IWorkerChoiceStrategyInternal

Worker choice strategy interface.

-

Hierarchy

  • IWorkerChoiceStrategy

Properties

choose +IWorkerChoiceStrategy | poolifier - v3.1.12

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