X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=e7bd81a84f702e6cede290474fb6f0525fd9dfb4;hb=refs%2Ftags%2Fv3.1.22;hp=4759457ab8b3b068b9a3dcce9055009b55fdb35d;hpb=86de0a2d983a71579980758f52cf4c7f1c16abf8;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 4759457a..e7bd81a8 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,8 +1,8 @@ -
The worker choice strategy context.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.21Class 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.
Optional
opts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
Private
Readonly
retriesThe maximum number of worker choice strategy execution retries.
-retries Count
The number of worker choice strategy execution retries.
-Private
Readonly
workerThe worker choice strategy instances registered in the context.
-Private
workerThe worker choice strategy.
-Methods
execute
Executes the worker choice strategy in the context algorithm.
+Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
Private
Readonly
retriesThe maximum number of worker choice strategy execution retries.
+retries Count
The number of worker choice strategy execution retries.
+Private
Readonly
workerThe worker choice strategy instances registered in the context.
+Private
workerThe 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.
-Private
executeExecutes the given worker choice strategy.
+Private
executeExecutes 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 Strategy Policy
Gets the strategy policy in the context.
+get Strategy Policy
Gets the strategy policy in the context.
Returns StrategyPolicy
The strategy policy.
-get Task Statistics Requirements
Gets the worker choice strategy in the context task statistics requirements.
+get Task Statistics Requirements
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
-true
if the removal is successful,false
otherwise.set Options
Sets the worker choice strategies in the context options.
+set Options
Sets the worker choice strategies in the context options.
Parameters
The worker choice strategy options.
-Returns void
set Worker Choice Strategy
Sets the worker choice strategy to use in the context.
+Returns void
set Worker Choice Strategy
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
-true
if the update is successful,false
otherwise.Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc