@@ -45,19 +45,19 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:15
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
busy
full
info
maxSize
@@ -80,7 +80,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Methods
-afterTaskExecutionHook
+
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkDynamicPoolSize
@@ -110,7 +110,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Constructors
-constructor
+constructor
- new DynamicClusterPool<Data, Response>(min, max, filePath, opts?): DynamicClusterPool<Data, Response>
-
@@ -150,7 +150,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
@@ -160,18 +160,18 @@ When the maximum number of workers is reached and workers are busy, an event is
Events that can currently be listened to:
'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.
+'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
'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.
+'destroy'
: Emitted when the pool is destroyed.
'error'
: Emitted when an uncaught error occurs.
'taskError'
: Emitted when an error occurs while executing a task.
-'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= pool maximum size^2).
+'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
+
Defined in src/pools/abstract-pool.ts:68
Protected
Readonly
filePath
filePath: string
@@ -180,7 +180,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:117
Protected
Readonly
max
max: number
@@ -189,7 +189,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
@@ -198,7 +198,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:116
Protected
Readonly
opts
@@ -207,7 +207,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
@@ -221,7 +221,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:78
Protected
workerChoiceStrategyContext
@@ -230,7 +230,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:84
Readonly
Internal
workerNodes
@@ -239,7 +239,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:65
+
Defined in src/pools/abstract-pool.ts:689
+
Defined in src/pools/abstract-pool.ts:350
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:507
+
Defined in src/pools/cluster/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:524
+
Defined in src/pools/cluster/fixed.ts:119
Protected
afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1162
Protected
beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:858
Protected
checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:187
Protected
createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1105
Protected
createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1061
+
Defined in src/pools/cluster/fixed.ts:109
+
Defined in src/pools/abstract-pool.ts:803
Protected
destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
-
\ No newline at end of file
+Generated using TypeDoc
+
\ No newline at end of file
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Parameters
enable: boolean
-Whether to enable or disable the worker tasks queue.
+Whether to enable or disable the worker node tasks queue.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+The worker node tasks queue options.
Returns void
execute
@@ -571,7 +571,7 @@ Can be overridden.
Protected
flush@@ -585,7 +585,7 @@ Can be overridden.
Returns void
Protected
get@@ -606,7 +606,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -627,7 +627,7 @@ Can be overridden.
Protected
internal@@ -640,7 +640,7 @@ Can be overridden.
Protected
is@@ -652,7 +652,7 @@ Can be overridden.
list Task Functions
@@ -665,7 +665,7 @@ Can be overridden.
Protected
register@@ -706,7 +706,7 @@ Can be overridden.
Protected
send@@ -722,7 +722,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -742,7 +742,7 @@ Can be overridden.
Protected
send@@ -767,27 +767,27 @@ Can be overridden.
set Tasks Queue Options
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
Parameters
tasksQueueOptions: TasksQueueOptions
-The worker tasks queue options.
+The worker node tasks queue options.
Returns void
set Worker Choice Strategy
@@ -812,7 +812,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -832,7 +832,7 @@ Can be overridden.
Protected
setup@@ -845,7 +845,7 @@ Can be overridden.
Protected
worker@@ -873,20 +873,20 @@ Can be overridden.
-
+Settings
Settings
Member Visibility
Theme
@@ -938,68 +938,30 @@ Can be overridden.- setup
Hook
- worker
Listener