Class WorkerChoiceStrategiesContext<Worker, Data, Response>

The worker choice strategies context.

+WorkerChoiceStrategiesContext | poolifier - v4.0.15

Class WorkerChoiceStrategiesContext<Worker, Data, Response>

The worker choice strategies 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 +

Index

Constructors

constructor

Properties

defaultWorkerChoiceStrategy pool retries @@ -25,47 +25,49 @@

Type Parameters

Worker extends IWorker
Data = unknown
Response = unknown

Parameters

pool: IPool<Worker, Data, Response>
The pool instance.
workerChoiceStrategies: ("ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN")[] = ...
The worker choice strategies.
Optional opts: WorkerChoiceStrategyOptions
The worker choice strategy options.
-

Returns WorkerChoiceStrategiesContext<Worker, Data, Response>

Default Value

[WorkerChoiceStrategies.ROUND_ROBIN]
+

`Returns WorkerChoiceStrategiesContext<Worker, Data, Response>`

`Default Value`

[WorkerChoiceStrategies.ROUND_ROBIN]

`Properties`

Private defaultWorkerChoiceStrategy
defaultWorkerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The default worker choice strategy in the context.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:38

Private Readonly pool
pool: IPool<Worker, Data, Response>
The pool instance.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:71

Private Readonly retries
retries: number
The maximum number of worker choice strategies execution retries.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:61

retriesCount
retriesCount: number
The number of worker choice strategies execution retries.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:33

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 strategies registered in the context.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:43

Private workerChoiceStrategiesPolicy
workerChoiceStrategiesPolicy: StrategyPolicy
The active worker choice strategies in the context policy.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:51

Private workerChoiceStrategiesTaskStatisticsRequirements
workerChoiceStrategiesTaskStatisticsRequirements: TaskStatisticsRequirements
The active worker choice strategies in the context task statistics requirements.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:56

`Methods`

Private addWorkerChoiceStrategy
addWorkerChoiceStrategy(workerChoiceStrategy, pool, opts?): Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
Adds a worker choice strategy to the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:68

`Properties`

Private defaultWorkerChoiceStrategy
defaultWorkerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The default worker choice strategy in the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:37

Private Readonly pool
pool: IPool<Worker, Data, Response>
The pool instance.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:69

Private Readonly retries
retries: number
The maximum number of worker choice strategies execution retries.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:60

retriesCount
retriesCount: number
The number of worker choice strategies execution retries.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:32

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 strategies registered in the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:42

Private workerChoiceStrategiesPolicy
workerChoiceStrategiesPolicy: StrategyPolicy
The active worker choice strategies in the context policy.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:50

Private workerChoiceStrategiesTaskStatisticsRequirements
workerChoiceStrategiesTaskStatisticsRequirements: TaskStatisticsRequirements
The active worker choice strategies in the context task statistics requirements.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:55

`Methods`

Private addWorkerChoiceStrategy
addWorkerChoiceStrategy(workerChoiceStrategy, pool, opts?): Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
Adds a worker choice strategy to 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 add.
-
pool: IPool<Worker, Data, Response>
Optional opts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+
pool: IPool<Worker, Data, Response>The pool instance.
+
Optional opts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
 
Returns Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
The worker choice strategies.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:250

execute
execute(workerChoiceStrategy?): number
Executes the given worker choice strategy in the context algorithm.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:240

execute
execute(workerChoiceStrategy?): number
Executes the given worker choice strategy in the context algorithm.
 
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = ...The worker choice strategy algorithm to execute.
 
Returns number
The key of the worker node.
-Default Value
this.defaultWorkerChoiceStrategy
+Default Value
this.defaultWorkerChoiceStrategy
 
 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-strategies-context.ts:153

Private executeStrategy
executeStrategy(workerChoiceStrategy): number
Executes the given worker choice strategy.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:147

Private executeStrategy
executeStrategy(workerChoiceStrategy): number
Executes the given worker choice strategy.
 
Parameters
workerChoiceStrategy: IWorkerChoiceStrategyThe 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-strategies-context.ts:170

getPolicy
getPolicy(): StrategyPolicy
Gets the active worker choice strategies in the context policy.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:163

getPolicy
getPolicy(): StrategyPolicy
Gets the active worker choice strategies in the context policy.
 
Returns StrategyPolicy
The strategies policy.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:105

getTaskStatisticsRequirements
getTaskStatisticsRequirements(): TaskStatisticsRequirements
Gets the active worker choice strategies in the context task statistics requirements.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:102

getTaskStatisticsRequirements
getTaskStatisticsRequirements(): TaskStatisticsRequirements
Gets the active worker choice strategies in the context task statistics requirements.
 
Returns TaskStatisticsRequirements
The strategies task statistics requirements.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:114

remove
remove(workerNodeKey): boolean
Removes the worker node key from the active worker choice strategies in the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:110

remove
remove(workerNodeKey): boolean
Removes the worker node key from the active worker choice strategies in the context.
 
Parameters
workerNodeKey: numberThe worker node key.
 
Returns boolean
true if the removal is successful, false otherwise.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:196

Private removeWorkerChoiceStrategy
removeWorkerChoiceStrategy(workerChoiceStrategy): boolean
Removes a worker choice strategy from the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:188

Private removeWorkerChoiceStrategy
removeWorkerChoiceStrategy(workerChoiceStrategy): boolean
Removes a worker choice strategy from 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 remove.
 
Returns boolean
true if the worker choice strategy is removed, false otherwise.
-
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:275

setDefaultWorkerChoiceStrategy
setDefaultWorkerChoiceStrategy(workerChoiceStrategy, opts?): void
Sets the default worker choice strategy to use in the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:264

setDefaultWorkerChoiceStrategy
setDefaultWorkerChoiceStrategy(workerChoiceStrategy, opts?): void
Sets the default 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 default worker choice strategy to set.
 
Optional opts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-
Returns void
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:124

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

`Returns void`

setOptions
setOptions(opts): void
Sets the active worker choice strategies in the context options.
 
Parameters
opts: undefined | WorkerChoiceStrategyOptionsThe worker choice strategy options.
-
Returns void
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:208

syncWorkerChoiceStrategies
syncWorkerChoiceStrategies(workerChoiceStrategies, opts?): void
Synchronizes the active worker choice strategies in the context with the given worker choice strategies.
+

`Returns void`

syncWorkerChoiceStrategies
syncWorkerChoiceStrategies(workerChoiceStrategies, opts?): void
Synchronizes the active worker choice strategies in the context with the given worker choice strategies.
 
Parameters
workerChoiceStrategies: Set<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN">The worker choice strategies to synchronize.
 
Optional opts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-
Returns void
Defined in src/pools/selection-strategies/worker-choice-strategies-context.ts:220

update
update(workerNodeKey): boolean
Updates the worker node key in the active worker choice strategies 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-strategies-context.ts:139

Class WorkerChoiceStrategiesContext<Worker, Data, Response>

Class WorkerChoiceStrategiesContext<Worker, Data, Response>

Type Parameters

Index

Constructors

Index

Constructors

Properties

Type Parameters

Parameters

Returns WorkerChoiceStrategiesContext<Worker, Data, Response>

Default Value

Returns WorkerChoiceStrategiesContext<Worker, Data, Response>

Default Value

Properties

Private defaultWorkerChoiceStrategy

Private Readonly pool

Private Readonly retries

retriesCount

Private Readonly workerChoiceStrategies

Private workerChoiceStrategiesPolicy

Private workerChoiceStrategiesTaskStatisticsRequirements

Methods

Private addWorkerChoiceStrategy

Properties

Private defaultWorkerChoiceStrategy

Private Readonly pool

Private Readonly retries

retriesCount

Private Readonly workerChoiceStrategies

Private workerChoiceStrategiesPolicy

Private workerChoiceStrategiesTaskStatisticsRequirements

Methods

Private addWorkerChoiceStrategy

Parameters

Returns Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>

execute

execute

Parameters

Returns number

Default Value

Default Value

Throws

Private executeStrategy

Private executeStrategy

Parameters

Returns number

Throws

getPolicy

getPolicy

Returns StrategyPolicy

getTaskStatisticsRequirements

getTaskStatisticsRequirements

Returns TaskStatisticsRequirements

remove

remove

Parameters

Returns boolean

Private removeWorkerChoiceStrategy

Private removeWorkerChoiceStrategy

Parameters

Returns boolean

setDefaultWorkerChoiceStrategy

setDefaultWorkerChoiceStrategy

Parameters

Returns void

setOptions

Returns void

setOptions

Parameters

Returns void

syncWorkerChoiceStrategies

Returns void

syncWorkerChoiceStrategies

Parameters

Returns void

update

Parameters

Returns boolean

Settings

`Returns WorkerChoiceStrategiesContext<Worker, Data, Response>`

`Default Value`

`Properties`

`Private` defaultWorkerChoiceStrategy

`Private` `Readonly` pool

`Private` `Readonly` retries

`Private` `Readonly` workerChoiceStrategies

`Private` workerChoiceStrategiesPolicy

`Private` workerChoiceStrategiesTaskStatisticsRequirements

`Methods`

`Private` addWorkerChoiceStrategy

`Properties`

`Private` defaultWorkerChoiceStrategy

`Private` `Readonly` pool

`Private` `Readonly` retries

`Private` `Readonly` workerChoiceStrategies

`Private` workerChoiceStrategiesPolicy

`Private` workerChoiceStrategiesTaskStatisticsRequirements

`Methods`

`Private` addWorkerChoiceStrategy

`Private` executeStrategy

`Private` executeStrategy

`Private` removeWorkerChoiceStrategy

`Private` removeWorkerChoiceStrategy

`Returns void`

`Returns void`

`Settings`

`Member Visibility`

`Theme`

`On This Page`