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).
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).ProtectedReadonlyfile
+ProtectedOptionalReadonlymaxDynamic pool maximum size property placeholder.
+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@@ -250,7 +269,7 @@
info
@@ -262,31 +281,31 @@
-Protectedmax+- get maxSize(): number
-
The pool maximum size.
Returns number
-Protectedmin+- get minSize(): number
-
The pool minimum size.
Returns number
Privateready@@ -298,7 +317,7 @@
Protectedtype@@ -311,7 +330,7 @@
Privateutilization@@ -324,7 +343,7 @@
Protectedworker@@ -336,9 +355,40 @@
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@@ -364,7 +414,7 @@ Can be overridden.
Protectedafter@@ -385,7 +435,7 @@ Can be overridden.
Protectedbefore@@ -411,23 +461,7 @@ Can be overridden.
-Protectedcheck-- check
--
-
-
-
Parameters
---
-
--
-
min: number
max: number
Returns void
Protectedcreate@@ -440,7 +474,7 @@ Can be overridden.
Protectedcreate@@ -453,7 +487,7 @@ Can be overridden.
Protectedcreate@@ -466,7 +500,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
@@ -478,7 +553,7 @@ Can be overridden.
Protecteddestroy@@ -498,32 +573,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/abstract-pool.ts:835
+
+
+- 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
@@ -554,7 +629,7 @@ Can be overridden.
Protectedflush@@ -568,7 +643,7 @@ Can be overridden.
Returns void
Protectedget@@ -589,7 +664,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@@ -602,7 +719,7 @@ Can be overridden.
Protectedis@@ -614,20 +731,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@@ -668,23 +826,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@@ -704,7 +881,7 @@ Can be overridden.
Protectedsend@@ -734,27 +911,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
@@ -779,7 +977,7 @@ Can be overridden.
set
@@ -799,7 +997,7 @@ Can be overridden.
Protectedsetup@@ -812,7 +1010,19 @@ Can be overridden.
start
++- start(): void
+-
+
Starts the minimum number of workers in this pool.
+Returns void
+Protectedworker@@ -840,20 +1050,20 @@ Can be overridden.
-
+Settings
Settings
Member Visibility
Theme
@@ -863,6 +1073,7 @@ Can be overridden.- constructor
- emitter
- file
+- max
- number
- opts
- promise
@@ -871,100 +1082,69 @@ Can be overridden.
- busy
- full
- info
-- max
-- min
+- 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