Event emitter integrated with async resource on which events can be listened to.
+The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
Events that can currently be listened to:
-
'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.
+
'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.
'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 >= maximum queue size).
Emitter on which events can be listened to.
+
+OptionalemitterEvent emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool.Events that can currently be listened to:
-
'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.'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.'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 >= maximum queue size).ProtectedReadonlyfileProtectedReadonlymaxMaximum number of threads that can be created by this pool.
ProtectedReadonlynumberProtectedReadonlyoptsProtectedpromiseThe task 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.Protectedworker
+ReadonlyworkerReadonlyInternalworkerPool worker nodes.
Accessors
Protectedfull@@ -263,7 +274,7 @@ When the maximum number of threads is reached and workers are busy, an event is
info
@@ -275,19 +286,19 @@ When the maximum number of threads is reached and workers are busy, an event is
-Protectedmax+- get maxSize(): number
-
The pool maximum size.
Returns number
Protectedmin@@ -299,7 +310,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Privateready@@ -311,7 +322,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protectedtype@@ -324,7 +335,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Privateutilization@@ -337,7 +348,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protectedworker@@ -349,9 +360,40 @@ When the maximum number of threads is reached and workers are busy, an event is
Methods
+add
++- add
+-
+
+
+
+
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+Parameters
++-
+
+-
+
name: string
+The name of the task function.
+fn: TaskFunction<Data, Response>
+The task function.
+Returns Promise<boolean>
+ +trueif the task function was added,falseotherwise.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+ +nameparameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+fnparameter is not a function.Protectedafter@@ -377,7 +419,7 @@ Can be overridden.
Protectedafter@@ -398,7 +440,7 @@ Can be overridden.
Protectedbefore@@ -424,23 +466,7 @@ Can be overridden.
-Protectedcheck-- check
--
-
-
-
Parameters
---
-
--
-
min: number
max: number
Returns void
Protectedcreate@@ -453,7 +479,7 @@ Can be overridden.
Protectedcreate@@ -466,7 +492,7 @@ Can be overridden.
Protectedcreate@@ -479,7 +505,48 @@ Can be overridden.
+Protectedderegister+- deregister
+-
+
+
+
+
+
Deregisters 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
+destroy
@@ -491,7 +558,7 @@ Can be overridden.
Protecteddestroy@@ -511,32 +578,32 @@ Can be overridden.
enable
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Parameters
-
-
+- Defined in src/pools/abstract-pool.ts:565
+- Defined in src/pools/abstract-pool.ts:870
+- Defined in src/pools/abstract-pool.ts:1669
+- Defined in src/pools/abstract-pool.ts:1585
+
+
+
+
+- Defined in src/pools/abstract-pool.ts:667
-
-- Defined in src/pools/thread/fixed.ts:55
+
+
+
+
+- Defined in src/pools/thread/fixed.ts:116
+- Defined in src/pools/thread/fixed.ts:106
+
+
+enable: boolean
-Whether to enable or disable the worker tasks queue.
+Whether to enable or disable the worker node tasks queue.
-OptionaltasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+The worker node tasks queue options.
Returns void
execute
@@ -567,7 +634,7 @@ Can be overridden.
Protectedflush@@ -581,7 +648,7 @@ Can be overridden.
Returns void
Protectedget@@ -602,7 +669,49 @@ Can be overridden.
has
++- has
+-
+
+
+
Whether the specified task function exists in this pool.
+Parameters
++-
+
name: string
+The name of the task function.
+Returns boolean
+ +trueif the task function exists,falseotherwise.has
++- has
+
+
+
Internal+Whether the worker node has back pressure (i.e. its tasks queue is full).
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+Returns boolean
+ +trueif the worker node has back pressure,falseotherwise.Protectedinternal@@ -615,7 +724,7 @@ Can be overridden.
Protectedis@@ -627,20 +736,61 @@ Can be overridden.
list
+list
-- list
+- list
-
Lists the names of task function available in this pool.
Returns string[]
The names of task function available in this pool.
+Protectedregister+- register
+-
+
+
+
+
+
Registers once 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
+Protectedregister@@ -681,23 +831,42 @@ Can be overridden.
remove
++- remove
+-
+
+
+
Removes a task function from this pool.
+Parameters
++-
+
name: string
+The name of the task function.
+Returns Promise<boolean>
+ +trueif the task function was removed,falseotherwise.Protectedsend-- send
+- send
-
-
-
--
-
+
Parameters
workerNodeKey: number
workerId: number
workerNodeKey: number
Returns Promise<void>
Protectedsend@@ -717,7 +886,7 @@ Can be overridden.
Protectedsend@@ -747,27 +916,48 @@ Can be overridden.
set
++- set
+-
+
+
+
Sets the default task function in this pool.
+Parameters
++-
+
name: string
+The name of the task function.
+Returns Promise<boolean>
+ +trueif the default task function was set,falseotherwise.set
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
@@ -792,7 +982,7 @@ Can be overridden.
set
@@ -812,7 +1002,7 @@ Can be overridden.
Protectedsetup@@ -825,7 +1015,19 @@ Can be overridden.
start
++- start(): void
+-
+
Starts the minimum number of workers in this pool.
+Returns void
+Protectedworker@@ -853,20 +1055,20 @@ Can be overridden.
-
+Settings
Settings
Member Visibility
Theme
@@ -876,7 +1078,7 @@ Can be overridden.- constructor
- emitter
- file
-- max
+- max
- number
- opts
- promise
@@ -885,100 +1087,69 @@ Can be overridden.
- busy
- full
- info
-- max
+- max
- min
- ready
- type
- utilization
- worker
+- add
- after
- after
- before
-- check
- create
- create
- create
+- deregister
- destroy
- destroy
- enable
- execute
- flush
- get
+- has
+- has
- internal
- is
-- list
+- list
+- register
- register
+- remove
- send
- send
- send
+- set
- set
- set
- set
- setup
+- start
- worker