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 emitterProtected 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 task 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 workersReadonly Internal workerPool worker nodes.
+Protected busyProtected fullPrivate numberNumber of tasks concurrently running in the pool.
+Pool information.
Protected maxProtected minThe pool minimum size.
+Private readyThe pool readiness boolean status.
+Protected typeThe pool type.
+If it is 'dynamic', it provides the max property.
Private utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected workerThe worker type.
+Protected afterAdds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+The name of the task function.
+The task function.
+true if the task function was added, false otherwise.
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
Protected afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The worker.
-The worker node key.
+The received message.
-Protected afterProtected afterMethod hooked up after a worker node has been newly created. +Can be overridden.
+Protected beforeProtected beforeProtected 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, completely set up dynamic worker node.
Protected createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Creates a new, completely set up worker node.
Protected createProtected deregisterProtected destroyTerminates the worker node given its worker node key.
+Enables/disables the worker node tasks queue in this pool.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Executes the specified function in the worker constructor with the task data input parameter.
+Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+Promise that will be fulfilled when the task is completed.
+ +Protected flushProtected getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Protected internalProtected internalProtected isProtected isProtected registerThe worker node key.
+The message listener callback.
+Protected registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected removeRemoves the given worker from the pool.
+Removes a task function from this pool.
The worker that will be removed.
-true if the task function was removed, false otherwise.
Protected sendProtected sendProtected sendSends the startup message to worker given its worker node key.
+Protected sendSends a message to worker given its worker node key.
+The worker node key.
+The message.
+Optional transferList: TransferListItem[]The optional array of transferable objects.
+Sets the default task function in this pool.
+true if the default task function was set, false otherwise.
Sets the worker node tasks queue options in this pool.
+The worker node tasks queue options.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe 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. -Can be overridden
+Sets the worker choice strategy options in this pool.
This function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+Starts the minimum number of workers in this pool.
Protected workerThis function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+This method is the message listener registered on each worker.
Generated using TypeDoc
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.