X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=d6e00853ab6f82c86004f579c2a0e03688bdea69;hb=717e9363ccc3cfdbd24bda1bd019d31274163b10;hp=30628a8414be031296f1ad731ad69329ddadde16;hpb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 30628a84..d6e00853 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,13 +1,13 @@ -
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.
-
+Index
Index
Constructors
-Properties
-Methods
-Constructors
constructor
+constructor
Type Parameters
Worker extends IWorker<Worker>
Worker extends IWorker
Data = unknown
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
+
+Private
optsThe worker choice strategy options.
+ Count
+Private
retriesThe number of times the worker choice strategy in the context has been retried.
+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
@@ -149,19 +167,19 @@
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,20 +254,20 @@-
+Settings
Settings
Member Visibility
Theme
@@ -257,6 +275,8 @@
- constructor
+- opts
+- retries
Count
- worker
Choice Strategies
- worker
Choice Strategy
- execute
@@ -267,67 +287,30 @@
- set
Worker Choice Strategy
- update
Generated using TypeDoc
Generated using TypeDoc