Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable 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 emitter{@inheritDoc}
+ +Emitter 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 error occurs.Readonly filePath to the worker-file.
+Path to the worker file.
Readonly numberNumber of workers that this pool should manage.
Readonly optsOptions for this fixed cluster pool.
Protected promiseThe promise response map.
+ +The execution response promise map.
key: The message id of each submitted task.value: An object that contains the worker, the promise resolve and reject callbacks.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.
+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 instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+ +Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Readonly workers{@inheritDoc}
+Readonly workerPool worker nodes.
Protected busy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Protected full{@inheritDoc}
+Whether the pool is full or not.
+The pool filling boolean status.
Private numberNumber of tasks queued in the pool.
+Private numberNumber of tasks concurrently running.
+Number of tasks running in the pool.
Pool maximum size.
+{@inheritDoc}
+Pool type.
+If it is 'dynamic', it provides the max property.
Protected afterProtected afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The worker.
The received message.
Protected after{@inheritDoc}
+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 maxListeners or binding the main-worker<->worker connection if not bind by default.
The newly created worker.
+Protected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker key.
+The worker node key.
Protected chooseProtected chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -[worker key, worker].
+Chooses a worker node for the next task.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Protected createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Creates a new worker and sets it up completely in the pool worker nodes.
Protected create{@inheritDoc}
+Returns a newly created worker.
{@inheritDoc}
+Shutdowns every current worker in this pool.
Protected destroy{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+{@inheritDoc}
+Executes the specified function in the worker constructor with the task data input parameter.
Protected internalProtected is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Protected register{@inheritDoc}
+Registers a listener callback on the given worker.
The worker which should register a listener.
+The message listener callback.
+Protected removeProtected sendRemoves the given worker from the pool.
+Sends a message to the given worker.
The worker that will be removed.
+The worker which should receive the message.
+The message.
Protected send{@inheritDoc}
+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.
+{@inheritDoc}
+Sets the worker choice strategy options in this pool.
The worker choice strategy options.
+Protected setup{@inheritDoc}
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Protected workerThis function is the listener registered for each 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.
+This function is the listener registered for each 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.
+Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.