Constructs a new poolifier fixed cluster pool.
Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Optional opts: ClusterPoolOptions = {}Options for this fixed cluster pool.
Optional Readonly emitterReadonly fileOptional Readonly maxProtected nextId of the next message.
+Path to the worker file.
Readonly numberReadonly optsProtected 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.
Readonly tasksProtected 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 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 running in the pool.
+Protected afterHook 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 chooseProtected chooseChoose 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 createProtected decreaseDecrease the number of tasks that the given worker has applied.
+Returns a newly created worker.
Worker whose tasks are decreased.
-Protected destroyEnables/disables the worker tasks queue in this pool.
+Protected increaseIncrease the number of tasks that the given worker has applied.
+Executes the function specified in the worker constructor with the task data input parameter.
+ +Promise that will be fulfilled when the task is completed.
Worker whose tasks are increased.
+Optional data: DataThe task input data for the specified worker function. This can only be serializable data.
Protected internalProtected internalProtected internalProtected isProtected registerRegisters a listener callback on the given worker.
+The worker which should register a listener.
+The message listener callback.
+Protected removeProtected sendRemoves the given worker from the pool.
+Sends a message to the given worker.
Worker that will be removed.
+The worker which should receive the message.
+The message.
Protected sendSets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+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 data sent to the worker. This can only be serializable data.
+