X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=b72eb92e730b6fec1ee83e6b6c6bbf5be4f43cac;hb=f8b3d84c1c95773a1e18d2c025d89d73c4f2ab15;hp=f946880b5bf656f9a40d48bd03ffbf7b365813a1;hpb=a941ca40d6503650aa3bb05f1d4f5946e041f16b;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index f946880b..b72eb92e 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,5 +1,5 @@ -IWorkerChoiceStrategy | poolifier - v3.1.2

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