X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=868c18d4736042ef56009ec5e541c274b07fee89;hb=936fa0fb8e70b2c297938cc9455444486b6daa3e;hp=a2f488c7cf72cdc36302582b02d8db54ed7963fa;hpb=6be0ab6d5c78c8e91cc4668d3d03db95f15cbfab;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index a2f488c7..868c18d4 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
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,7 +54,9 @@
Properties
-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.
@@ -137,31 +155,31 @@Throws
https://nodejs.org/api/errors.html#class-error If the worker node key is null or undefined.
get Strategy Policy
-- get
Strategy Policy(): StrategyPolicy
+- get
Strategy Policy(): StrategyPolicy
-
-
Gets the strategy policy in the context.
Returns StrategyPolicy
The strategy policy.
+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
@@ -174,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
@@ -200,7 +218,7 @@
Returns void
set Worker Choice Strategy
@@ -219,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
@@ -236,7 +254,7 @@