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:
'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 >= maximum queue size).
@@ -171,7 +178,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
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:
'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 >= maximum queue size).ProtectedReadonlyfileProtectedReadonlymaxProtectedReadonlynumberProtectedReadonlyoptsProtectedpromiseThe 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.ProtectedworkerReadonlyInternalworkerAccessors
Protectedfull@@ -267,7 +274,7 @@ When the maximum number of workers is reached and workers are busy, an event is
info
@@ -279,7 +286,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protectedmax@@ -291,7 +298,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protectedmin@@ -303,7 +310,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Privateready@@ -315,7 +322,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protectedtype@@ -328,7 +335,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Privateutilization@@ -341,7 +348,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protectedworker@@ -353,9 +360,40 @@ When the maximum number of workers 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@@ -381,7 +419,7 @@ Can be overridden.
Protectedafter@@ -402,7 +440,7 @@ Can be overridden.
Protectedbefore@@ -428,23 +466,7 @@ Can be overridden.
-Protectedcheck-- check
--
-
-
-
Parameters
---
-
--
-
min: number
max: number
Returns void
Protectedcreate@@ -457,7 +479,7 @@ Can be overridden.
Protectedcreate@@ -470,7 +492,7 @@ Can be overridden.
Protectedcreate@@ -483,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
@@ -495,7 +558,7 @@ Can be overridden.
Protecteddestroy@@ -515,7 +578,7 @@ Can be overridden.
enable
@@ -540,7 +603,7 @@ Can be overridden.
execute
@@ -571,7 +634,7 @@ Can be overridden.
Protectedflush@@ -585,11 +648,11 @@ Can be overridden.
Returns void
Protectedget-- get
+- get
-
Gets the worker information given its worker node key.
The worker node key.
Returns undefined | WorkerInfo
The worker information.
+Returns WorkerInfo
The worker information.
+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
@@ -627,7 +711,7 @@ Can be overridden.
Protectedinternal@@ -640,7 +724,7 @@ Can be overridden.
Protectedis@@ -652,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@@ -706,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@@ -742,7 +886,7 @@ Can be overridden.
Protectedsend@@ -767,7 +911,28 @@ 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
@@ -787,7 +952,7 @@ Can be overridden.
set
@@ -812,7 +977,7 @@ Can be overridden.
set
@@ -832,7 +997,7 @@ Can be overridden.
Protectedsetup@@ -845,7 +1010,19 @@ Can be overridden.
start
++- start(): void
+-
+
Starts the minimum number of workers in this pool.
+Returns void
+Protectedworker@@ -873,20 +1050,20 @@ Can be overridden.