WorkerChoiceStrategyContext

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=a30e48d1994654898787dd531b2e39f64fb079b4;hb=3dd69d8ee8aa2132fccb106720a9f5ae67b92cc8;hp=1095938f0cf16fff7267d0de9dfca4690b4b296c;hpb=6c525543a7ed67a926b7c1f4bf98985aaad1f088;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 1095938f..a30e48d1 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategyContext | poolifier

+WorkerChoiceStrategyContext | poolifier

@@ -18,27 +18,27 @@

The worker choice strategy context.

Type Parameters

-
Worker extends IWorker
+
Worker extends IWorker

Type of worker.
-
Data = unknown
+
Data = unknown

Type of data sent to the worker. This can only be serializable data.
-
Response = unknown
-
Type of response of execution. This can only be serializable data.
+
Response = unknown
+
Type of execution response. This can only be serializable data.

Hierarchy

WorkerChoiceStrategyContext

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:24

@@ -46,119 +46,134 @@

Constructors

constructor

new WorkerChoiceStrategyContext<Worker, Data, Response>(pool: IPool<Worker, Data, Response>, workerChoiceStrategyType?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", opts?: WorkerChoiceStrategyOptions): WorkerChoiceStrategyContext<Worker, Data, Response>

new WorkerChoiceStrategyContext<Worker, Data, Response>(pool, workerChoiceStrategy?, opts?): WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context constructor.

-
+
Type Parameters
-
+
Response = unknown

Parameters

-
pool: IPool<Worker, Data, Response>
+
pool: IPool<Worker, Data, Response>

The pool instance.
-
workerChoiceStrategyType: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
+
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

The worker choice strategy.
-
opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+
opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

The worker choice strategy options.

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:41

Properties

`Private` `Readonly` workerChoiceStrategies

workerChoiceStrategies: Map<"ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>

`Private` workerChoiceStrategyType

workerChoiceStrategyType: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:29

`Private` workerChoiceStrategy

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

The worker choice strategy.

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:43

Methods

execute

execute(): number

execute(): number
Executes the worker choice strategy algorithm in the context.
- -
Returns
The key of the worker node.

-
Returns number
+
Returns number
The key of the worker node.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:109

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:122

getRequiredStatistics

getRequiredStatistics(): RequiredStatistics

getRequiredStatistics(): RequiredStatistics
Gets the worker choice strategy in the context required statistics.
- -
Returns
The required statistics.

-
Returns RequiredStatistics
+
Returns RequiredStatistics
The required statistics.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:82

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:95

remove

remove(workerNodeKey: number): boolean

remove(workerNodeKey): boolean
Removes a worker node key from the worker choice strategy in the context.
- -
Returns
true if the removal is successful, false otherwise.
Parameters
- -
  workerNodeKey: number
  +
  workerNodeKey: number
  
  The key of the worker node.
-
Returns boolean
+
Returns boolean
true if the removal is successful, false otherwise.
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:123

Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:136

setOptions

setOptions(opts): void
+
Sets the worker choice strategies in the context options.
+
+
+
Parameters
+
- +
  opts: WorkerChoiceStrategyOptions
  +
  The worker choice strategy options.
  +
+
Returns void
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:149

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void

setWorkerChoiceStrategy(workerChoiceStrategy): void
Sets the worker choice strategy to use in the context.

@@ -166,12 +181,12 @@
Parameters
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
  +
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
  
  The worker choice strategy to set.