X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategiesContext.html;h=606cb15d35b6cedfff9b19c4395be6eb4176324a;hb=c8576e5fe740384f6f61316b7f09a788a14ab0ef;hp=7ee0fe4f2a95231fc4a1e8468824f759cfc42338;hpb=840d17551c284ee8639e18de5c359be5118290bd;p=poolifier.git
diff --git a/docs/classes/WorkerChoiceStrategiesContext.html b/docs/classes/WorkerChoiceStrategiesContext.html
index 7ee0fe4f..606cb15d 100644
--- a/docs/classes/WorkerChoiceStrategiesContext.html
+++ b/docs/classes/WorkerChoiceStrategiesContext.html
@@ -1,8 +1,8 @@
-WorkerChoiceStrategiesContext | poolifier - v4.0.0Class WorkerChoiceStrategiesContext<Worker, Data, Response>
The worker choice strategies context.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.1Class WorkerChoiceStrategiesContext<Worker, Data, Response>
The worker choice strategies 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
Optionalopts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Returns WorkerChoiceStrategiesContext<Worker, Data, Response>
Default Value
-Properties
PrivatedefaultThe default worker choice strategy in the context.
-PrivateReadonlypoolThe pool instance.
-PrivateReadonlyretriesThe maximum number of worker choice strategies execution retries.
-retries
The number of worker choice strategies execution retries.
-PrivateReadonlyworkerThe worker choice strategies registered in the context.
-PrivateworkerThe active worker choice strategies in the context policy.
-PrivateworkerThe active worker choice strategies in the context task statistics requirements.
-Methods
PrivateaddAdds a worker choice strategy to the context.
+Properties
PrivatedefaultThe default worker choice strategy in the context.
+PrivateReadonlypoolThe pool instance.
+PrivateReadonlyretriesThe maximum number of worker choice strategies execution retries.
+retries
The number of worker choice strategies execution retries.
+PrivateReadonlyworkerThe worker choice strategies registered in the context.
+PrivateworkerThe active worker choice strategies in the context policy.
+PrivateworkerThe active worker choice strategies in the context task statistics requirements.
+Methods
PrivateaddAdds a worker choice strategy to the context.
Parameters
The worker choice strategy to add.
Optionalopts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Returns Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
The worker choice strategies.
-execute
Executes the given worker choice strategy in the context algorithm.
+execute
Executes the given worker choice strategy in the context algorithm.
Parameters
The worker choice strategy algorithm to execute.
Returns number
The key of the worker node.
Default Value
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 active worker choice strategies in the context policy.
+get
Gets the active worker choice strategies in the context policy.
Returns StrategyPolicy
The strategies policy.
-get
Gets the active worker choice strategies in the context task statistics requirements.
+get
Gets the active worker choice strategies in the context task statistics requirements.
Returns TaskStatisticsRequirements
The strategies task statistics requirements.
-remove
Removes the worker node key from the active worker choice strategies in the context.
+remove
Removes the worker node key from the active worker choice strategies in the context.
Parameters
The worker node key.
Returns boolean
-trueif the removal is successful,falseotherwise.PrivateremoveRemoves a worker choice strategy from the context.
+PrivateremoveRemoves a worker choice strategy from the context.
Parameters
The worker choice strategy to remove.
Returns boolean
-trueif the worker choice strategy is removed,falseotherwise.set
Sets the default worker choice strategy to use in the context.
+set
Sets the default worker choice strategy to use in the context.
Parameters
The default worker choice strategy to set.
Optionalopts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Returns void
set
Sets the active worker choice strategies in the context options.
+Returns void
set
Sets the active worker choice strategies in the context options.
Parameters
The worker choice strategy options.
-Returns void
sync
Synchronizes the active worker choice strategies in the context with the given worker choice strategies.
+Returns void
sync
Synchronizes the active worker choice strategies in the context with the given worker choice strategies.
Parameters
The worker choice strategies to synchronize.
Optionalopts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Returns void
update
Updates the worker node key in the active worker choice strategies in the context internals.
+Returns void
update
Updates the worker node key in the active worker choice strategies in the context internals.
Parameters
Returns boolean
-trueif the update is successful,falseotherwise.Settings
Member Visibility
Theme
On This Page
Settings
Member Visibility
Theme
On This Page