X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=7987b6dbf5c929565c83fde3b7804c03ee46bf4a;hb=c4424e52e4924efa5eef704cb5dcb82f2760e0da;hp=33de0dadc191fdf3ac56f46afbe5b20cb5b72e43;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 33de0dad..7987b6db 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.
@@ -60,6 +60,7 @@
execute
+get Strategy Policy
get Task Statistics Requirements
remove
set Options
@@ -79,7 +80,7 @@
-
-
+-
-
@@ -105,14 +106,14 @@
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:44
Choice Strategies
worker Choice Strategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:32
Choice Strategy
worker Choice Strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
@@ -120,7 +121,7 @@
Methods
Type Parameters
Worker extends IWorker<Worker>
Worker extends IWorker
Data = unknown
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Properties
Private
Readonly
workerPrivate
workerMethods
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
+-
+
+
Gets the strategy policy in the context.
+Returns StrategyPolicy
The strategy policy.
+ +get Task Statistics Requirements
@@ -148,7 +161,7 @@
remove
@@ -161,14 +174,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 +200,7 @@
Returns void
set Worker Choice Strategy
@@ -206,7 +219,7 @@
Returns void
update
@@ -223,7 +236,7 @@