X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=01f8b9967aa3b6dcd308800db8deda61254c2251;hb=b20bf19abbcc1fb78e71f843d6eb56ad8c4c630c;hp=a3cebdf6cfb17ea94ced4e2522f5be53b6445bbc;hpb=f8b3d84c1c95773a1e18d2c025d89d73c4f2ab15;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index a3cebdf6..01f8b996 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,8 +1,8 @@ -WorkerChoiceStrategyContext | poolifier - v3.1.11

Class WorkerChoiceStrategyContext<Worker, Data, Response>

The worker choice strategy context.

+WorkerChoiceStrategyContext | poolifier - v3.1.12

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 @@ -18,27 +18,27 @@

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.
Optional opts: InternalWorkerChoiceStrategyOptions
The worker choice strategy options.
-

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Properties

`Private` `Optional` opts

opts?: InternalWorkerChoiceStrategyOptions

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` `Optional` opts

opts?: InternalWorkerChoiceStrategyOptions

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

`Private` executeStrategy

executeStrategy(workerChoiceStrategy): number
Executes the given worker choice strategy.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:171

`Private` executeStrategy

executeStrategy(workerChoiceStrategy): number
Executes the given worker choice strategy.
Parameters
- workerChoiceStrategy: IWorkerChoiceStrategy
  The worker choice strategy.
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:188

getStrategyPolicy

getStrategyPolicy(): StrategyPolicy
Gets the strategy policy in the context.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:188

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

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

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

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

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

setOptions

setOptions(pool, opts?): void
Sets the worker choice strategies in the context options.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:216

setOptions

setOptions(pool, opts?): void
Sets the worker choice strategies in the context options.
Parameters
- pool: IPool<Worker, Data, Response>
  The pool instance.
- Optional opts: InternalWorkerChoiceStrategyOptions
  The worker choice strategy options.
  -
Returns void
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:230

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

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

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file