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 dynamic thread pool.
Minimum number of threads which are always active.
-Maximum number of threads that can be created by this pool.
-Path to an implementation of a ThreadWorker file, which can be relative or absolute.
Options for this dynamic 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 fileProtected Readonly filePath to the worker file.
-Readonly maxProtected Readonly maxMaximum number of threads that can be created by this pool.
-Readonly numberProtected Readonly numberNumber of workers that this pool should manage.
-Readonly optsOptions for the pool.
-Protected Readonly optsOptions for this fixed thread 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.
Private utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Protected workerGets the worker type.
+Protected afterProtected afterHook executed after the worker task execution. Can be overridden.
@@ -283,40 +343,45 @@ 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.
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
The newly created worker.
-Protected beforeProtected beforeHook executed before the worker task execution. Can be overridden.
@@ -325,84 +390,95 @@ Can be overridden.The worker node key.
-The task to execute.
+Protected chooseProtected createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Protected createNew, completely set up dynamic worker.
+ +Protected 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.
+Creates a new worker.
Shutdowns every current worker in this pool.
+Terminates every current worker in this pool.
Protected destroyShutdowns the given worker.
+Terminates the given worker.
A worker within workerNodes.
Optional tasksQueueOptions: TasksQueueOptionsOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Executes the function specified in the constructor with the task data input parameter.
- -Promise that will be resolved when the task is successfully completed.
+Executes the specified function in the worker constructor with the task data input parameter.
The task input data for the specified function. This can only be serializable data.
-Promise that will be fulfilled when the task is completed.
+ +Protected internalFinds 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.
Whether worker nodes are executing at least one task.
Protected internalProtected isProtected isProtected registerRegisters a listener callback on the given worker.
-The 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: WorkerChoiceStrategyOptionsOptional 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 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 dynamic number of threads, but a guaranteed minimum number of threads.
This thread pool creates new threads when the others are busy, up to the maximum number of threads. When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's
+emitter.