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 full.
-
'busy': Emitted when the pool is busy.
+
'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 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).
Executes the specified function in the worker constructor with the task data input parameter.
@@ -483,12 +612,17 @@ Can be overridden.
Optionaldata: Data
-
The task input data for the specified worker function. This can only be serializable data.
+
The optional task input data for the specified task function. This can only be structured-cloneable data.
Optionalname: string
-
The name of the worker function to execute. If not specified, the default worker function will be executed.
+
The optional name of the task function to execute. If not specified, the default task function will be executed.
+
+
+
+
OptionaltransferList: TransferListItem[]
+
An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
A cluster pool with a fixed number of workers.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the workers in a round robin fashion.
Author
Christopher Quadflieg
@@ -30,12 +28,12 @@Data = unknown
-Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
-
+Index
Index
Constructors
-Properties
-Accessors
-Methods
-Constructors
constructor
+constructor
Properties
-OptionalReadonlyemitterEmitter 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 full.'busy': Emitted when the pool is busy.'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 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).ProtectedReadonlyfile
+ProtectedOptionalReadonlymaxDynamic pool maximum size property placeholder.
+ProtectedReadonlynumberProtectedReadonlyopts
-ProtectedpromiseThe 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.ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonlyworker
+ReadonlyInternalworkerPool worker nodes.
Accessors
Protectedfull@@ -243,7 +270,7 @@
info
@@ -255,62 +282,118 @@
-Protectedmax+- get maxSize(): number
-
-
+- Defined in src/pools/abstract-pool.ts:486
+
Pool maximum size.
+The pool maximum size.
Returns number
-
-Protectedmin+- get minSize(): number
-
-
+
+- Defined in src/pools/abstract-pool.ts:431
- get type(): "fixed" | "dynamic"
-
-
- Defined in src/pools/cluster/fixed.ts:130
+
+
Pool minimum size.
+The pool minimum size.
Returns number
+
+Privateready+- get ready(): boolean
+-
+
The pool readiness boolean status.
+Returns boolean
+ProtectedtypePool type.
+The pool type.
If it is
'dynamic', it provides themaxproperty.Returns "fixed" | "dynamic"
+
+Privateutilization+- get utilization(): number
+-
+
The approximate pool utilization.
+Returns number
The pool utilization.
+ +Protectedworker-- get worker(): "cluster" | "thread"
+- get worker(): "thread" | "cluster"
-
-
- Defined in src/pools/cluster/fixed.ts:135
+
Gets the worker type.
+The worker type.
Returns "cluster" | "thread"
+Returns "thread" | "cluster"
+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-- after
+- after
-
-
+
+
Hook executed after the worker task execution. Can be overridden.
@@ -319,12 +402,12 @@ Can be overridden.Parameters
-
-
-
-
-worker: Worker
-The worker.
+workerNodeKey: number
+The worker node key.
message: MessageValue<Response, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The received message.
-Protectedafter-- after
+- Defined in src/pools/abstract-pool.ts:1043
+Protectedafter+- after
-
-
- Defined in src/pools/abstract-pool.ts:1356
-
-- Defined in src/pools/abstract-pool.ts:1013
+
+
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-Can be used to update the
+maxListenersor binding themain-worker<->workerconnection if not bind by default.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
Protectedbefore-- before
+- before
-
-
+
Hook executed before the worker task execution. Can be overridden.
@@ -369,112 +452,158 @@ Can be overridden.workerNodeKey: number
The worker node key.
task: Task<Data>
+The task to execute.
+Returns void
+ProtectedchooseProtectedcreate-- choose
+- create
-
-
-- Defined in src/pools/abstract-pool.ts:1260
+
+
Chooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+Creates a new, completely set up dynamic worker node.
Returns number
The worker node key
+Returns number
New, completely set up dynamic worker node key.
-
+ProtectedcreateProtectedcreate-- create
+- create
-
-
- Defined in src/pools/abstract-pool.ts:1216
- create
-
-
- Defined in src/pools/cluster/fixed.ts:125
+
+
- destroy(): Promise<void>
-
-
-- Defined in src/pools/abstract-pool.ts:949
+
+
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.
+ProtectedcreateReturns a newly created worker.
+Creates a new worker.
Returns Worker
+Returns Worker
Newly created worker.
+ +
+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
Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>
-
+ProtecteddestroyProtecteddestroy-- destroy
+- destroy
-
-
- Defined in src/pools/cluster/fixed.ts:63
- enable
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:564
+- Defined in src/pools/cluster/fixed.ts:101
+
+
+
+
+
+
Shutdowns 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>
enable
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.
-OptionaltasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+The worker node tasks queue options.
Returns void
execute
-- execute(data?, name?): Promise<Response>
+- execute(data?, name?, transferList?): Promise<Response>
-
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:879
+
+
+
+
+
+
+
+
+
+
- internal
-
-
+- Defined in src/pools/abstract-pool.ts:676
+- Defined in src/pools/cluster/fixed.ts:58
+
+
+
+
Executes the specified function in the worker constructor with the task data input parameter.
-Optionaldata: DataThe task input data for the specified worker function. This can only be serializable data.
+The optional task input data for the specified task function. This can only be structured-cloneable data.
-Optionalname: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+The optional name of the task function to execute. If not specified, the default task function will be executed.
+
+OptionaltransferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
@@ -496,16 +630,111 @@ Can be overridden.
+Protectedflag+- flag
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns void
+Protectedflush+- flush
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns void
+Protectedget+- get
+-
+
+
+
Gets the worker information given its worker node key.
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+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
++- 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.ProtectedinternalReturns boolean
Protectedis@@ -517,13 +746,67 @@ Can be overridden.
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-- register
+- register
-
-
-
-
-
@@ -552,30 +835,85 @@ Can be overridden.
-
-
Registers a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
Type Parameters
@@ -534,8 +817,8 @@ Can be overridden.Parameters
worker: Worker
-The worker which should register a listener.
+workerNodeKey: number
+The worker node key.
Parameters
message: MessageValue<Message, Worker | MessagePort>
message: MessageValue<Message, unknown>
Returns void
Returns void
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
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns Promise<void>
+Protectedsend+- send
+-
+
+
+
Sends the startup message to worker given its worker node key.
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+Returns void
+Protectedsend-- send
+- send
-
-
- Defined in src/pools/cluster/fixed.ts:83
+
+
- set
-
-
- Defined in src/pools/abstract-pool.ts:578
+- Defined in src/pools/abstract-pool.ts:531
+- Defined in src/pools/abstract-pool.ts:550
- setup
-
-
-
+
+
+- start
+- worker
-
+
-
-
\ No newline at end of file
+
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.
message: MessageValue<Data, Worker | MessagePort>
+message: MessageValue<Data, unknown>
The message.
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
@@ -615,7 +974,7 @@ Can be overridden.-
-
@@ -628,7 +987,7 @@ Can be overridden.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
set
@@ -648,53 +1007,54 @@ Can be overridden.
ProtectedsetupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Returns void
-
-Protectedworker-- worker
+- Defined in src/pools/cluster/fixed.ts:53
start
++- start(): void
-
-
+ - Defined in src/pools/abstract-pool.ts:1518
This function is the listener registered for each worker message.
+Starts the minimum number of workers in this pool.
Returns ((message) => void)
The listener function to execute when a message is received from a worker.
- ---
-
+-- (message): void
+
Returns void
+
+Protectedworker+- worker
-
-
-
-
-
This function is the listener registered for each worker message.
+This method is the message listener registered on each worker.
Parameters
message: MessageValue<Response, Worker | MessagePort>
Returns void
The listener function to execute when a message is received from a worker.
- - +message: MessageValue<Response, unknown>
Returns void
-
+Settings
Settings
Member Visibility
Generated using TypeDoc
Generated using TypeDoc