DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=fbe208e3b9eb1556cccad61e8036cbffeaa632fc;hb=08e40091fb1d27284ffcdfaced81292139a02c55;hp=a177b6e58dcac2e7f6ecfd2ee02b7ec2c73d4c86;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index a177b6e5..fbe208e3 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier

+DynamicClusterPool | poolifier - v2.6.13

@@ -30,12 +30,12 @@ When the maximum number of workers is reached and workers are busy, an event is

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.

@@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is

DynamicClusterPool

Defined in src/pools/cluster/dynamic.ts:15

@@ -73,7 +73,10 @@ When the maximum number of workers is reached and workers are busy, an event is info maxSize minSize +ready +starting type +utilization worker

@@ -81,7 +84,8 @@ When the maximum number of workers is reached and workers are busy, an event is

afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook -chooseWorkerNode +checkDynamicPoolSize +createAndSetupDynamicWorker createAndSetupWorker createWorker destroy @@ -90,7 +94,6 @@ When the maximum number of workers is reached and workers are busy, an event is execute internalBusy isMain -registerWorkerMessageListener sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -141,7 +144,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/dynamic.ts:27

Properties

@@ -150,8 +153,9 @@ When the maximum number of workers is reached and workers are busy, an event is

Emitter on which events can be listened to.

Events that can currently be listened to:

'full': Emitted when the pool is dynamic and full.
'busy': Emitted when the pool is busy.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

@@ -159,7 +163,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:62

`Protected` `Readonly` filePath

filePath: string

@@ -168,7 +172,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:100

`Protected` `Readonly` max

max: number

@@ -176,7 +180,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/dynamic.ts:29

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -185,7 +189,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:99

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -194,7 +198,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/fixed.ts:47

`Protected` promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...

@@ -208,26 +212,25 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:72

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

Defined in src/pools/abstract-pool.ts:80

`Readonly` workerNodes

workerNodes: WorkerNode<Worker, Data>[] = []

workerNodes: IWorkerNode<Worker, Data>[] = []

Pool worker nodes.

Defined in src/pools/abstract-pool.ts:59

Accessors

@@ -242,7 +245,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/dynamic.ts:48

`Private` ready

get ready(): boolean
+
Returns boolean
+
Inherited from FixedClusterPool.ready
+
- Defined in src/pools/abstract-pool.ts:416

`Private` starting

get starting(): boolean
+
Returns boolean
+
Inherited from FixedClusterPool.starting
+
- Defined in src/pools/abstract-pool.ts:408

`Protected` type

Defined in src/pools/cluster/dynamic.ts:38

`Private` utilization

get utilization(): number
+
Gets the approximate pool utilization.
+
+
Returns number
The pool utilization.
+ +
+
Inherited from FixedClusterPool.utilization
+
- Defined in src/pools/abstract-pool.ts:428

`Protected` worker

Defined in src/pools/cluster/fixed.ts:87

Methods

@@ -336,7 +370,7 @@ Can be overridden.

message: MessageValue<Response, Worker | MessagePort>

message: MessageValue<Response, unknown>

The received message.

@@ -344,14 +378,14 @@ Can be overridden.

Defined in src/pools/abstract-pool.ts:692

`Protected` afterWorkerSetup

afterWorkerSetup(worker): void
-
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-
Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.
+
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
Parameters
@@ -365,11 +399,11 @@ Can be overridden.
Inherited from FixedClusterPool.afterWorkerSetup
- Defined in src/pools/cluster/fixed.ts:97

Defined in src/pools/abstract-pool.ts:927

`Protected` beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey): void
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution. Can be overridden.
@@ -381,26 +415,46 @@ Can be overridden.

workerNodeKey: number

The worker node key.

+
+
task: Task<Data>
+
The task to execute.
+

Returns void

`Protected` chooseWorkerNode

Defined in src/pools/abstract-pool.ts:671

`Protected` checkDynamicPoolSize

checkDynamicPoolSize(min, max): void
+
+
Parameters
+
- +
  min: number
- +
  max: number
+
Returns void
+
Inherited from FixedClusterPool.checkDynamicPoolSize
+
- Defined in src/pools/abstract-pool.ts:164

`Protected` createAndSetupDynamicWorker

chooseWorkerNode(): number
createAndSetupDynamicWorker(): Worker
-
Chooses a worker node for the next task.
-
The default worker choice strategy uses a round robin algorithm to distribute the load.
+
Creates a new dynamic worker and sets it up completely in the pool worker nodes.

-
Returns number
The worker node key
+
Returns Worker
New, completely set up dynamic worker.
-
Inherited from FixedClusterPool.chooseWorkerNode
+
Inherited from FixedClusterPool.createAndSetupDynamicWorker
- Defined in src/pools/abstract-pool.ts:532

Defined in src/pools/abstract-pool.ts:1010

`Protected` createAndSetupWorker

Defined in src/pools/abstract-pool.ts:944

`Protected` createWorker

createWorker(): Worker
-
Returns a newly created worker.
+
Creates a new worker.

-
Returns Worker
+
Returns Worker
Newly created worker.
+
Inherited from FixedClusterPool.createWorker
- Defined in src/pools/cluster/fixed.ts:92

Defined in src/pools/cluster/fixed.ts:77

destroy

destroy(): Promise<void>
-
Shutdowns every current worker in this pool.
+
Terminates every current worker in this pool.

Returns Promise<void>
Inherited from FixedClusterPool.destroy
- Defined in src/pools/abstract-pool.ts:415

Defined in src/pools/abstract-pool.ts:626

`Protected` destroyWorker

destroyWorker(worker): void
-
Shutdowns the given worker.
+
Terminates the given worker.
Parameters
@@ -457,7 +512,7 @@ Can be overridden.
Inherited from FixedClusterPool.destroyWorker
- Defined in src/pools/cluster/fixed.ts:73

Defined in src/pools/cluster/fixed.ts:63

enableTasksQueue

Defined in src/pools/abstract-pool.ts:531

execute

Optional data: Data
-
The task input data for the specified worker function. This can only be serializable data.
+
The task input data for the specified worker function. This can only be structured-cloneable data.
@@ -508,16 +563,20 @@ Can be overridden.
Inherited from FixedClusterPool.execute
- Defined in src/pools/abstract-pool.ts:380

Defined in src/pools/abstract-pool.ts:591

`Protected` internalBusy

internalBusy(): boolean
-
Returns boolean
+
Whether worker nodes are executing at least one task.
+
+
Returns boolean
Worker nodes busyness boolean status.
+ +
Inherited from FixedClusterPool.internalBusy
- Defined in src/pools/abstract-pool.ts:371

Defined in src/pools/abstract-pool.ts:582

`Protected` isMain

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker, listener): void
-
Registers a listener callback on the given worker.
-
-
-
Type Parameters
-
- -
  Message
-
-
Parameters
-
- -
  worker: Worker
  -
  The worker which should register a listener.
  -
  -
- -
  listener: ((message) => void)
  -
  The message listener callback.
  -
  -
  -
  - -
    - (message): void
    - -
      -
      Parameters
      -
      -
      -
      message: MessageValue<Message, Worker | MessagePort>
      -
      Returns void
-
Returns void
-
-
Inherited from FixedClusterPool.registerWorkerMessageListener
-
- Defined in src/pools/cluster/fixed.ts:84

Defined in src/pools/cluster/fixed.ts:58

`Protected` sendToWorker

-
message: MessageValue<Data, Worker | MessagePort>
+
message: MessageValue<Data, unknown>

The message.

@@ -595,7 +613,7 @@ Can be overridden.

Defined in src/pools/cluster/fixed.ts:72

setTasksQueueOptions

Defined in src/pools/abstract-pool.ts:543

setWorkerChoiceStrategy

Parameters

-
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_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.

Defined in src/pools/abstract-pool.ts:501

setWorkerChoiceStrategyOptions

Defined in src/pools/abstract-pool.ts:520

`Protected` setupHook

setupHook(): void
-
Setup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+
Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.

Returns void
Inherited from FixedClusterPool.setupHook
- Defined in src/pools/cluster/fixed.ts:63

Defined in src/pools/cluster/fixed.ts:53

`Protected` workerListener

Parameters

-
message: MessageValue<Response, Worker | MessagePort>

message: MessageValue<Response, unknown>

Returns void

The listener function to execute when a message is received from a worker.

Defined in src/pools/abstract-pool.ts:1041

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

Parameters

message: MessageValue<Message, Worker | MessagePort>

Returns void