DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=a28b464723853f1775d60cf99e77c400b2455d07;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=123ceb733909aea60eacd54f44b7fd1bfdcaab56;hpb=52d3ec6b2aea8279b0ac670bd6291efa90466a60;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 123ceb73..a28b4647 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier

+DynamicClusterPool | poolifier - v2.6.26

@@ -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,23 +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 @@ -140,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

@@ -149,8 +158,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.

@@ -158,7 +168,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

@@ -167,7 +177,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

@@ -175,7 +185,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

@@ -184,7 +194,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 = {}

@@ -193,11 +203,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>

@@ -216,16 +226,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

@@ -240,7 +250,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:613

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

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

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.
@@ -329,8 +364,8 @@ Can be overridden.

Parameters
- -
  worker: Worker
  -
  The worker.
  +
  workerNodeKey: number
  +
  The worker node key.
- @@ -342,28 +377,28 @@ Can be overridden.
  Inherited from FixedClusterPool.afterTaskExecutionHook
  - Defined in src/pools/abstract-pool.ts:506

`Protected` afterWorkerSetup

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

`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. +
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/abstract-pool.ts:699

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

`Protected` beforeTaskExecutionHook

`Protected` createAndSetupDynamicWorker

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

`Protected` checkDynamicPoolSize

createAndSetupDynamicWorker(): Worker
checkDynamicPoolSize(min, max): void
-
Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+
+
Parameters
+
- +
  min: number
- +
  max: number
+
Returns void
+
Inherited from FixedClusterPool.checkDynamicPoolSize
+
- Defined in src/pools/abstract-pool.ts:180

`Protected` createAndSetupDynamicWorkerNode

createAndSetupDynamicWorkerNode(): number
+
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:742

`Protected` createAndSetupWorker

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

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

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

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

`Protected` destroyWorker

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

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

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

enableTasksQueue

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

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.

@@ -498,12 +549,17 @@ Can be overridden.
- Optional data: Data
  -
  The task input data for the specified worker function. This can only be structured-cloneable 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.
@@ -511,20 +567,55 @@ Can be overridden.
Inherited from FixedClusterPool.execute
- Defined in src/pools/abstract-pool.ts:417

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

`Protected` flushTasksQueue

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

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

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

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

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

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(workerNodeKey, listener): void
+
Registers a listener callback on the worker given its worker node key.
+
+
+
Type Parameters
+
- +
  Message
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
- +
  listener: ((message) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Inherited from FixedClusterPool.registerWorkerMessageListener
+
- 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:726

`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.
- @@ -561,7 +742,7 @@ Can be overridden.
  Inherited from FixedClusterPool.sendToWorker
  
  -
  Defined in src/pools/cluster/fixed.ts:77

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

`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.
@@ -654,7 +835,7 @@ 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
  @@ -667,7 +848,7 @@ Can be overridden.
  
  Inherited from FixedClusterPool.workerListener
  
  -
  Defined in src/pools/abstract-pool.ts:769

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

workerNodeKey: number

worker: Worker

workerNodeKey: number

workerNodeKey: number

Parameters

message: MessageValue<Message, unknown>

Returns void

workerNodeKey: number

Parameters