DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=0240eb0206dde171e5a201039290d00b63a824e3;hb=76b46937556ea55049d5c413aa0a77d0c7f47f48;hp=1a5100b2992fd8c0b35fe6c4e0e6e65280eabf96;hpb=aac8863d208eadcb0ecb33dc44d045c26f5a444f;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 1a5100b2..0240eb02 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier

+DynamicClusterPool | poolifier - v2.6.19

@@ -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,9 @@ When the maximum number of workers is reached and workers are busy, an event is info maxSize minSize +ready type +utilization worker

@@ -81,16 +83,20 @@ When the maximum number of workers is reached and workers are busy, an event is

afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook -chooseWorkerNode +checkDynamicPoolSize +createAndSetupDynamicWorker createAndSetupWorker createWorker destroy destroyWorker enableTasksQueue execute +getWorkerInfoByWorker +getWorkerNodeKey internalBusy isMain registerWorkerMessageListener +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -141,7 +147,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 +156,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 +166,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Protected` `Readonly` filePath

filePath: string

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

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

`Protected` `Readonly` max

max: number

@@ -176,7 +183,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 +192,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -194,7 +201,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,7 +215,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -217,16 +224,16 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Readonly` workerNodes

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

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

Pool worker nodes.

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

Accessors

@@ -241,7 +248,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:430

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

`Protected` worker

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

Methods

@@ -335,7 +364,7 @@ Can be overridden.

message: MessageValue<Response, unknown, Worker | MessagePort>

message: MessageValue<Response, unknown>

The received message.

@@ -343,14 +372,14 @@ Can be overridden.

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

`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
@@ -364,7 +393,7 @@ Can be overridden.
Inherited from FixedClusterPool.afterWorkerSetup
- Defined in src/pools/cluster/fixed.ts:94

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

`Protected` beforeTaskExecutionHook

`Protected` chooseWorkerNode

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

`Protected` checkDynamicPoolSize

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

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

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

`Protected` createAndSetupWorker

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

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

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

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

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

`Protected` destroyWorker

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

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

enableTasksQueue

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

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.
@@ -512,16 +557,64 @@ Can be overridden.
Inherited from FixedClusterPool.execute
- Defined in src/pools/abstract-pool.ts:391

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

`Protected` getWorkerInfoByWorker

getWorkerInfoByWorker(worker): WorkerInfo
+
Gets the worker information from the given worker.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns WorkerInfo
The worker information.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the worker is not found.
+
+
Inherited from FixedClusterPool.getWorkerInfoByWorker
+
- Defined in src/pools/abstract-pool.ts:1067

`Protected` getWorkerNodeKey

getWorkerNodeKey(worker): number
+
Gets the given worker its worker node key.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns number
The worker node key if found in the pool worker nodes, -1 otherwise.
+ +
+
Inherited from FixedClusterPool.getWorkerNodeKey
+
- Defined in src/pools/abstract-pool.ts:519

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

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

`Protected` isMain

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

`Protected` registerWorkerMessageListener

Parameters

-
message: MessageValue<Message, unknown, Worker | MessagePort>

message: MessageValue<Message, unknown>

Returns void

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

`Protected` sendStartupMessageToWorker

sendStartupMessageToWorker(worker): void
+
Sends the startup message to the given worker.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker which should receive the startup message.
  +
  +
+
Returns void
+
+
Inherited from FixedClusterPool.sendStartupMessageToWorker
+
- Defined in src/pools/cluster/fixed.ts:77

`Protected` sendToWorker

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

The message.

@@ -599,7 +712,7 @@ Can be overridden.

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

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

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

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

`Protected` workerListener

Parameters

-
message: MessageValue<Response, unknown, 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:992

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file