X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=93f3b9e9efb7597ec8f5a6112d41d15f9d8a7e01;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=dd18bd88be3685c383bdec76c440675bd64db31a;hpb=f8350486e75b15ed17249cda3d0a55ee807a6a9f;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index dd18bd88..93f3b9e9 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategyContext | poolifier

+WorkerChoiceStrategyContext | poolifier - v2.6.26

@@ -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,28 +50,29 @@

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.

@@ -75,7 +80,7 @@
Type Parameters
- -
  Worker extends IWorker<Worker>
- Data = unknown
- @@ -86,62 +91,81 @@
- pool: IPool<Worker, Data, Response>
  
  The pool instance.
  -
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_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
  
  The worker choice strategy options.
  -
-
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
+ +

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

Properties

`Private` `Readonly` workerChoiceStrategies

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

`Private` workerChoiceStrategy

`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.
- -
Throws
https://nodejs.org/api/errors.html#class-error If the worker node key is null or undefined.

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

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 RequiredStatistics
The required statistics.
-
+
Returns StrategyPolicy
The strategy policy.
+ +
+
- 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 TaskStatisticsRequirements
The task statistics requirements.
+ +
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:104

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

remove

remove(workerNodeKey): boolean
remove(workerNodeKey): boolean
Removes the worker node key from the worker choice strategy in the context.

@@ -150,16 +174,18 @@
- workerNodeKey: number
  -
  The key of the worker node.
  -
+
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: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,16 +212,18 @@
Parameters
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_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

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

update

update(workerNodeKey): boolean
update(workerNodeKey): boolean
Updates the worker node key in the worker choice strategy internals in the context.

@@ -203,14 +233,15 @@
workerNodeKey: number