Abstract Type of worker which manages this pool.
Type of data sent to the worker. This can only be structured-cloneable data.
Type of execution response. This can only be structured-cloneable data.
Constructs a new poolifier pool.
Number of workers that this pool should manage.
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 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.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.Protected Readonly filePath to the worker file.
Protected Readonly numberNumber of workers that this pool should manage.
Protected Readonly optsOptions for the pool.
Protected promiseThe 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.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
Private Readonly startThe start timestamp of the pool.
Private Readonly startingWhether the pool is starting or not.
Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
Readonly workerPool worker nodes.
Protected Abstract busyWhether the pool is busy or not.
The pool busyness boolean status.
Protected fullWhether the pool is full or not.
The pool filling boolean status.
Protected Abstract maxThe pool maximum size.
Protected Abstract minThe pool minimum size.
Private readyThe pool readiness boolean status.
Protected Abstract typeThe pool type.
If it is 'dynamic', it provides the max property.
Private utilizationThe approximate pool utilization.
The pool utilization.
Protected Abstract workerThe worker type.
Private addAdds the given worker in the pool worker nodes.
The worker.
The added worker node key.
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
Protected afterHook executed after the worker task execution. Can be overridden.
The worker node key.
The received message.
Protected afterProtected beforeHook executed before the worker task execution. Can be overridden.
The worker node key.
The task to execute.
Private buildPrivate checkProtected checkPrivate checkPrivate checkChecks if the worker id sent in the received message from a worker is valid.
The received message.
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
Private checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate chooseProtected createProtected createProtected Abstract createPrivate dequeueProtected Abstract destroyEnables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Private enqueueExecutes 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 structured-cloneable data.
Optional name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Promise that will be fulfilled when the task is completed.
Private executeExecutes the given task on the worker given its worker node key.
The worker node key.
The task to execute.
Protected flushPrivate flushProtected getGets the worker information given its worker node key.
The worker node key.
The worker information.
Private getPrivate getPrivate handlePrivate handleProtected internalProtected Abstract isPrivate redistributeProtected Abstract registerRegisters a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
Private removeProtected Abstract sendProtected Abstract sendSends a message to worker given its worker node key.
The worker node key.
The message.
Private sendSets 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: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Protected setupPrivate shallPrivate startPrivate tasksPrivate updatePrivate updatePrivate updatePrivate updateProtected workerThis method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
This method is the listener registered for each worker message.
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.