X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=cf851a2329980f1b1e1632fb4d396165aa9ef7c7;hb=fcb83cac5406186d9646362d0f3f97db339012d9;hp=901d72f48f86e573bb605ec037b392232e730923;hpb=5d9133ae9ef83c5f69e26daf8dcfea584884d9c4;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 901d72f4..cf851a23 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,5 +1,5 @@ -IWorkerChoiceStrategy | poolifier - v4.0.2

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 +IWorkerChoiceStrategy | poolifier - v4.0.13

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 @@ -10,16 +10,16 @@ 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.

+

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.

+

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.

+

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

Returns void

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
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

chooseremoveresetsetOptionsstrategyPolicytaskStatisticsRequirementsupdate
\ No newline at end of file