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.
OptionalemitterPool event emitter integrated with async resource.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
Events that can currently be listened to:
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers set to zero, this event is emitted when the pool is started.'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'busyEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer executing concurrently their tasks quota.'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'fullEnd': Emitted when the pool is dynamic and the number of workers created has no longer reached the maximum size expected.'empty': Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.'destroy': Emitted when the pool is destroyed.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.'backPressure': Emitted when the number of workers created in the pool has reached the maximum size expected and are back pressured (i.e. their tasks queue is full: queue size >= maximum queue size).'backPressureEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer back pressured (i.e. their tasks queue is no longer full: queue size < maximum queue size).Protected ReadonlyfilePath to the worker file.
Protected Optional ReadonlymaximumMaximum number of workers that this pool manages.
Protected ReadonlyminimumMinimum number of workers that this pool manages.
Protected ReadonlyoptsOptions for the pool.
ProtectedpromiseThe task execution response promise map:
key: The message id of each submitted task.value: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
Protected OptionalworkerWorker choice strategies context referencing worker choice algorithms implementation.
Readonly InternalworkerPool worker nodes.
ProtectedbackWhether the pool is back pressured or not.
The pool back pressure boolean status.
ProtectedbusyWhether the pool is busy or not.
The pool busyness boolean status.
ProtectedtypeThe pool type.
If it is 'dynamic', it provides the max property.
ProtectedworkerThe worker type.
The name of the task function.
The task function.
true if the task function was added, false otherwise.
ProtectedafterHook executed after the worker task execution. Can be overridden.
The worker node key.
The received message.
ProtectedafterProtectedbeforeProtectedcheckProtectedcheckProtectedcreateProtectedcreateProtectedderegisterDeregisters a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
ProtecteddestroyOptionaltasksQueueOptions: TasksQueueOptionsOptionaldata: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
Optionalname: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
OptionaltransferList: readonly TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
Promise with a task function response that will be fulfilled when the task is completed.
ProtectedflagProtectedflushProtectedgetGets the worker information given its worker node key.
The worker node key.
The worker information.
ProtectedinternalProtectedinternalProtectedisThe properties of task functions available in this pool.
The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.
Optionalname: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
OptionaltransferList: readonly TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
Promise with an array of task function responses that will be fulfilled when the tasks are completed.
ProtectedregisterRegisters once a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
ProtectedregisterRegisters a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
ProtectedsendProtectedsendSends a message to worker given its worker node key.
The worker node key.
The message.
ProtectedsetupOptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
true if the worker choice strategy options were set, false otherwise.
ProtectedshallProtected ReadonlyworkerThis method is the message listener registered on each worker.
The message received from the worker.
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.Author
Christopher Quadflieg
Since
2.0.0