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 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.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.Readonly filePath to the worker-file.
-Protected Readonly filePath to the worker file.
+Readonly numberProtected Readonly numberNumber of workers that this pool should manage.
-Readonly optsProtected Readonly optsOptions for the pool.
-Protected promiseProtected 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 workerProtected workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
-Readonly workerReadonly 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.
Private numberProtected maxNumber of tasks running in the pool.
+Pool 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 execution. Can be overridden.
@@ -270,21 +319,24 @@ Can be overridden.The worker.
-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.
The newly created worker.
-Protected beforeProtected beforeHook executed before the worker task execution. Can be overridden.
@@ -312,66 +366,70 @@ Can be overridden.The worker node key.
-Protected chooseProtected chooseChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Protected createProtected createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
Protected createProtected createReturns a newly created worker.
Protected destroyProtected destroyShutdowns the given worker.
A worker within workerNodes.
Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Enables/disables the worker tasks queue in this pool.
The input for the specified task. This can only be serializable data.
-Whether to enable or disable the worker tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+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.
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.
+Optional name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Promise that will be fulfilled when the task is completed.
+ + -Protected internalProtected internalProtected isProtected isProtected registerProtected registerThe worker which should register a listener.
-The message listener callback.
Protected sendProtected sendSends a message to the given worker.
The 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 setupSets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Protected setupProtected workerProtected workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a 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.
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.
+