X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=622aa5781c886f0a72bbf6fc6cd1937e5be39209;hb=55d7d6002049be09a06b08da26febe2e8bfa494b;hp=c283cc999f975b4c5b5060dd522cd8a5cab6a3c2;hpb=52a04779d6d7fce6b3db10d1abf5e03b42ea9723;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index c283cc99..622aa578 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,8 +1,8 @@ -WorkerChoiceStrategyContext | poolifier - v3.1.1

Class WorkerChoiceStrategyContext<Worker, Data, Response>

The worker choice strategy context.

+WorkerChoiceStrategyContext | poolifier - v3.1.6

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

Index

Constructors

Index

Constructors

Properties

opts workerChoiceStrategies workerChoiceStrategy @@ -17,23 +17,23 @@

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>

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

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.
+
- 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:114

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

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

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

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

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

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file