WorkerChoiceStrategyContext

Constructors

constructor

new WorkerChoiceStrategyContext<Worker, Data, Response>(pool: IPool<Worker, Data, Response>, workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", opts?: WorkerChoiceStrategyOptions): WorkerChoiceStrategyContext<Worker, Data, Response>

constructor

new WorkerChoiceStrategyContext<Worker, Data, Response>(pool, workerChoiceStrategy?, opts?): WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context constructor.

-
+
Type Parameters
-
+
Response = unknown

Parameters

-
pool: IPool<Worker, Data, Response>
+
pool: IPool<Worker, Data, Response>

The pool instance.
-

-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
+
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

The worker choice strategy.
-

-
opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+
opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

The worker choice strategy options.
-

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Properties

`Private` `Readonly` workerChoiceStrategies

workerChoiceStrategies: Map<"ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>

`Private` retriesCount

retriesCount: number = 0

The number of times the worker choice strategy in the context has been retried.

`Private` `Readonly` workerChoiceStrategies

`Private` workerChoiceStrategy

The worker choice strategy.

Methods

execute

execute(): number

execute

execute(): number
-
Executes the worker choice strategy algorithm in the context.
- -
Returns
The key of the worker node.
+
Executes the worker choice strategy in the context algorithm.

-
Returns number
+
Returns number
The key of the worker node.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If after configured retries the worker node key is null or undefined .
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:122

getRequiredStatistics

getRequiredStatistics(): RequiredStatistics
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:173

getStrategyPolicy

getStrategyPolicy(): StrategyPolicy
-
Gets the worker choice strategy in the context required statistics.
- -
Returns
The required statistics.
+
Gets the strategy policy in the context.

-
Returns RequiredStatistics
+
Returns StrategyPolicy
The strategy policy.
+ +
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:95

remove

remove(workerNodeKey: number): boolean
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:119

getTaskStatisticsRequirements

getTaskStatisticsRequirements(): TaskStatisticsRequirements
-
Removes a worker node key from the worker choice strategy in the context.
+
Gets the worker choice strategy in the context task statistics requirements.
+
+
Returns TaskStatisticsRequirements
The task statistics requirements.
-
Returns
true if the removal is successful, false otherwise.
+
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:132

remove

remove(workerNodeKey): boolean
+
Removes the worker node key from the worker choice strategy in the context.
Parameters
- -
  workerNodeKey: number
  -
  The key of the worker node.
  -
-
Returns boolean
+
workerNodeKey: number
+
The worker node key.
+
+

Returns boolean

true if the removal is successful, false otherwise.

+ +

setOptions

setOptions(opts: WorkerChoiceStrategyOptions): void
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:200

setOptions

setOptions(opts): void
Sets the worker choice strategies in the context options.

@@ -167,16 +211,18 @@
Parameters
- -
  opts: WorkerChoiceStrategyOptions
  +
  opts: WorkerChoiceStrategyOptions
  
  The worker choice strategy options.
  -
-
Returns void
+ +

Returns void

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy): void
Sets the worker choice strategy to use in the context.

@@ -184,83 +230,87 @@
Parameters
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
  +
  workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
  
  The worker choice strategy to set.
  -
-
Returns void
+ +

Returns void

update

update(workerNodeKey): boolean
+
Updates the worker node key in the worker choice strategy in the context internals.
+
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns boolean
true if the update is successful, false otherwise.
+ +
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:108

Class WorkerChoiceStrategyContext<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Worker extends IWorker

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Hierarchy

Index

Index

Constructors

Properties

Methods

Constructors

constructor

constructor

Type Parameters

Worker extends IWorker<Worker>

Worker extends IWorker

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Parameters

pool: IPool<Worker, Data, Response>

pool: IPool<Worker, Data, Response>

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Properties

Private Readonly workerChoiceStrategies

Private retriesCount

Private Readonly workerChoiceStrategies

Private workerChoiceStrategy

Methods

execute

execute

Returns

Returns number

getRequiredStatistics

getStrategyPolicy

Returns

Returns RequiredStatistics

remove

getTaskStatisticsRequirements

Returns TaskStatisticsRequirements

Returns

remove

Parameters

workerNodeKey: number

Returns boolean

Returns boolean

setOptions

setOptions

Parameters

opts: WorkerChoiceStrategyOptions

opts: WorkerChoiceStrategyOptions

Returns void

Returns void

setWorkerChoiceStrategy

setWorkerChoiceStrategy

Parameters

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

Returns void

Returns void

update

Parameters

workerNodeKey: number

Returns boolean

Settings

Settings

Member Visibility

Theme

Theme

On This Page

On This Page

`Private` `Readonly` workerChoiceStrategies

`Private` retriesCount

`Private` `Readonly` workerChoiceStrategies

`Private` workerChoiceStrategy