WorkerChoiceStrategyContext | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=0e08ef045f15988014d2dceb4837baf4623a864a;hb=fbc22127e53d3ec0ecbd38ecea25fb92ebef50e7;hp=3eafbc7ff5233e8eaba78070892edc5c90b2126f;hpb=842d8918a19fc2720d4436789a2e373bc623452e;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 3eafbc7f..0e08ef04 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategyContext | poolifier

+WorkerChoiceStrategyContext | poolifier

@@ -22,23 +22,23 @@

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,26 +46,27 @@

Constructors

-

Properties

-

workerChoiceStrategies -workerChoiceStrategyType +

workerChoiceStrategies +workerChoiceStrategy

Methods

-

execute -getRequiredStatistics -remove -setWorkerChoiceStrategy +

execute +getRequiredStatistics +remove +setOptions +setWorkerChoiceStrategy

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.

@@ -73,49 +74,49 @@
Type Parameters
- -
  Worker extends IWorker<Worker>
- -
  Data = unknown
- -
  Response = unknown

+

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.
@@ -123,23 +124,23 @@

Returns number
- 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
- 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.
@@ -149,16 +150,33 @@
Parameters
- -
  workerNodeKey: number
  +
  workerNodeKey: number
  
  The key of the worker node.
Returns boolean
- 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 +184,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.

Returns void

+

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

+

Theme

+

+

workerChoiceStrategies

+

workerChoiceStrategy

+

+

getRequiredStatistics

+

+

+

setWorkerChoiceStrategy

+

+

+

+

+

+

DynamicClusterPool

+

DynamicThreadPool

+

FixedClusterPool

+

FixedThreadPool

+

+

+

WorkerChoiceStrategyContext

+

ClusterPoolOptions

+

+

+

IWorkerChoiceStrategy

+

+

+

PromiseResponseWrapper

+

RequiredStatistics

+

+

TasksQueueOptions

+

+

WorkerChoiceStrategyOptions

+

+

+

+

+

+

+

+

+

+

ThreadWorkerWithMessageChannel

+

WorkerAsyncFunction

+

WorkerChoiceStrategy

+

+

WorkerSyncFunction

+

+

+

WorkerChoiceStrategies

Generated using TypeDoc

\ No newline at end of file