Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of response of execution. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable 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 emitterOptional 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.'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.Readonly filePath to the worker-file.
-Protected Readonly filePath to the worker file.
+Readonly maxProtected 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 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.
Private numberNumber of tasks queued in the pool.
+Pool information.
Private numberProtected maxPool maximum size.
+Protected minNumber of tasks running in the pool.
+Pool minimum size.
Protected typePool type.
If it is 'dynamic', it provides the max property.
Private utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Protected workerGets the worker type.
+Protected afterProtected afterHook executed after the worker task execution. Can be overridden.
@@ -280,40 +359,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 used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
The newly created worker.
-Protected beforeProtected beforeHook executed before the worker task execution. Can be overridden.
@@ -322,177 +406,292 @@ Can be overridden.The worker node key.
-The task to execute.
+Protected chooseProtected checkChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
-Protected createProtected createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+New, completely set up dynamic worker.
-New, completely set up worker.
+ +Protected createProtected createProtected createReturns a newly created worker.
+Creates a new worker.
Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+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.
+Executes the specified function in the worker constructor with the task data input parameter.
The input for the specified task. This can only be serializable 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 getFinds a free worker node key based on the number of tasks the worker has applied.
-If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1 is returned.
A worker node key if there is one, -1 otherwise.
Gets the worker information from the given worker.
+The worker.
The worker information.
+ +https://nodejs.org/api/errors.html#class-error If the worker is not found.
+Protected internalProtected getProtected internalProtected isProtected isProtected registerThe worker which should register a listener.
-The message listener callback.
Protected sendProtected sendProtected sendThe 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.
+Protected setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Sets the worker choice strategy options in this pool.
Protected 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.