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 busyProtected fullWhether the pool is full or not.
+The pool filling boolean status.
+Protected maxPool maximum size.
+Protected minPool minimum size.
+Private runGets the pool run time.
+The pool run time in milliseconds.
+ +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 promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
-The worker.
+The Promise response.
-Protected afterThe 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 overridden.
+Protected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-Protected chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+The worker node key.
Protected createThe task to execute.
+Protected createCreates a new worker for this pool and sets it up completely.
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+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 createProtected destroyTerminates the given worker.
+Enables/disables the worker tasks queue in this pool.
+Initializes tasks usage statistics.
+Whether to enable or disable the worker tasks queue.
The worker.
-Protected internalOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+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.
+Protected internalPromise that will be fulfilled when the task is completed.
+ +Protected internalProtected isProtected isProtected sendSends a message to the given worker.
+The worker which should receive the message.
+Protected removeThe message.
+Removes 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.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+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, 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.
- -Author
Alessandro Pio Ardizio
+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
+Since
0.0.1