Constructs a new poolifier dynamic cluster pool.
Options for this dynamic cluster pool.
Optional Readonly emitterReadonly fileReadonly maxMaximum number of workers that can be created by this pool.
Readonly numberReadonly optsProtected promiseThe promise response map.
+ +The 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.
+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 context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Readonly workersReadonly workerPool worker nodes.
+Protected busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Protected fullWhether the pool is full or not.
+The pool filling boolean status.
+Private numberNumber of tasks queued in the pool.
+Private numberNumber of tasks concurrently running in the pool.
+Number of tasks running in the pool.
Protected afterProtected afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The worker.
The received message.
Protected afterFunction 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 key.
+The worker node key.
Protected chooseProtected chooseChooses a worker for the next task.
+Chooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
-[worker key, 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 createProtected destroyPerforms the task specified in the constructor with the data parameter.
+ +Promise that will be resolved when the task is successfully completed.
+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 isProtected registerRegisters a listener callback on the given worker.
+The worker which should register a listener.
+The message listener callback.
+Protected removeProtected sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+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
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
-- FixedClusterPool<Data, Response>
+
- FixedClusterPool<Data, Response>
- DynamicClusterPool
@@ -61,31 +61,31 @@ When the maximum number of workers is reached and workers are busy, an event is opts promise