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 promiseProtected 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 workerProtected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonly workerReadonly workerPool worker nodes.
+Protected busyProtected fullPrivate numberWhether the pool is full or not.
+The pool filling boolean status.
+Number of tasks queued in the pool.
+Pool information.
Private numberProtected maxNumber of tasks running in the pool.
+Pool maximum size.
Protected minProtected typePool type.
+If it is 'dynamic', it provides the max property.
Protected workerGets the worker type.
+Protected afterProtected afterHook executed after the worker task execution. Can be overridden.
@@ -272,37 +329,45 @@ 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 execution. Can be overridden.
@@ -311,236 +376,303 @@ Can be overridden.The worker node key.
-The task to execute.
+Protected 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 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 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 internalProtected isProtected 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.
+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 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.