Readonly optsOptions for this fixed cluster pool.
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 workerReadonly workers{@inheritDoc}
-{@inheritDoc}
-Private numberNumber of tasks queued in the pool.
+Private number{@inheritDoc}
+Number of tasks running in the pool.
{@inheritDoc}
-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.
The Promise response.
+The received message.
Protected after{@inheritDoc}
-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}
-Protected internalProtected internalProtected is{@inheritDoc}
-Protected removeProtected send{@inheritDoc}
-Protected setupProtected 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.
Path to an implementation of a
ClusterWorkerfile, which can be relative or absolute.opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL
+opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
Returns DynamicClusterPool<Data, Response>
Properties
OptionalReadonlyemitter{@inheritDoc}
-Readonlyfile
+ProtectedReadonlymaxReadonlymaxMaximum number of workers that can be created by this pool.
-ProtectednextId of the next message.
-Readonlynumber