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 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 emitter{@inheritDoc}
-Readonly 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 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.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 task 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 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.
Private numberNumber of tasks concurrently running in the pool.
+Pool information.
Protected maxThe pool maximum size.
+Protected minThe pool minimum size.
+Private readyThe pool readiness boolean status.
+Protected type{@inheritDoc}
+The pool type.
+If it is 'dynamic', it provides the max property.
Private utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected workerThe 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 worker node key.
+The received message.
-Protected afterProtected afterProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker key.
-The worker node key.
+The task to execute.
+Protected checkProtected chooseProtected createChooses a worker for the next task.
-The default uses a round robin algorithm to distribute the load.
+Creates a new, completely set up dynamic worker node.
+New, completely set up dynamic worker node key.
-[worker key, worker].
+ +Protected createProtected createProtected createCreates a new worker for this pool and sets it up completely.
+Creates a new worker.
+Newly created worker.
-New, completely set up worker.
+ +Protected createProtected destroy{@inheritDoc}
+Terminates the worker node given its worker node key.
{@inheritDoc}
+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.
+{@inheritDoc}
+Executes the specified function in the worker constructor with the task data input parameter.
Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+Promise that will be fulfilled when the task is completed.
+ +Protected flushProtected get{@inheritDoc}
+Gets the worker information given its worker node key.
The worker information.
+ +Protected internal{@inheritDoc}
+Whether worker nodes are executing concurrently their tasks quota or not.
Protected internalProtected isProtected is{@inheritDoc}
+Lists the names of task function available in this pool.
Protected register{@inheritDoc}
+Registers a listener callback on the worker given its worker node key.
The worker node key.
+The message listener callback.
+Protected removeProtected sendProtected sendProtected send{@inheritDoc}
+Sends a message to worker given its worker node key.
The worker node key.
+The message.
+{@inheritDoc}
+Sets the worker tasks queue options in this pool.
Protected setupThe worker tasks queue options.
+{@inheritDoc}
+Sets the worker choice strategy in this pool.
Protected workerThe worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+This function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
Protected setupProtected workerThis method 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 method 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.
- -Author
Christopher Quadflieg
+Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0