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 emitterReadonly fileOptional Readonly maxProtected nextId of the next message.
-Readonly numberReadonly optsProtected promiseThe 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.Optional 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.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
-Protected workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Readonly workersProtected Readonly filePath to the worker file.
+Protected Readonly numberNumber of workers that this pool should manage.
+Readonly workersProtected Readonly optsOptions for this fixed cluster pool.
+Protected promiseThe 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 workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Readonly workerPool worker nodes.
+Protected busyProtected fullWhether the pool is full or not.
+The pool filling boolean status.
+Protected maxPool maximum size.
+Protected minPool minimum size.
+Protected typePool type.
+If it is 'dynamic', it provides the max property.
Protected workerGets the worker type.
+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.
-Protected afterThe 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.
Protected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-Protected chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+The worker node key.
Protected createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+ +The task to execute.
Protected createProtected createProtected createProtected createProtected destroyInitializes tasks usage statistics.
+Whether to enable or disable the worker tasks queue.
The worker.
-Protected internalOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+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.
+Protected internalPromise that will be fulfilled when the task is completed.
+ +Protected internalProtected isProtected isProtected registerThe 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.
The worker that will be removed.
-Protected sendThe worker which should receive the message.
+The message.
+Sets 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.
+Protected setupThe worker choice strategy options.
+Protected setupProtected workerProtected workerThis function is the listener registered for each worker.
- -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 function is the listener registered for each worker.
- -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.
+ +Generated using TypeDoc
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.
- -Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
- -Author
Christopher Quadflieg
+Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0