Interface IWorkerChoiceStrategy`Internal`

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);
}

Index

Properties

choose -hasPoolWorkerNodesReady -remove -reset -setOptions -strategyPolicy -taskStatisticsRequirements -update -

Properties

`Readonly` choose

choose: (() => undefined | number)

Type declaration

- (): undefined | number
- Chooses a worker node in the pool and returns its key. +IWorkerChoiceStrategy | poolifier - v3.1.22
  Preparing search index...
  The search index is not available
  poolifier - v3.1.22
  poolifier
  IWorkerChoiceStrategy
  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);
  }
  Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
  Index
  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.
  -
  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.
  -
  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.
  -
  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.
  -
  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.
  -
  Parameters
  - opts: WorkerChoiceStrategyOptions
    The worker choice strategy options.
    -
  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. +
  Type declaration
  - - (): undefined | number
    - Returns undefined | number
  Returns
  The worker node key or undefined.
  +
  - Defined in src/pools/selection-strategies/selection-strategies-types.ts:191

`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

- (opts): void
- Parameters
  - opts: undefined | WorkerChoiceStrategyOptions
    The worker choice strategy options.
    +
  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.

Parameters

workerNodeKey: number

Returns boolean

true if the update is successful, false otherwise.

Interface IWorkerChoiceStrategyInternal

Index

Properties

Properties

Readonly choose

Type declaration

Interface IWorkerChoiceStrategyInternal

Index

Properties

Properties

Readonly choose

Returns undefined | number

Readonly hasPoolWorkerNodesReady

Type declaration

Returns boolean

Readonly remove

Type declaration

Parameters

workerNodeKey: number

Returns boolean

Readonly reset

Type declaration

Returns boolean

Readonly setOptions

Type declaration

Parameters

opts: WorkerChoiceStrategyOptions

Returns void

Readonly strategyPolicy

Readonly taskStatisticsRequirements

Readonly update

Type declaration

Type declaration

Returns undefined | number

Returns

Readonly remove

Type declaration

Parameters

Returns boolean

Returns

Readonly reset

Type declaration

Returns boolean

Returns

Readonly setOptions

Type declaration

Parameters

Returns void

Readonly strategyPolicy

Readonly taskStatisticsRequirements

Readonly update

Parameters

workerNodeKey: number

Returns boolean

Settings

Member Visibility

Theme

On This Page

Type declaration

Parameters

Returns boolean

Returns

Settings

Member Visibility

Theme

On This Page

Interface IWorkerChoiceStrategy`Internal`

`Readonly` choose

Interface IWorkerChoiceStrategy`Internal`

`Readonly` choose

`Readonly` hasPoolWorkerNodesReady

`Readonly` remove

`Readonly` reset

`Readonly` setOptions

`Readonly` strategyPolicy

`Readonly` taskStatisticsRequirements

`Readonly` update

`Readonly` remove

`Readonly` reset

`Readonly` setOptions

`Readonly` strategyPolicy

`Readonly` taskStatisticsRequirements

`Readonly` update