X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=a110781d33232d37523deb6f7ca6e384f5410956;hb=b6fea09e6a8174e664770741943cf08445066e2b;hp=024a515b6ad148b9a95cbe878e4f8594b559d42f;hpb=aac8863d208eadcb0ecb33dc44d045c26f5a444f;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 024a515b..a110781d 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
++- 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,20 +254,20 @@-
+Settings
Settings
Member Visibility
Theme
@@ -244,75 +275,42 @@
- constructor
+- opts
+- retries
Count
- worker
Choice Strategies
- worker
Choice Strategy
- execute
+- get
Strategy Policy
- get
Task Statistics Requirements
- remove
- set
Options
- set
Worker Choice Strategy
- update
Generated using TypeDoc
Generated using TypeDoc