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 emitterReadonly filePath to the worker-file.
-Readonly numberOptional 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.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.Protected Readonly filePath to the worker file.
+Protected 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 workerWhen 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 context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
-Readonly workersReadonly workerPool worker nodes.
+Protected busyProtected fullPrivate numberWhether the pool is full or not.
+The pool filling boolean status.
+Number of tasks concurrently running in the pool.
+Pool information.
Protected maxProtected minPool minimum size.
+Protected typePool type.
+If it is 'dynamic', it provides the max property.
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 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.
Protected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker key.
-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 createProtected destroyWhether to enable or disable the worker tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Protected internalExecutes the specified function in the worker constructor with the task data input parameter.
+Optional data: DataThe task input data for the specified worker function. 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 internalProtected isProtected isProtected registerThe 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.
-Protected sendThe worker which should receive the message.
+The message.
+Sets the worker tasks queue options in this pool.
+The worker tasks queue options.
+The worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Protected setupThe worker choice strategy options.
+Protected setupProtected workerProtected 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 fixed number of workers.
It is possible to perform tasks in sync or asynchronous mode as you prefer.
This pool selects the workers in a round robin fashion.
+