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 maximumNumberOfWorkers: numberOptional emitterPool 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 is set to zero, this event is emitted when at least one dynamic worker is ready.'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'full': Emitted when the pool is dynamic and the number of workers created has 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 all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected Readonly filePath to the worker file.
Protected Optional Readonly maximumMaximum number of workers that this pool manages.
Protected Readonly minimumMinimum number of workers that this pool manages.
Protected Readonly optsOptions for the pool.
Protected promiseThe task 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 Optional workerWorker choice strategy context referencing a worker choice algorithm implementation.
Readonly Internal workerPool worker nodes.
Protected busyWhether the pool is busy or not.
The pool busyness boolean status.
Protected emptyThe pool emptiness boolean status.
Protected fullWhether the pool is full or not.
The pool filling boolean status.
Private readyThe pool readiness boolean status.
Protected typeThe pool type.
If it is 'dynamic', it provides the max property.
Private utilizationThe approximate pool utilization.
The pool utilization.
Protected workerThe worker type.
Protected afterHook executed after the worker task execution. Can be overridden.
The worker node key.
The received message.
Protected afterProtected beforeProtected checkProtected createProtected createProtected deregisterDeregisters a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
Protected destroyOptional tasksQueueOptions: TasksQueueOptionsProtected flagProtected flushProtected getGets the worker information given its worker node key.
The worker node key.
The worker information.
Protected internalProtected isProtected registerRegisters 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 sendProtected sendSends a message to worker given its worker node key.
The worker node key.
The message.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsProtected setupProtected shallProtected Readonly workerThis method is the message listener registered on each worker.
Generated using TypeDoc
A cluster pool with a fixed number of workers.
Author
Christopher Quadflieg
Since
2.0.0