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 dynamic cluster pool.
Minimum number of workers which are always active.
-Maximum number of workers that can be created by this pool.
-Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Options for this dynamic cluster pool.
-Optional Readonly emitter{@inheritDoc}
-Protected Readonly maxMaximum number of workers that can be created by this pool.
-Protected nextId of the next message.
-Readonly numberProtected Readonly numberNumber of workers that this pool should manage.
-Readonly optsProtected Readonly optsOptions for this fixed cluster pool.
-Protected promiseThe promise map.
+Protected promiseThe execution response promise map.
key: This is the message Id of each submitted task.value: An object that contains the worker, the resolve function and the reject function.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 and resolve/reject the promise based on the message.
-Protected workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
+Readonly workers{@inheritDoc}
-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.
Protected maxPool maximum size.
+Protected min{@inheritDoc}
+Pool minimum size.
Protected workerGets the worker type.
+Protected afterProtected afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
-The worker.
+The Promise response.
-Protected afterThe 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.
Protected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-Protected chooseProtected chooseCreates a new worker for this pool and sets it up completely.
+Chooses a worker node for the next task.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
+The worker node key
-New, completely set up worker.
+ +Protected createProtected createProtected 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.
{@inheritDoc}
+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.
{@inheritDoc}
+Optional data: DataThe task input data for the specified worker function. This can only be serializable data.
Protected internalPromise that will be fulfilled when the task is completed.
+ +Protected internalProtected isProtected 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 sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Removes the given worker from the pool.
+Sets the worker tasks queue options in this pool.
The worker that will be removed.
-Protected sendThe worker tasks queue options.
+{@inheritDoc}
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+{@inheritDoc}
+Sets the worker choice strategy options in this pool.
Protected setupThe 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
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's
- -emitter.Author
Christopher Quadflieg
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter. +Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0