X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;fp=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=9ace6aaaca97dd0c619f40fbd454360a65ec57fb;hb=772b5f23dd379211a734346981ac26651c9d6802;hp=a63d694842220aa6d1bed5b35fbaae226a87a54b;hpb=48eab5902faccd2b14649e0fe4477778ec70ba96;p=poolifier.git
diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html
index a63d6948..9ace6aaa 100644
--- a/docs/classes/WorkerChoiceStrategyContext.html
+++ b/docs/classes/WorkerChoiceStrategyContext.html
@@ -1,8 +1,8 @@
-WorkerChoiceStrategyContext | poolifier - v3.1.29Class WorkerChoiceStrategyContext<Worker, Data, Response>
The worker choice strategy context.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.30Class WorkerChoiceStrategyContext<Worker, Data, Response>
The worker choice strategy context.
Type Parameters
Type of worker.
Type of data sent to the worker. This can only be structured-cloneable data.
Type of execution response. This can only be structured-cloneable data.
-Index
Constructors
Index
Constructors
Properties
Type Parameters
Parameters
The pool instance.
The worker choice strategy.
Optionalopts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
PrivateReadonlyretriesThe maximum number of worker choice strategy execution retries.
-retries
The number of worker choice strategy execution retries.
-PrivateReadonlyworkerThe worker choice strategy instances registered in the context.
-PrivateworkerThe worker choice strategy.
-Methods
execute
Executes the worker choice strategy in the context algorithm.
+Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
PrivateReadonlyretriesThe maximum number of worker choice strategy execution retries.
+retries
The number of worker choice strategy execution retries.
+PrivateReadonlyworkerThe worker choice strategy instances registered in the context.
+PrivateworkerThe 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 computed retries the worker node key is null or undefined.
-PrivateexecuteExecutes the given worker choice strategy.
+PrivateexecuteExecutes the given worker choice strategy.
Parameters
The worker choice strategy.
Returns number
The key of the worker node.
Throws
https://nodejs.org/api/errors.html#class-error If after computed retries the worker node key is null or undefined.
-get
Gets the strategy policy in the context.
+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
The worker node key.
Returns boolean
-trueif the removal is successful,falseotherwise.set
Sets the worker choice strategies in the context options.
+set
Sets the worker choice strategies in the context options.
Parameters
The worker choice strategy options.
-Returns void
set
Sets the worker choice strategy to use in the context.
+Returns void
set
Sets the worker choice strategy to use in the context.
Parameters
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
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