Type of response of execution. This can only be serializable data.
-Type of execution response. This can only be serializable data.
+Constructs a new poolifier fixed thread pool.
Number of threads for this pool.
-Path to an implementation of a ThreadWorker file, which can be relative or absolute.
Options for this fixed thread pool.
-Optional Readonly emitter{@inheritDoc}
-Readonly filePath to the worker-file.
-Protected nextId of the next message.
-Readonly numberOptional 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.Protected Readonly filePath to the worker file.
+Protected Readonly numberNumber of workers that this pool should manage.
-Readonly optsProtected Readonly optsOptions for the 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.
-Protected workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Readonly workers{@inheritDoc}
-Readonly workers{@inheritDoc}
-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 workerPool worker nodes.
+Protected busy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Protected full{@inheritDoc}
+Whether the pool is full or not.
+The pool filling boolean status.
Protected max{@inheritDoc}
+Pool maximum size.
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 after{@inheritDoc}
+Function 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 beforeThe newly created worker.
+Protected 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 createProtected chooseCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Chooses a worker node for the next task.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Protected createThe worker node key
+ +Protected create{@inheritDoc}
+Creates a new worker and sets it up completely in the pool worker nodes.
New, completely set up worker.
+ +Protected create{@inheritDoc}
+Returns a newly created worker.
{@inheritDoc}
+Shutdowns every current worker in this pool.
Protected destroy{@inheritDoc}
+Shutdowns the given worker.
{@inheritDoc}
+A worker within workerNodes.
{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
{@inheritDoc}
+Whether to enable or disable the worker tasks queue.
Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+{@inheritDoc}
+Executes the specified function in the worker constructor with the task data input parameter.
Protected internalPromise that will be fulfilled when the task is completed.
+ +Protected internalProtected isProtected is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Protected register{@inheritDoc}
+Registers 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.
+Removes the given worker from the pool.
+Sets the worker tasks queue options in this pool.
The worker that will be removed.
-Protected sendThe worker tasks queue options.
+{@inheritDoc}
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+{@inheritDoc}
+Sets the worker choice strategy options in this pool.
Protected setupThe worker choice strategy options.
+Protected setupSetup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Protected 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 thread pool with a fixed number of threads.
It is possible to perform tasks in sync or asynchronous mode as you prefer.
This pool selects the threads in a round robin fashion.
+