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 emitterProtected Readonly maxMaximum number of workers that can be created by this pool.
-Readonly numberProtected Readonly numberNumber of workers that this pool should manage.
-Readonly optsProtected Readonly optsOptions for this fixed cluster pool.
-Protected promiseThe promise response map.
+Protected promiseThe 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.
-Protected workerProtected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonly workerReadonly workerPool worker nodes.
+Protected busyProtected fullWhether the pool is full or not.
+The pool filling boolean status.
+Protected maxPool maximum size.
+Protected minPool minimum size.
+Private readyPrivate numberPrivate startingNumber of tasks queued in the pool.
-Private numberProtected typeNumber of tasks running in the pool.
+Pool type.
+If it is 'dynamic', it provides the max property.
Private utilizationProtected 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 worker.
-The received message.
-Protected afterProtected afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
+Protected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker node key.
-The task to execute.
+Protected checkProtected chooseProtected createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Protected createProtected createProtected createProtected createProtected dequeueProtected destroyProtected enqueueProtected flushOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Protected flushOptional data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
+Promise that will be fulfilled when the task is completed.
+ +Protected internalProtected internalProtected isProtected isProtected sendSends a message to the given worker.
+The worker which should receive the message.
+Protected removeRemoves the given worker from the pool worker nodes.
+Sets the worker tasks queue options in this pool.
The worker.
-Protected sendThe worker tasks queue options.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Protected setupThe worker choice strategy options.
+Protected setupProtected tasksProtected workerProtected workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a 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.
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 and workers are busy, an event is emitted. If you want to listen to this event, use the pool's
+emitter.