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 emitter{@inheritDoc}
-Protected 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 promiseThe promise response map.
+Protected promiseThe execution response promise map.
key: The message id of each submitted task.value: An object that contains the worker, the promise resolve and reject callbacks.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.
-Protected workerProtected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonly workers{@inheritDoc}
-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 maxPool maximum size.
+Protected minPool minimum size.
+Private readyPrivate numberPrivate startingNumber of tasks concurrently running in the pool.
-Protected type{@inheritDoc}
+Pool 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 promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The worker.
-The received message.
-Protected afterProtected after{@inheritDoc}
+Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
Protected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker key.
-The worker node key.
+The task to execute.
+Protected checkProtected chooseProtected createChooses a worker for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker key, worker].
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Protected createCreates a new worker for this pool and sets it up completely.
+New, completely set up dynamic worker.
-New, completely set up worker.
+ +Protected createCreates a new worker and sets it up completely in the pool worker nodes.
Protected createProtected create{@inheritDoc}
+Creates a new worker.
{@inheritDoc}
+Terminates every current worker in this pool.
Protected destroy{@inheritDoc}
+Terminates the given worker.
{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
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.
+Optional data: DataThe task input data for the specified worker function. This can only be structured-cloneable 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 is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Protected send{@inheritDoc}
+Sends a message to the given worker.
The worker which should receive the message.
+Protected removeRemoves 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.
+{@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 nodes are created in the abstract constructor. +Can be overridden.
Protected 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 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.