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

    • (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