X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=d477079af0fbbc2e47f74074274a4b18ef88c956;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=5e519cb2fc7d6e2b3e3eda98ca3aa896f7492172;hpb=23d03397abcbf7274ba08acf89728bcaf32f0f6f;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 5e519cb2..d123e6bf 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategyContext | poolifier

+WorkerChoiceStrategyContext | poolifier - v2.6.32

@@ -17,28 +17,32 @@

Class WorkerChoiceStrategyContext<Worker, Data, Response>

The worker choice strategy context.

Type Parameters

-
Worker extends IWorker
+
Worker extends IWorker

Type of worker.
-

-
Data = unknown
-
Type of data sent to the worker. This can only be serializable data.
-

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 serializable data.
-

Response = unknown

Type of execution response. This can only be structured-cloneable data.

Hierarchy

WorkerChoiceStrategyContext

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27

@@ -46,119 +50,179 @@

Constructors

constructor

new WorkerChoiceStrategyContext<Worker, Data, Response>(pool: IPool<Worker, Data, Response>, workerChoiceStrategyType?: "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.
-

-
workerChoiceStrategyType: "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>

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:49

Properties

`Private` `Readonly` workerChoiceStrategies

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

`Private` choiceRetriesCount

choiceRetriesCount: number = 0

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

`Private` opts

opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

The worker choice strategy options.

`Private` `Readonly` workerChoiceStrategies

`Private` workerChoiceStrategyType

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

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:32

`Private` workerChoiceStrategy

The worker choice strategy.

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:51

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

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.
+
Gets the strategy policy in the context.
+
+
Returns StrategyPolicy
The strategy policy.
-
Returns
The required statistics.
+
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:119

getTaskStatisticsRequirements

getTaskStatisticsRequirements(): TaskStatisticsRequirements
+
Gets the worker choice strategy in the context task statistics requirements.

-
Returns RequiredStatistics
+
Returns TaskStatisticsRequirements
The task statistics requirements.
+ +
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:82

remove

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

remove

remove(workerNodeKey): boolean
-
Removes a worker node key from the worker choice strategy in the context.
+
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.
-
Returns
true if the removal is successful, false otherwise.
+
+
- 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.
Parameters
- -
  workerNodeKey: number
  -
  The key of the worker node.
  -
-
Returns boolean
+
opts: WorkerChoiceStrategyOptions
+
The worker choice strategy options.
+
+

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.

@@ -166,17 +230,36 @@
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:95