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 emitter{@inheritDoc}
-Protected 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 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 workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Readonly workers{@inheritDoc}
-Readonly Internal 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.
{@inheritDoc}
+Pool information.
Private utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected workerThe worker type.
+Protected afterHook executed after the worker task promise resolution. +
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+The name of the task function.
+The task function.
+true if the task function was added, false otherwise.
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
Protected afterHook executed after the worker task execution. Can be overridden.
The worker.
-The worker node key.
+The received message.
-Protected afterProtected afterProtected beforeProtected beforeProtected chooseProtected createChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -[worker key, worker].
+Creates a new, completely set up dynamic worker node.
Protected createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Creates a new, completely set up worker node.
Protected create{@inheritDoc}
+Creates a new worker.
Protected deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+{@inheritDoc}
+Terminates all workers in this pool.
Protected destroyExecutes 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 flag{@inheritDoc}
+Protected flushProtected getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Protected internalProtected internalProtected isProtected is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Protected register{@inheritDoc}
+Registers once a listener callback on the worker given its worker node key.
The worker node key.
+The message listener callback.
+Protected registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected removeProtected sendProtected send{@inheritDoc}
+Protected sendProtected sendSends a message to worker given its worker node key.
+The message.
+{@inheritDoc}
+Sets the default task function in this pool.
true if the default task function was set, false otherwise.
Sets the worker node tasks queue options in this pool.
+The worker node tasks queue options.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Protected setup{@inheritDoc}
+Sets the worker choice strategy options in this pool.
This function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+Starts the minimum number of workers in this pool.
Protected workerThis 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 message listener registered on each worker.
Generated using TypeDoc
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, an event is emitted. If you want to listen to this event, use the pool's
- -emitter.Author
Christopher Quadflieg
+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'semitter. +Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0