X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=d477079af0fbbc2e47f74074274a4b18ef88c956;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=33de0dadc191fdf3ac56f46afbe5b20cb5b72e43;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 33de0dad..d123e6bf 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -
Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -54,12 +54,15 @@
Properties
-Methods
Type Parameters
Worker extends IWorker<Worker>
Worker extends IWorker
Data = unknown
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
+ Retries Count
+Private
choiceThe number of times the worker choice strategy in the context has been retried.
+
+Private
optsThe worker choice strategy options.
+Private
Readonly
workerPrivate
workerMethods
Executes the worker choice strategy algorithm in the context.
+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 the worker node key is null or undefined.
+Throws
https://nodejs.org/api/errors.html#class-error If after configured retries the worker node key is null or undefined .
get Strategy Policy
++- get
Strategy Policy(): StrategyPolicy
+-
+
+
Gets the strategy policy in the context.
+Returns StrategyPolicy
The strategy policy.
+ +get Task Statistics Requirements
Gets the worker choice strategy task statistics requirements in the context.
+Gets the worker choice strategy in the context task statistics requirements.
Returns TaskStatisticsRequirements
The task statistics requirements.
+remove
@@ -161,14 +192,14 @@-
workerNodeKey: number
-The key of the worker node.
+The worker node key.
Returns boolean
true
if the removal is successful,false
otherwise.set Options
@@ -187,7 +218,7 @@
Returns void
set Worker Choice Strategy
@@ -206,13 +237,13 @@
Returns void
update
Updates the worker node key in the worker choice strategy internals in the context.
+Updates the worker node key in the worker choice strategy in the context internals.
Parameters
@@ -223,7 +254,7 @@Generated using TypeDoc