WorkerChoiceStrategyContext

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

+WorkerChoiceStrategyContext | poolifier - v2.6.32

@@ -29,12 +29,12 @@

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.

@@ -42,7 +42,7 @@

WorkerChoiceStrategyContext

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

@@ -54,13 +54,16 @@

Properties

workerChoiceStrategies +

choiceRetriesCount +opts +workerChoiceStrategies workerChoiceStrategy

Methods

execute -getRequiredStatistics +getStrategyPolicy +getTaskStatisticsRequirements remove setOptions setWorkerChoiceStrategy @@ -79,7 +82,7 @@

Type Parameters

-
Worker extends IWorker<Worker>

Worker extends IWorker

Data = unknown
@@ -93,7 +96,7 @@

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.

@@ -105,22 +108,38 @@

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

Properties

`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

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

@@ -128,27 +147,39 @@

execute(): number
-
Executes the worker choice strategy algorithm in the context.
+
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 the worker node key is null or undefined.
+
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:145

getRequiredStatistics

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

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

setOptions

Returns void

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

setWorkerChoiceStrategy

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

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

update

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
@@ -223,7 +254,7 @@
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:131

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file