Class WorkerChoiceStrategyContext<Worker, Data, Response>

The worker choice strategy context.

Type Parameters

Worker extends IWorker
Type of worker.
-
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
-
Response = unknown
Type of execution response. This can only be structured-cloneable data.
-

Index

Constructors

constructor

new WorkerChoiceStrategyContext<Worker, Data, Response>(pool, workerChoiceStrategy?, opts?): WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context constructor.
-
Type Parameters
- Worker extends IWorker
- Data = unknown
- Response = unknown
Parameters
- pool: IPool<Worker, Data, Response>
  The pool instance.
  -
- 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.
  -
- Optional opts: WorkerChoiceStrategyOptions
  The worker choice strategy options.
  -
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:57

Properties

`Private` `Readonly` retries

retries: number

The maximum number of worker choice strategy execution retries.

retriesCount

retriesCount: number

The number of worker choice strategy execution retries.

`Private` `Readonly` workerChoiceStrategies

The worker choice strategy instances registered in the context.

`Private` workerChoiceStrategy

The worker choice strategy.

Methods

execute

execute(): number
Executes the worker choice strategy in the context algorithm.
+WorkerChoiceStrategyContext | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategyContext
Class WorkerChoiceStrategyContext<Worker, Data, Response>
The worker choice strategy context.
+
Type Parameters
Worker extends IWorker
Type of worker.
+
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknown
Type of execution response. This can only be structured-cloneable data.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
Index
Constructors
constructor +
Properties
retries +retriesCount +workerChoiceStrategies +workerChoiceStrategy +
Methods
execute +executeStrategy +getStrategyPolicy +getTaskStatisticsRequirements +remove +setOptions +setWorkerChoiceStrategy +update +
Constructors
constructor
new WorkerChoiceStrategyContext<Worker, Data, Response>(pool, workerChoiceStrategy?, opts?): WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context constructor.
+
Type Parameters
Worker extends IWorker
Data = unknown
Response = unknown
Parameters
pool: IPool<Worker, Data, Response>
The pool instance.
+
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.
+
Optional opts: WorkerChoiceStrategyOptions
The worker choice strategy options.
+
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:57
Properties
Private Readonly retries
retries: number
The maximum number of worker choice strategy execution retries.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:48
retriesCount
retriesCount: number
The number of worker choice strategy execution retries.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:35
Private Readonly workerChoiceStrategies
workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
The worker choice strategy instances registered in the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40
Private workerChoiceStrategy
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.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:59
Methods
execute
execute(): number
Executes the worker choice strategy in the context algorithm.

Returns number
The key of the worker node.

Throws
https://nodejs.org/api/errors.html#class-error If after computed retries the worker node key is null or undefined.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:177
Private executeStrategy
executeStrategy(workerChoiceStrategy): number
Executes the given worker choice strategy.
-
Parameters
workerChoiceStrategy: IWorkerChoiceStrategy
The worker choice strategy.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:177
Private executeStrategy
executeStrategy(workerChoiceStrategy): number
Executes the given worker choice strategy.
+
Parameters
workerChoiceStrategy: IWorkerChoiceStrategy
The worker choice strategy.

Returns number
The key of the worker node.

Throws
https://nodejs.org/api/errors.html#class-error If after computed retries the worker node key is null or undefined.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:191
getStrategyPolicy
getStrategyPolicy(): StrategyPolicy
Gets the strategy policy in the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:191
getStrategyPolicy
getStrategyPolicy(): StrategyPolicy
Gets the strategy policy in the context.

Returns StrategyPolicy
The strategy policy.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:128
getTaskStatisticsRequirements
getTaskStatisticsRequirements(): TaskStatisticsRequirements
Gets the worker choice strategy in the context task statistics requirements.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:128
getTaskStatisticsRequirements
getTaskStatisticsRequirements(): TaskStatisticsRequirements
Gets the worker choice strategy in the context task statistics requirements.

Returns TaskStatisticsRequirements
The task statistics requirements.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139
remove
remove(workerNodeKey): boolean
Removes the worker node key from the worker choice strategy in the context.
-
Parameters
workerNodeKey: number
The worker node key.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139
remove
remove(workerNodeKey): boolean
Removes the worker node key from the worker choice strategy in the context.
+
Parameters
workerNodeKey: number
The worker node key.

Returns boolean
true if the removal is successful, false otherwise.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:217
setOptions
setOptions(opts): void
Sets the worker choice strategies in the context options.
-
Parameters
opts: undefined | WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:229
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy): void
Sets the worker choice strategy to use in the context.
-
Parameters
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
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:150
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:164
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
retries
retriesCount
workerChoiceStrategies
workerChoiceStrategy
execute
executeStrategy
getStrategyPolicy
getTaskStatisticsRequirements
remove
setOptions
setWorkerChoiceStrategy
update
poolifier - v3.1.20
AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc
\ No newline at end of file +
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:217

setOptions

setOptions(opts): void
Sets the worker choice strategies in the context options.
+
Parameters
- opts: undefined | WorkerChoiceStrategyOptions
  The worker choice strategy options.
  +
Returns void
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:229

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy): void
Sets the worker choice strategy to use in the context.
+
Parameters
- 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
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:150

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:164

Class WorkerChoiceStrategyContext<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Parameters

pool: IPool<Worker, Data, Response>

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

Optional opts: WorkerChoiceStrategyOptions

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Properties

Private Readonly retries

retriesCount

Private Readonly workerChoiceStrategies

Private workerChoiceStrategy

Methods

execute

Class WorkerChoiceStrategyContext<Worker, Data, Response>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Properties

Private Readonly retries

retriesCount

Private Readonly workerChoiceStrategies

Private workerChoiceStrategy

Methods

execute

Returns number

Throws

Private executeStrategy

Parameters

workerChoiceStrategy: IWorkerChoiceStrategy

Private executeStrategy

Parameters

Returns number

Throws

getStrategyPolicy

getStrategyPolicy

Returns StrategyPolicy

getTaskStatisticsRequirements

getTaskStatisticsRequirements

Returns TaskStatisticsRequirements

remove

Parameters

workerNodeKey: number

remove

Parameters

Returns boolean

setOptions

Parameters

opts: undefined | WorkerChoiceStrategyOptions

Returns void

setWorkerChoiceStrategy

Parameters

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

Returns void

update

Parameters

workerNodeKey: number

Returns boolean

Settings

Member Visibility

`Optional` opts: WorkerChoiceStrategyOptions

`Private` `Readonly` retries

`Private` `Readonly` workerChoiceStrategies

`Private` workerChoiceStrategy

`Private` `Readonly` retries

`Private` `Readonly` workerChoiceStrategies

`Private` workerChoiceStrategy

`Private` executeStrategy

`Private` executeStrategy