WorkerChoiceStrategyContext

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=50a2627fb7b0941698c33f21be0038f16ed31de3;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=781c86edc229299c06c7b257b169ba69f6cd6426;hpb=2f4ae5a6c14efa15bafa4ab0e68f166ec80d719b;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 781c86ed..50a2627f 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategyContext | poolifier

+WorkerChoiceStrategyContext | poolifier

@@ -18,19 +18,19 @@

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
+
Response = unknown

Type of execution response. This can only be serializable data.

@@ -38,7 +38,7 @@

WorkerChoiceStrategyContext

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

@@ -46,120 +46,120 @@

Constructors

constructor

new WorkerChoiceStrategyContext<Worker, Data, Response>(pool: IPool<Worker, Data, Response>, workerChoiceStrategy?: "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.
-
workerChoiceStrategy: "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>

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.
+
Throws
https://nodejs.org/api/errors.html#class-error If the worker node key is null or undefined.

-
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:136

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.
+
Removes the worker node key from the worker choice strategy in the context.
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:154

setOptions

setOptions(opts: WorkerChoiceStrategyOptions): void

setOptions(opts): void
Sets the worker choice strategies in the context options.

@@ -167,16 +167,16 @@
Parameters
- -
  opts: WorkerChoiceStrategyOptions
  +
  opts: WorkerChoiceStrategyOptions
  
  The worker choice strategy options.

Returns void

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

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.

@@ -184,12 +184,28 @@
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.

Returns void

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

update

update(workerNodeKey): boolean
+
Updates the worker node key in the worker choice strategy internals in the context.
+
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns boolean
true if the update is successful, false otherwise.
+
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:122