DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=1ed77aeb911ce00d07e83246c79bd15fa828a97a;hb=fb8fbcfd7983c1eadc39411c9b29054e6fa97d5b;hp=c220e4e5fa869366b3d1d485c1465920689a4da7;hpb=6d59ea2c71b8a88d41498c6fb54dfad95fd3a3ac;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index c220e4e5..1ed77aeb 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier

+DynamicClusterPool | poolifier - v2.6.28

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

Methods

afterTaskExecutionHook -afterWorkerSetup +afterWorkerNodeSetup beforeTaskExecutionHook -createAndSetupDynamicWorker -createAndSetupWorker +checkDynamicPoolSize +createAndSetupDynamicWorkerNode +createAndSetupWorkerNode createWorker destroy -destroyWorker +destroyWorkerNode enableTasksQueue execute +flushTasksQueue +getWorkerInfo internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -141,7 +149,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 +158,10 @@ 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.
'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.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'destroy': Emitted when the pool is destroyed.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

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

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

`Protected` `Readonly` filePath

filePath: string

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

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

`Protected` `Readonly` max

max: number

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

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -194,11 +204,11 @@ 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>> = ...

The execution response promise map.

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

The task execution response promise map.

key: The message id of each submitted task.
value: An object that contains the worker, the execution response promise resolve and reject callbacks.

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

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

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

`Readonly` workerNodes

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

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

Pool worker nodes.

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

Accessors

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

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

`Protected` full

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

info

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

`Protected` maxSize

get maxSize(): number
-
Pool maximum size.
+
The pool maximum size.

Returns number
Overrides FixedClusterPool.maxSize
- Defined in src/pools/cluster/dynamic.ts:42

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

`Protected` minSize

get minSize(): number
-
Pool minimum size.
+
The pool minimum size.

Returns number
Inherited from FixedClusterPool.minSize
- Defined in src/pools/cluster/fixed.ts:110

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

`Private` ready

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

`Protected` type

get type(): "fixed" | "dynamic"
-
Pool type.
+
The pool type.

If it is 'dynamic', it provides the max property.

Returns "fixed" | "dynamic"
Overrides FixedClusterPool.type
- Defined in src/pools/cluster/dynamic.ts:37

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

`Private` utilization

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

`Protected` worker

get worker(): "cluster" | "thread"
get worker(): "thread" | "cluster"
-
Gets the worker type.
+
The worker type.

-
Returns "cluster" | "thread"
+
Returns "thread" | "cluster"
Inherited from FixedClusterPool.worker
- Defined in src/pools/cluster/fixed.ts:105

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

Methods

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker, message): void
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution. Can be overridden.
@@ -330,12 +365,12 @@ Can be overridden.

Parameters
- -
  worker: Worker
  -
  The worker.
  +
  workerNodeKey: number
  +
  The worker node key.
- -
  message: MessageValue<Response, unknown, Worker | MessagePort>
  +
  message: MessageValue<Response, unknown>
  
  The received message.
@@ -343,28 +378,28 @@ Can be overridden.
Inherited from FixedClusterPool.afterTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:505

`Protected` afterWorkerSetup

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

`Protected` afterWorkerNodeSetup

afterWorkerSetup(worker): void
afterWorkerNodeSetup(workerNodeKey): 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.
+
Method hooked up after a worker node has been newly created. +Can be overridden.
Parameters
- -
  worker: Worker
  -
  The newly created worker.
  +
  workerNodeKey: number
  +
  The newly created worker node key.
Returns void
-
Inherited from FixedClusterPool.afterWorkerSetup
+
Inherited from FixedClusterPool.afterWorkerNodeSetup
- Defined in src/pools/cluster/fixed.ts:94

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

`Protected` beforeTaskExecutionHook

`Protected` createAndSetupDynamicWorker

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

`Protected` checkDynamicPoolSize

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

`Protected` createAndSetupDynamicWorkerNode

createAndSetupDynamicWorker(): Worker
createAndSetupDynamicWorkerNode(): number
-
Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+
Creates a new, completely set up dynamic worker node.

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

`Protected` createAndSetupWorker

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

`Protected` createAndSetupWorkerNode

createAndSetupWorker(): Worker
createAndSetupWorkerNode(): number
-
Creates a new worker and sets it up completely in the pool worker nodes.
+
Creates a new, completely set up worker node.

-
Returns Worker
New, completely set up worker.
+
Returns number
New, completely set up worker node key.
-
Inherited from FixedClusterPool.createAndSetupWorker
+
Inherited from FixedClusterPool.createAndSetupWorkerNode
- Defined in src/pools/abstract-pool.ts:703

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

`Protected` createWorker

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

destroy

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

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

`Protected` destroyWorker

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

`Protected` destroyWorkerNode

destroyWorker(worker): void
destroyWorkerNode(workerNodeKey): Promise<void>
-
Terminates the given worker.
+
Terminates the worker node given its worker node key.
Parameters
- -
  worker: Worker
  -
  A worker within workerNodes.
  +
  workerNodeKey: number
  +
  The worker node key.
-
Returns void
+
Returns Promise<void>
-
Inherited from FixedClusterPool.destroyWorker
+
Inherited from FixedClusterPool.destroyWorkerNode
- Defined in src/pools/cluster/fixed.ts:70

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

enableTasksQueue

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

execute

execute(data?, name?): Promise<Response>
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.

@@ -499,12 +550,17 @@ Can be overridden.
- Optional data: Data
  -
  The task input data for the specified worker function. This can only be serializable data.
  +
  The optional task input data for the specified task function. This can only be structured-cloneable data.
- Optional name: string
  -
  The name of the worker function to execute. If not specified, the default worker function will be executed.
  +
  The optional name of the task function to execute. If not specified, the default task function will be executed.
  +
  +
- +
  Optional transferList: TransferListItem[]
  +
  An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
@@ -512,20 +568,55 @@ Can be overridden.
Inherited from FixedClusterPool.execute
- Defined in src/pools/abstract-pool.ts:416

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

`Protected` flushTasksQueue

flushTasksQueue(workerNodeKey): void
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns void
+
Inherited from FixedClusterPool.flushTasksQueue
+
- Defined in src/pools/abstract-pool.ts:1246

`Protected` getWorkerInfo

getWorkerInfo(workerNodeKey): WorkerInfo
+
Gets the worker information given its worker node key.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns WorkerInfo
The worker information.
+ +
+
Inherited from FixedClusterPool.getWorkerInfo
+
- Defined in src/pools/abstract-pool.ts:1185

`Protected` internalBusy

internalBusy(): boolean
-
Whether worker nodes are executing at least one task.
+
Whether worker nodes are executing concurrently their tasks quota or not.

Returns boolean
Worker nodes busyness boolean status.
Inherited from FixedClusterPool.internalBusy
- Defined in src/pools/abstract-pool.ts:407

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

`Protected` isMain

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

listTaskFunctions

listTaskFunctions(): string[]
+
Lists the names of task function available in this pool.
+
+
Returns string[]
The names of task function available in this pool.
+ +
+
Inherited from FixedClusterPool.listTaskFunctions
+
- Defined in src/pools/abstract-pool.ts:652

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker, listener): void
registerWorkerMessageListener<Message>(workerNodeKey, listener): void
-
Registers a listener callback on the given worker.
+
Registers a listener callback on the worker given its worker node key.
Type Parameters
@@ -554,8 +658,8 @@ Can be overridden.

Parameters
- -
  worker: Worker
  -
  The worker which should register a listener.
  +
  workerNodeKey: number
  +
  The worker node key.
- @@ -572,30 +676,66 @@ Can be overridden.
  
  Parameters
  - -
    message: MessageValue<Message, unknown, Worker | MessagePort>
+
message: MessageValue<Message, unknown>

Returns void

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

`Protected` sendKillMessageToWorker

sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+
+
Parameters
+
- +
  workerNodeKey: number
- +
  workerId: number
+
Returns Promise<void>
+
Inherited from FixedClusterPool.sendKillMessageToWorker
+
- Defined in src/pools/abstract-pool.ts:729

`Protected` sendStartupMessageToWorker

sendStartupMessageToWorker(workerNodeKey): void
+
Sends the startup message to worker given its worker node key.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns void
+
+
Inherited from FixedClusterPool.sendStartupMessageToWorker
+
- Defined in src/pools/cluster/fixed.ts:89

`Protected` sendToWorker

sendToWorker(worker, message): void
sendToWorker(workerNodeKey, message): void
-
Sends a message to the given worker.
+
Sends a message to worker given its worker node key.
Parameters
- -
  worker: Worker
  -
  The worker which should receive the message.
  +
  workerNodeKey: number
  +
  The worker node key.
- -
  message: MessageValue<Data, unknown, Worker | MessagePort>
  +
  message: MessageValue<Data, unknown>
  
  The message.
@@ -603,7 +743,7 @@ Can be overridden.
Inherited from FixedClusterPool.sendToWorker
- Defined in src/pools/cluster/fixed.ts:76

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

`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

workerListener(): ((message) => void)
-
This function is the listener registered for each worker message.
+
This method is the listener registered for each worker message.

Returns ((message) => void)
The listener function to execute when a message is received from a worker.
@@ -696,20 +836,20 @@ Can be overridden
- (message): void
- -
  This function is the listener registered for each worker message.
  +
  This method is the listener registered for each worker message.
  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:1111

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

workerNodeKey: number

worker: Worker

workerNodeKey: number

workerNodeKey: number

workerNodeKey: number

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

workerNodeKey: number

Parameters

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