X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=5b5bc5b1cd770afbccf97d5b12ee3c4e186dee70;hb=f33c2d55c063a50c0025bf707fa4faf7a5e25f6e;hp=897083c575df4eaa0ccb7bea4dccae30a4200f1c;hpb=8d1797ad15cb2d87ac3c9904ce6df3db45c0c742;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 897083c5..5b5bc5b1 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategyContext | poolifier

+WorkerChoiceStrategyContext | poolifier - v2.6.12

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

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

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

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,35 +50,37 @@

Constructors

constructor

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

-
+
Type Parameters
-
+
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:41

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

Properties

`Private` `Readonly` workerChoiceStrategies

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

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

`Private` workerChoiceStrategy

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

`Private` workerChoiceStrategy

The worker choice strategy.

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

Methods

execute

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

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

getRequiredStatistics

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

getStrategyPolicy

getRequiredStatistics(): RequiredStatistics
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:113

getTaskStatisticsRequirements

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

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

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

remove

remove(workerNodeKey): boolean
remove(workerNodeKey): boolean
-
Removes a worker node key from the worker choice strategy in the context.
- -
Returns
true if the removal is successful, false otherwise.
+
Removes the worker node key from the worker choice strategy in the context.

Parameters
@@ -152,14 +175,17 @@
workerNodeKey: number

The key of the worker node.
-

Returns boolean

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

setOptions

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

@@ -169,14 +195,16 @@
opts: WorkerChoiceStrategyOptions

The worker choice strategy options.
-

Returns void

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

setWorkerChoiceStrategy

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

@@ -184,17 +212,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 internals in the context.
+
+
+
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