X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=6d292fa00015221112186e84661452e817da9234;hb=896624ae5d3cb6861b202a4c3b1d4c42368868c5;hp=5614ab22591eb6543cc722253e0900d419f928f4;hpb=9ad272eaf0cded8c7e70f1fe6f075c99f23619fa;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 5614ab22..6d292fa0 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,8 +1,8 @@ -
Generated using TypeDoc
The worker choice strategy context.
+- Preparing search index...
- The search index is not available
poolifier - v3.0.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.
-Hierarchy
Index
Constructors
Index
Constructors
Properties
Constructors
constructor
Worker choice strategy context constructor.
+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
Private
optsThe worker choice strategy options.
-Private
retriesThe number of times the worker choice strategy in the context has been retried.
-Private
Readonly
workerPrivate
workerThe worker choice strategy.
-Methods
execute
Executes the worker choice strategy in the context algorithm.
+Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
Private
optsThe worker choice strategy options.
+Private
retriesThe number of times the worker choice strategy in the context has been retried.
+Private
Readonly
workerPrivate
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 configured 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
workerNodeKey: number
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
opts: WorkerChoiceStrategyOptions
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
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
-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