Abstract Type of worker which manages this pool.
Type of data sent to the worker. This can only be serializable data.
Type of execution response. This can only be serializable 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 full.'busy': Emitted when the pool is busy.Readonly filePath to the worker file.
Readonly numberNumber of workers that this pool should manage.
Readonly optsOptions for the pool.
Protected promiseThe 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.
Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Readonly workerPool worker nodes.
Protected Abstract busyWhether the pool is busy or not.
The pool busyness boolean status.
Protected Abstract fullWhether the pool is full or not.
The pool filling boolean status.
Private numberNumber of tasks queued in the pool.
Private numberNumber of tasks running in the pool.
Abstract sizePool maximum size.
Abstract typeProtected afterHook executed after the worker task execution. 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.
The newly created worker.
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].
Protected 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 serializable 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 executePrivate flushPrivate flushPrivate getProtected internalProtected Abstract isPrivate pushProtected Abstract registerRegisters a listener callback on the given worker.
The worker which should register a listener.
The message listener callback.
Private removeProtected 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: 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 node key.
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 tasksProtected workerThis function is the listener registered for each worker message.
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.
Generated using TypeDoc
Base class that implements some shared logic for all poolifier pools.