X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=afb6caacd379784598b9d676ff43397e0f194511;hb=4618ccfd23b0b3ff358907db960728eb708106c6;hp=ce2b6b9b8c9b8f4f70496a078881bcb11324436c;hpb=1f9e78bf296d318acc29016077d9aa29f305a04f;p=poolifier.git
diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html
index ce2b6b9b..afb6caac 100644
--- a/docs/classes/WorkerChoiceStrategyContext.html
+++ b/docs/classes/WorkerChoiceStrategyContext.html
@@ -1,12 +1,13 @@
-WorkerChoiceStrategyContext | poolifier - v3.1.5Class WorkerChoiceStrategyContext<Worker, Data, Response>
The worker choice strategy context.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.9Class 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
Properties
Index
Constructors
Properties
Methods
Constructors
constructor
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>
Properties
PrivateoptsThe worker choice strategy options.
-PrivateReadonlyworkerPrivateworkerThe worker choice strategy.
-Methods
execute
Executes the worker choice strategy in the context algorithm.
+Optionalopts: InternalWorkerChoiceStrategyOptionsThe worker choice strategy options.
+Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
PrivateOptionaloptsThe worker choice strategy options.
+PrivateReadonlyworkerPrivateworkerThe worker choice strategy.
+Methods
execute
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.
-get
Gets the strategy policy in the context.
+PrivateexecuteExecutes 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.
+get
Gets the strategy policy in the context.
Returns StrategyPolicy
The strategy policy.
-get
Gets the worker choice strategy in the context task statistics requirements.
+get
Gets the worker choice strategy in the context task statistics requirements.
Returns TaskStatisticsRequirements
The task statistics requirements.
-remove
Removes the worker node key from the worker choice strategy in the context.
+remove
Removes the worker node key from the worker choice strategy in the context.
Parameters
workerNodeKey: number
The worker node key.
Returns boolean
-trueif the removal is successful,falseotherwise.set
Sets the worker choice strategies in the context options.
-Parameters
opts: WorkerChoiceStrategyOptions
The worker choice strategy options.
-Returns void
set
Sets the worker choice strategy to use in the context.
+set
Sets the worker choice strategies in the context options.
+Parameters
pool: IPool<Worker, Data, Response>
The pool instance.
+Optionalopts: InternalWorkerChoiceStrategyOptionsThe worker choice strategy options.
+Returns void
set
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
update
Updates the worker node key in the worker choice strategy in the context internals.
+Returns void
update
Updates the worker node key in the worker choice strategy in the context internals.
Parameters
workerNodeKey: number
Returns boolean
-trueif the update is successful,falseotherwise.Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc