0.0.1
Type of execution response. This can only be serializable data.
Constructs a new poolifier fixed thread pool.
Number of threads for this pool.
Path to an implementation of a ThreadWorker file, which can be relative or absolute.
Options for this fixed thread pool.
Optional 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 filePath to the worker-file.
+Protected Readonly filePath to the worker file.
Readonly numberProtected Readonly numberNumber of workers that this pool should manage.
Readonly optsProtected Readonly optsOptions for the pool.
Protected promiseThe execution response promise map.
key: The message id of each submitted task.Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Readonly workerPool worker nodes.
Protected busyWhether the pool is busy or not.
@@ -209,59 +215,81 @@Protected fullWhether the pool is full or not.
The pool filling boolean status.
Private numberNumber of tasks queued in the pool.
+Pool information.
+Protected maxPool maximum size.
Private numberProtected minNumber of tasks running in the pool.
+Pool minimum size.
Protected typePool type.
If it is 'dynamic', it provides the max property.
Protected workerGets the worker type.
+Protected afterHook executed after the worker task execution. Can be overridden.
@@ -270,21 +298,21 @@ Can be overridden.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.
The newly created worker.
Protected beforeProtected chooseChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Protected createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
Protected createReturns a newly created worker.
Protected destroyShutdowns the given worker.
A worker within workerNodes.
Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Enables/disables the worker tasks queue in this pool.
The input for the specified task. This can only be serializable data.
+Whether to enable or disable the worker tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Finds 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.
Executes the specified function in the worker constructor with the task data input parameter.
Protected internalProtected isProtected registerThe worker which should register a listener.
The message listener callback.
Protected 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: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Protected setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -530,35 +606,33 @@ Can be overriddenProtected 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
Type of data sent to the worker. This can only be serializable data.