X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FWorkerChoiceStrategiesContext.html;h=dc69a732b179e5a91f801da31b5641bb19076b15;hb=a467a7dfad422116e68dfb0578a49cf2e21d061e;hp=92f0fb5fe6b986d0d40fff572ebdd74b041f7e7c;hpb=6c2aa71d06cfeccb07a325f7d9bc5ecdbb42a11f;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategiesContext.html b/docs/classes/WorkerChoiceStrategiesContext.html index 92f0fb5f..dc69a732 100644 --- a/docs/classes/WorkerChoiceStrategiesContext.html +++ b/docs/classes/WorkerChoiceStrategiesContext.html @@ -1,8 +1,8 @@ -
The worker choice strategies context.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.14Class 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
Type Parameters
Parameters
The pool instance.
The worker choice strategies.
Optional
opts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Returns WorkerChoiceStrategiesContext<Worker, Data, Response>
Default Value
Returns WorkerChoiceStrategiesContext<Worker, Data, Response>
Default Value
-Properties
Private
defaultThe default worker choice strategy in the context.
-Private
Readonly
poolThe pool instance.
-Private
Readonly
retriesThe maximum number of worker choice strategies execution retries.
-retries Count
The number of worker choice strategies execution retries.
-Private
Readonly
workerThe worker choice strategies registered in the context.
-Private
workerThe active worker choice strategies in the context policy.
-Private
workerThe active worker choice strategies in the context task statistics requirements.
-Methods
Private
addAdds a worker choice strategy to the context.
+Properties
Private
defaultThe default worker choice strategy in the context.
+Private
Readonly
poolThe pool instance.
+Private
Readonly
retriesThe maximum number of worker choice strategies execution retries.
+retries Count
The number of worker choice strategies execution retries.
+Private
Readonly
workerThe worker choice strategies registered in the context.
+Private
workerThe active worker choice strategies in the context policy.
+Private
workerThe active worker choice strategies in the context task statistics requirements.
+Methods
Private
addAdds a worker choice strategy to the context.
Parameters
The worker choice strategy to add.
-Optional
opts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+The pool instance.
+Optional
opts: 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
Returns void
update
Updates the worker node key in the active worker choice strategies in the context internals.
+Parameters
The worker node key.
+Returns boolean
+true
if the update is successful,false
otherwise.Settings
Member Visibility
Theme
On This Page