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

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 +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 @@ -11,18 +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.

-

Readonly hasPoolWorkerNodesReady

hasPoolWorkerNodesReady: (() => boolean)

Type declaration

    • (): boolean

    • Whether the pool has worker nodes ready or not.

      +

Readonly hasPoolWorkerNodesReady

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.

      -

Readonly remove

remove: ((workerNodeKey) => boolean)

Type declaration

    • (workerNodeKey): boolean

    • Removes the worker node key from strategy internals.

      +

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.

      +

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.

      +

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

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

      -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file