X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=65a8aed6d4dc29fd4356529a8a65d87755f62c5e;hb=619f403be01e2954cef4c490f76240b192f16276;hp=4650bea9dff440b981461fd35cdc323a0820812e;hpb=a2742ce794032ee57b3ec1203c500b1aecca34f0;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 4650bea9..65a8aed6 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategyContext | poolifier

+WorkerChoiceStrategyContext | poolifier - v2.6.37

@@ -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,31 @@

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 +82,7 @@
Type Parameters
- -
  Worker extends IWorker<Worker>
- Data = unknown
- @@ -88,60 +95,92 @@
  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:42

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

Properties

`Private` opts

opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

The worker choice strategy options.

`Private` retriesCount

retriesCount: number = 0

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

`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:51

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.
+
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 configured retries the worker node key is null or undefined .
+
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:173

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

getRequiredStatistics

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

getTaskStatisticsRequirements

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

-
Returns RequiredStatistics
The required statistics.
-
+
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:132

remove

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

@@ -150,16 +189,17 @@
- 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:163

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

setOptions

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

@@ -170,13 +210,14 @@
opts: WorkerChoiceStrategyOptions

The worker choice strategy options.

Returns void

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

setWorkerChoiceStrategy

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

@@ -184,18 +225,19 @@
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:117

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

update

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

Parameters
@@ -203,14 +245,15 @@
workerNodeKey: number