Protected promiseThe promise map.
+Protected promiseThe execution response promise map.
key: This is the message Id of each submitted task.value: An object that contains the worker, the resolve function and the reject function.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 and resolve/reject the promise based on the message.
+When 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 instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+ +Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Readonly workers{@inheritDoc}
+Readonly workerPool worker nodes.
Readonly workers{@inheritDoc}
-{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Whether the pool is full or not.
+The pool filling boolean status.
+Private numberNumber of tasks queued in the pool.
+Private number{@inheritDoc}
+Number of tasks running in the pool.
{@inheritDoc}
+Pool type.
+If it is 'dynamic', it provides the max property.
Protected afterProtected afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
+The worker.
Protected after{@inheritDoc}
+Function 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.
The newly created worker.
+Protected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
+The worker node key.
Protected chooseProtected chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
-Worker.
+[worker node key, worker node].
Protected createCreates a new worker for this pool and sets it up completely.
+Creates a new worker and sets it up completely in the pool worker nodes.
New, completely set up worker.
Protected create{@inheritDoc}
+Returns a newly created worker.
{@inheritDoc}
+Shutdowns every current worker in this pool.
{@inheritDoc}
+Performs the task specified in the constructor with the data parameter.
+ +Promise that will be resolved when the task is successfully completed.
{@inheritDoc}
+Finds a free worker node key based on the number of tasks the worker has applied.
+If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1 is returned.
A worker node key if there is one, -1 otherwise.
Protected internalProtected internalProtected is{@inheritDoc}
+Should return whether the worker is the main worker or not.
{@inheritDoc}
+Registers a listener callback on the given worker.
The worker which should register a listener.
+The message listener callback.
+Protected removeProtected send{@inheritDoc}
+Sends a message to the given worker.
The worker which should receive the message.
+The message.
+{@inheritDoc}
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+Protected setup{@inheritDoc}
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Protected workerThis function is the listener registered for each 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.
+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 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
+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.emitter.Author
Christopher Quadflieg
@@ -38,11 +38,11 @@ When the maximum number of workers is reached, an event is emitted. If you wantHierarchy
-- FixedClusterPool<Data, Response>
+
- FixedClusterPool<Data, Response>
- DynamicClusterPool
@@ -56,40 +56,36 @@ When the maximum number of workers is reached, an event is emitted. If you wantemitter?
file
Properties
Accessors
Methods
-constructor
-- new
+- new
-
Constructs a new poolifier dynamic cluster pool.
opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
Returns DynamicClusterPool<Data, Response>
Properties
OptionalReadonlyemitter{@inheritDoc}
+Emitter 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.Readonlyfile
+ProtectedReadonlymaxReadonlymaxMaximum number of workers that can be created by this pool.
-ProtectednextId of the next message.
-ReadonlynumberReadonlyopts