X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=eefcff60d5037d53bd528155a9e5849e27f7f833;hb=a941ca40d6503650aa3bb05f1d4f5946e041f16b;hp=63127cba3e8a33b4975d19db2b41eb448db0a995;hpb=f9fc489a415da7131735b04b0af50b1143dbdf70;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 63127cba..eefcff60 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,10 +1,9 @@ -WorkerChoiceStrategyContext | poolifier - v3.0.5

Class WorkerChoiceStrategyContext<Worker, Data, Response>

The worker choice strategy context.

+WorkerChoiceStrategyContext | poolifier - v3.1.2

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 structured-cloneable data.
Response = unknown
Type of execution response. This can only be structured-cloneable data.
-

Hierarchy

WorkerChoiceStrategyContext

Index

Constructors

Index

Constructors

Properties

opts -retriesCount workerChoiceStrategies workerChoiceStrategy

Methods

execute @@ -14,27 +13,27 @@ setOptions setWorkerChoiceStrategy update -

Constructors

constructor

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

Constructors

constructor

new WorkerChoiceStrategyContext<Worker, Data, Response>(pool, workerChoiceStrategy?, opts?): WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context constructor.
Type Parameters
- Worker extends IWorker
- Data = unknown
- Response = unknown
Parameters
- pool: IPool<Worker, Data, Response>
  The pool instance.
- 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>
- 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

workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>

`Private` workerChoiceStrategy

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.

-

Methods

execute

execute(): number
Executes the worker choice strategy in the context algorithm.
+

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Properties

`Private` opts

opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

The worker choice strategy options.

+

`Private` `Readonly` workerChoiceStrategies

workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>

`Private` workerChoiceStrategy

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.

+

Methods

execute

execute(): number
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.
+
Throws
https://nodejs.org/api/errors.html#class-error If after configured retries the worker node key is null or undefined.
+
Throws
https://nodejs.org/api/errors.html#class-rangeerror If the maximum consecutive worker choice strategy executions has been reached.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:169

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

getTaskStatisticsRequirements(): TaskStatisticsRequirements
Gets the worker choice strategy in the context task statistics requirements.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:114

getTaskStatisticsRequirements

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

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

remove

remove(workerNodeKey): boolean
Removes the worker node key from the worker choice strategy in the context.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:127

remove

remove(workerNodeKey): boolean
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.
-
- 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.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:211

setOptions

setOptions(opts): void
Sets the worker choice strategies in the context options.
Parameters
- 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
Sets the worker choice strategy to use in the context.
+

Returns void

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy): void
Sets the worker choice strategy to use in the context.
Parameters
- 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 in the context internals.
+

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

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file