@@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:15
@@ -74,7 +74,6 @@ When the maximum number of workers is reached and workers are busy, an event is
max Size
min Size
ready
-starting
type
utilization
worker
@@ -82,18 +81,22 @@ When the maximum number of workers is reached and workers are busy, an event is
Methods
after Task Execution Hook
-
after Worker Setup
+
after Worker Node Setup
before Task Execution Hook
check Dynamic Pool Size
-
create And Setup Dynamic Worker
-
create And Setup Worker
+
create And Setup Dynamic Worker Node
+
create And Setup Worker Node
create Worker
destroy
-
destroy Worker
+
destroy Worker Node
enable Tasks Queue
execute
+
flush Tasks Queue
+
get Worker Info
internal Busy
is Main
+
register Worker Message Listener
+
send Startup Message To Worker
send To Worker
set Tasks Queue Options
set Worker Choice Strategy
@@ -144,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
@@ -163,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
file Path
file Path : string
@@ -172,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:104
Protected
Readonly
max
max : number
@@ -180,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
number Of Workers
number Of Workers : number
@@ -189,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:103
Protected
Readonly
opts
@@ -198,11 +201,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
promise Response Map
-
-
The execution response promise map.
+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.Protected
workerReadonly
workerAccessors
Protected
full@@ -258,7 +261,7 @@ When the maximum number of workers is reached and workers are busy, an event is
info
@@ -270,93 +273,87 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
maxPool maximum size.
+The pool maximum size.
Returns number
+Protected
minPool minimum size.
+The pool minimum size.
Returns number
+Private
readyReturns boolean
-Private
starting-- get starting(): boolean
--
-
-
Returns boolean
Inherited from FixedClusterPool.starting
--- Defined in src/pools/abstract-pool.ts:408
Protected
typePool type.
+The pool type.
If it is
'dynamic'
, it provides themax
property.Returns "fixed" | "dynamic"
Overrides FixedClusterPool.type
-- Defined in src/pools/cluster/dynamic.ts:38
Private
utilizationGets the approximate pool utilization.
+The approximate pool utilization.
Returns number
The pool utilization.
Inherited from FixedClusterPool.utilization
-- Defined in src/pools/abstract-pool.ts:428
Protected
workerGets the worker type.
+The worker type.
Returns "cluster" | "thread"
Inherited from FixedClusterPool.worker
-- Defined in src/pools/cluster/fixed.ts:87
Methods
Protected
after-- after
Task Execution Hook(worker, message): void
+- after
Task Execution Hook(workerNodeKey, message): void
-
-
-
-
@@ -378,28 +375,28 @@ Can be overridden.
-
-- Defined in src/pools/abstract-pool.ts:718
+
+ Worker Node Setup
Hook executed after the worker task execution. Can be overridden.
@@ -365,8 +362,8 @@ Can be overridden.Parameters
worker: Worker
-The worker.
+workerNodeKey: number
+The worker node key.
Inherited from FixedClusterPool.afterTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:692
Worker Setup
+Protected
afterProtected
after-- after
Worker Setup(worker): void
+- after
Worker Node Setup(workerNodeKey): void
-
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:947
Task Execution Hook
+- Defined in src/pools/abstract-pool.ts:697
Dynamic Pool Size
-
-- Defined in src/pools/abstract-pool.ts:173
+
+ And Setup Dynamic Worker Node
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:927
Protected
before@@ -425,7 +422,7 @@ Can be overridden.
Inherited from FixedClusterPool.beforeTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:671
Protected
check@@ -441,33 +438,33 @@ Can be overridden.
Returns void
Inherited from FixedClusterPool.checkDynamicPoolSize
-- Defined in src/pools/abstract-pool.ts:164
And Setup Dynamic Worker
+Protected
createProtected
create-- create
And Setup Dynamic Worker(): Worker
+- create
And Setup Dynamic Worker Node(): number
-
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:896
+
+ And Setup Worker Node
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:1010
And Setup Worker
+Protected
createProtected
create-- create
And Setup Worker(): Worker
+- create
And Setup Worker Node(): number
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:856
Worker
+- Defined in src/pools/cluster/fixed.ts:105
- destroy(): Promise<void>
-
-
-
-- Defined in src/pools/abstract-pool.ts:660
+
+ Worker Node
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:944
Protected
create@@ -480,39 +477,39 @@ Can be overridden.
Inherited from FixedClusterPool.createWorker
-- Defined in src/pools/cluster/fixed.ts:77
destroy
Terminates 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:626
Worker
+Protected
destroyProtected
destroy-- destroy
Worker(worker): void
+- destroy
Worker Node(workerNodeKey): Promise<void>
-
-
-
-
-
-
+- Defined in src/pools/cluster/fixed.ts:63
+- Defined in src/pools/abstract-pool.ts:567
+- Defined in src/pools/abstract-pool.ts:628
+
+
+
+
Busy
+- Defined in src/pools/abstract-pool.ts:618
Main
+- Defined in src/pools/cluster/fixed.ts:58
+
+
+
+
To Worker
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:63
enable Tasks Queue
@@ -537,7 +534,7 @@ Can be overridden.
Inherited from FixedClusterPool.enableTasksQueue
-- Defined in src/pools/abstract-pool.ts:531
execute
@@ -563,7 +560,42 @@ Can be overridden.
Inherited from FixedClusterPool.execute
-- Defined in src/pools/abstract-pool.ts:591
Tasks Queue
+Protected
flush+- flush
Tasks Queue(workerNodeKey): void
+-
+
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns void
Inherited from FixedClusterPool.flushTasksQueue
++- Defined in src/pools/abstract-pool.ts:1157
Worker Info
+Protected
get+- get
Worker Info(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:1096
Protected
internal@@ -576,7 +608,7 @@ Can be overridden.
Inherited from FixedClusterPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:582
Protected
is@@ -588,20 +620,81 @@ Can be overridden.
Inherited from FixedClusterPool.isMain
-- Defined in src/pools/cluster/fixed.ts:58
Worker Message Listener
+Protected
register+- register
Worker Message Listener<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
Startup Message To Worker
+Protected
send+- send
Startup Message To Worker(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
send-- send
To Worker(worker, message): void
+- send
To Worker(workerNodeKey, message): void
-
-
-
-
-
@@ -613,7 +706,7 @@ Can be overridden.
+- Defined in src/pools/cluster/fixed.ts:81
+- Defined in src/pools/abstract-pool.ts:579
+- Defined in src/pools/abstract-pool.ts:537
+- Defined in src/pools/abstract-pool.ts:556
Hook
+- Defined in src/pools/cluster/fixed.ts:53
Listener
- worker
Listener(): ((message) => void)
-
-
- (message): void
-
-
+- Defined in src/pools/abstract-pool.ts:1030
@@ -754,23 +847,26 @@ Can be overridden.
- max
Size
- min
Size
- ready
-- starting
- type
- utilization
- worker
- after
Task Execution Hook
-- after
Worker Setup
+- after
Worker Node Setup
- before
Task Execution Hook
- check
Dynamic Pool Size
-- create
And Setup Dynamic Worker
-- create
And Setup Worker
+- create
And Setup Dynamic Worker Node
+- create
And Setup Worker Node
- create
Worker
- destroy
-- destroy
Worker
+- destroy
Worker Node
- enable
Tasks Queue
- execute
+- flush
Tasks Queue
+- get
Worker Info
- internal
Busy
- is
Main
+- register
Worker Message Listener
+- send
Startup Message To Worker
- send
To Worker
- set
Tasks Queue Options
- set
Worker Choice Strategy
@@ -778,7 +874,7 @@ Can be overridden.
- setup
Hook
- worker
Listener
-
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.
Inherited from FixedClusterPool.sendToWorker
-- Defined in src/pools/cluster/fixed.ts:72
set Tasks Queue Options
@@ -633,7 +726,7 @@ Can be overridden.
Inherited from FixedClusterPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:543
set Worker Choice Strategy
@@ -658,7 +751,7 @@ Can be overridden.
Inherited from FixedClusterPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:501
set Worker Choice Strategy Options
@@ -678,7 +771,7 @@ Can be overridden.
Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:520
Protected
setup@@ -691,13 +784,13 @@ Can be overridden.
Inherited from FixedClusterPool.setupHook
-- Defined in src/pools/cluster/fixed.ts:53
Protected
workerThis 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.
@@ -706,7 +799,7 @@ Can be overridden.This function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
Parameters
@@ -719,7 +812,7 @@ Can be overridden.Inherited from FixedClusterPool.workerListener
-- Defined in src/pools/abstract-pool.ts:1041