X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=49cdb8401295adc980011a596805b25f9e4d8535;hb=410724041bab556be1385c56f9a32e5030f6f2cf;hp=daf43a7547f44d61e7310af4932b1ac50ffe645e;hpb=2c94c3a5da9d6b4a0ac992386907d8a406ee38f7;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index daf43a75..49cdb840 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,13 +1,13 @@ -WorkerChoiceStrategyContext | poolifier

@@ -17,57 +17,64 @@

Class WorkerChoiceStrategyContext<Worker, Data, Response>

The worker choice strategy context.

Type Parameters

Worker extends IWorker

Type of worker.
-

Data = unknown

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.

Hierarchy

WorkerChoiceStrategyContext

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

Index

Constructors

constructor

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

@@ -75,7 +82,7 @@
Type Parameters
- -
  Worker extends IWorker<Worker>
- Data = unknown
- @@ -86,60 +93,97 @@
- 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" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
  
  The worker choice strategy.
  -
- opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
  
  The worker choice strategy options.
  -
-
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
+ +

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

Properties

`Private` opts

opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

The worker choice strategy options.

`Private` retriesCount

retriesCount: number = 0

The number of times the worker choice strategy in the context has been retried.

`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:32

`Private` workerChoiceStrategy

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

`Private` workerChoiceStrategy

The worker choice strategy.

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

Methods

execute

execute(): number
execute(): number
-
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 after configured retries the worker node key is null or undefined .
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:135

getRequiredStatistics

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

getStrategyPolicy

getRequiredStatistics(): RequiredStatistics
getStrategyPolicy(): StrategyPolicy
-
Gets the worker choice strategy in the context required statistics.
+
Gets the strategy policy in the context.

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

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

getTaskStatisticsRequirements

getTaskStatisticsRequirements(): TaskStatisticsRequirements
+
Gets the worker choice strategy in the context task statistics requirements.
+
+
Returns TaskStatisticsRequirements
The task statistics requirements.
+ +
+
- Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:132

remove

remove(workerNodeKey): boolean
remove(workerNodeKey): boolean
Removes the worker node key from the worker choice strategy in the context.

@@ -148,16 +192,18 @@
- workerNodeKey: number
  -
  The key of the worker node.
  -
+
The worker node key.
+
+

Returns boolean

true if the removal is successful, false otherwise.

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

setOptions

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

@@ -167,14 +213,16 @@
opts: WorkerChoiceStrategyOptions

The worker choice strategy options.
-

Returns void

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

setWorkerChoiceStrategy

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

@@ -182,18 +230,20 @@
Parameters
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
  +
  workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
  
  The worker choice strategy to set.
  -
-
Returns void
+ +

Returns void

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

update

update(workerNodeKey): boolean
update(workerNodeKey): boolean
-
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
@@ -201,83 +251,66 @@
workerNodeKey: number

Returns boolean

true if the update is successful, false otherwise.

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

constructor

opts

retriesCount

workerChoiceStrategies

workerChoiceStrategy

execute

getStrategyPolicy

getTaskStatisticsRequirements

remove

setOptions

setWorkerChoiceStrategy

update

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file

Class WorkerChoiceStrategyContext<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Hierarchy

Index

Index

Constructors

Properties

Methods

Constructors

constructor

constructor

Type Parameters

Worker extends IWorker<Worker>

Worker extends IWorker

Data = unknown

pool: IPool<Worker, Data, Response>

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

workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Returns WorkerChoiceStrategyContext<Worker, Data, Response>

Properties

Private opts

Private retriesCount

Private Readonly workerChoiceStrategies

Private workerChoiceStrategy

Private workerChoiceStrategy

Methods

execute

execute

Returns number

getRequiredStatistics

getStrategyPolicy

Returns RequiredStatistics

getTaskStatisticsRequirements

Returns TaskStatisticsRequirements

remove

remove

workerNodeKey: number

Returns boolean

setOptions

setOptions

opts: WorkerChoiceStrategyOptions

Returns void

setWorkerChoiceStrategy

setWorkerChoiceStrategy

Parameters

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

Returns void

Returns void

update

update

Parameters

workerNodeKey: number

Returns boolean

Settings

Settings

Member Visibility

Theme

On This Page

On This Page

`Private` opts

`Private` retriesCount

`Private` `Readonly` workerChoiceStrategies

`Private` workerChoiceStrategy

`Private` workerChoiceStrategy