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 fixed cluster pool.
Number of workers for this pool.
Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Options for this fixed cluster 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.Protected Readonly filePath to the worker file.
Protected Readonly numberNumber of workers that this pool should manage.
Protected Readonly optsOptions for this fixed cluster 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.
Readonly workerPool worker nodes.
Protected 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 maxPool maximum size.
Protected minPool minimum size.
Protected typePool type.
If it is 'dynamic', it provides the max property.
Protected workerGets the worker type.
Protected afterHook executed after the worker task execution. Can be overridden.
The worker.
The received message.
Protected afterProtected beforeHook executed before the worker task execution. Can be overridden.
The worker node key.
The task to execute.
Protected createProtected createProtected createProtected 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.
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 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.
Protected internalProtected isProtected 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.
Protected setupProtected 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
A cluster pool with a fixed number of workers.
Author
Christopher Quadflieg
Since
2.0.0