X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=6d5e15b2f028a757dbbce104d53aba3f9fafbfbf;hb=394676d15b59b7013b9d95889e47a4a49860b057;hp=fbe5f8c7058d6fac1ac89b3bef0fea4caac59acc;hpb=7088591c33a2237d4c5f5160a32de3061f983fe2;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index fbe5f8c7..6d5e15b2 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,39 +1,25 @@ -IWorkerChoiceStrategy | poolifier - v3.1.19

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

    • 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 undefined | number

      The worker node key or undefined.

      -

Returns

The worker node key or undefined.

-

Readonly remove

remove: ((workerNodeKey) => boolean)

Removes the worker node key from strategy internals.

-

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.

      -

Param: workerNodeKey

The worker node key.

-

Returns

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

-

Readonly reset

reset: (() => boolean)

Resets strategy internals.

-

Type declaration

    • (): boolean

    • Resets strategy internals.

      -

      Returns boolean

      true if the reset is successful, false otherwise.

      -

Returns

true if the reset is successful, false otherwise.

-

Readonly setOptions

setOptions: ((opts) => void)

Sets the worker choice strategy options.

-

Type declaration

    • (opts): void

    • Sets the worker choice strategy options.

      -

      Parameters

      Returns void

Param: opts

The worker choice strategy options.

-

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

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.

-

Parameters

  • workerNodeKey: number

Returns boolean

true if the update is successful, false otherwise.

-

Returns

true if the update is successful, false otherwise.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Type declaration

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