Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of execution response. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+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 Readonly emitterOptional Readonly emitterEmitter 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.'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are 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.'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).Readonly fileProtected Readonly filePath to the worker file.
-Readonly numberProtected Optional Readonly maxDynamic pool maximum size property placeholder.
+Protected Readonly numberNumber of workers that this pool should manage.
-Readonly optsProtected Readonly optsOptions for this fixed cluster pool.
-Protected promiseThe execution response promise map.
+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 workerProtected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonly workerReadonly Internal workerPool worker nodes.
-Protected busyProtected busyWhether the pool is busy or not.
The pool busyness boolean status.
Protected fullProtected fullWhether the pool is full or not.
The pool filling boolean status.
Private numberNumber of tasks queued in the pool.
+Pool information.
Protected maxThe pool maximum size.
+Protected minThe pool minimum size.
+Private readyNumber of tasks running in the pool.
+The pool readiness boolean status.
Protected typePool type.
+The pool type.
If it is 'dynamic', it provides the max property.
Private utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected workerThe worker type.
+Protected afterProtected afterHook executed after the worker task execution. Can be overridden.
@@ -272,40 +363,45 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Protected afterProtected 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.
Method hooked up after a worker node has been newly created. +Can be overridden.
The newly created worker.
-Protected beforeProtected beforeThe task to execute.
+Protected chooseProtected checkChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
-Protected createProtected createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
+New, completely set up dynamic worker node key.
-New, completely set up worker.
+ +Protected createProtected createProtected createReturns a newly created worker.
+Creates a new worker.
Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Protected destroyEnables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Executes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+Executes the specified function in the worker constructor with the task data input parameter.
Optional data: DataThe task input data for the specified worker function. This can only be serializable data.
-Promise that will be fulfilled when the task is completed.
+ +Protected flushProtected getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Protected internalProtected internalProtected isProtected isProtected registerProtected registerRegisters a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
The worker which should register a listener.
-The worker node key.
+The message listener callback.
Protected sendProtected sendProtected sendProtected sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
-The worker node key.
+The message.
-Sets the worker tasks queue options in this pool.
+Sets the worker node 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 setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Protected workerProtected workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
+This method 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 message.
- -The listener function to execute when a message is received from a worker.
+This method is the listener registered for each worker message.
Generated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
A cluster pool with a fixed number of workers.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the workers in a round robin fashion.
- -Author
Christopher Quadflieg
+Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0