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.
Optional opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}Options for this dynamic thread pool.
Optional Readonly emitterReadonly fileProtected Readonly filePath to the worker file.
+Readonly maxProtected nextId of the next message.
+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 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.
+When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
Readonly tasksInherited from FixedThreadPool.promiseResponseMap
+Protected workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Readonly workersReadonly workerPool worker nodes.
+Protected busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Protected fullProtected afterPool information.
+Protected maxProtected chooseProtected minChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Pool minimum size.
Protected typeCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Pool type.
+If it is 'dynamic', it provides the max property.
Protected workerProtected decreaseProtected afterDecrease the number of tasks that the given worker has applied.
+Hook executed after the worker task execution. +Can be overridden.
Worker whose tasks are decreased.
+The worker.
+The received message.
Protected 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.
Protected beforeProtected chooseProtected createCreates a new worker and sets it up completely in the pool worker nodes.
+New, completely set up worker.
+Protected createProtected destroyShutdowns the given worker.
+Protected increaseA worker within workerNodes.
Increase the number of tasks that the given worker has applied.
+Enables/disables the worker tasks queue in this pool.
Worker whose tasks are increased.
+Whether to enable or disable the worker tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Protected internalExecutes 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.
+Protected internalPromise that will be fulfilled when the task is completed.
+ +Protected internalProtected isProtected registerThe worker which should register a listener.
+The message listener callback.
+Protected removeProtected sendRemoves the given worker from the pool.
+Sends a message to the given worker.
Worker that will be removed.
+The worker which should receive the message.
+The message.
Protected sendSets 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.
+Sets the worker choice strategy options in this pool.
+The 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 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, an event is emitted. If you want to listen to this event, use the pool's
- -emitter.Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
+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'semitter.Author
Alessandro Pio Ardizio
Since
0.0.1