Constructs a new poolifier pool.
Path to the worker file.
Options for the pool.
Optional Readonly emitterEmitter on which events can be listened to.
Events that can currently be listened to:
'full': Emitted when the pool is dynamic and full.'busy': Emitted when the pool is busy.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.Readonly fileProtected Readonly filePath to the worker file.
Readonly numberProtected Readonly numberNumber of workers that this pool should manage.
Readonly optsProtected Readonly optsOptions for the pool.
Protected promiseThe execution response promise map.
key: The message id of each submitted task.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Readonly workerPool worker nodes.
Protected Abstract fullProtected fullPrivate numberNumber of tasks queued in the pool.
+Pool information.
+Protected Abstract maxPool maximum size.
Private numberProtected Abstract minNumber of tasks running in the pool.
+Pool minimum size.
Abstract typeProtected Abstract typePool type.
If it is 'dynamic', it provides the max property.
Protected Abstract workerGets the worker type.
+Protected afterHook executed after the worker task execution. Can be overridden.
@@ -290,16 +314,16 @@ Can be overridden.The worker.
The received message.
Protected Abstract afterFunction 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 maxListeners or binding the main-worker<->worker connection if not bind by default.
Protected beforePrivate buildPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkProtected chooseChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Protected createProtected Abstract createPrivate dequeueProtected Abstract destroyShutdowns the given worker.
Enables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
Optional tasksQueueOptions: TasksQueueOptionsOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Private enqueueExecutes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+Executes the specified function in the worker constructor with the task data input parameter.
Optional data: DataThe task input data for the specified worker function. This can only be serializable data.
+Optional name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Private executeFinds a free worker node key based on the number of tasks the worker has applied.
-If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1 is returned.
A worker node key if there is one, -1 otherwise.
Private flushPrivate flushPrivate flushPrivate getPrivate getGets the given worker its tasks usage in the pool.
- -Error if the worker is not found in the pool worker nodes.
- -The worker tasks usage.
-The worker.
-Protected internalProtected Abstract isPrivate pushProtected Abstract registerRegisters a listener callback on the given worker.
Private removeRemoves the given worker from the pool worker nodes.
Protected Abstract sendSends a message to the given worker.
The worker which should receive the message.
The message.
Sets the worker tasks queue options in this pool.
The worker tasks queue options.
Sets the worker choice strategy in this pool.
The worker choice strategy.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Private setSets the given worker in the pool worker nodes.
The worker.
The worker tasks usage.
The worker task queue.
Private setSets the given worker node its tasks usage in the pool.
The worker node.
The worker node tasks usage.
Protected setupPrivate tasksPrivate updatePrivate updateProtected workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+Generated using TypeDoc
Base class that implements some shared logic for all poolifier pools.