Abstract Type of worker which manages this pool.
-Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of execution response. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Constructs a new poolifier pool.
Number of workers that this pool should manage.
-Path to the worker file.
-Options for the pool.
-Optional Readonly emitterOptional 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 fileProtected 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 promiseProtected promiseThe execution response promise map.
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 id.
-Private Readonly startThe start timestamp of the pool.
+Protected workerProtected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonly workerReadonly workerPool worker nodes.
-Protected Abstract busyProtected Abstract busyWhether the pool is busy or not.
The pool busyness boolean status.
Protected Abstract fullProtected fullWhether the pool is full or not.
The pool filling boolean status.
Private numberNumber of tasks queued in the pool.
+Pool information.
Protected Abstract maxPool maximum size.
+Protected Abstract minPool minimum size.
+Private runNumber of tasks running in the pool.
+Gets the pool run time.
Protected Abstract typePool type.
If it is 'dynamic', it provides the max property.
Private utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Protected Abstract workerGets the worker type.
+Protected afterProtected afterHook executed after the worker task execution. Can be overridden.
@@ -288,21 +378,24 @@ Can be overridden.The worker.
-The received message.
-Protected Abstract afterProtected 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.
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
The newly created worker.
-Protected beforeProtected beforeHook executed before the worker task execution. Can be overridden.
@@ -328,14 +423,21 @@ Can be overridden.The worker node key.
-The task to execute.
+Private buildPrivate buildPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkProtected choosePrivate checkPrivate chooseChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
+The default worker choice strategy uses a round robin algorithm to distribute the tasks.
+The worker node key
-[worker node key, worker node].
+Protected createCreates a new dynamic worker and sets it up completely in the pool worker nodes.
Protected createProtected createProtected Abstract createProtected Abstract createReturns a newly created worker.
+Creates a new worker.
Private dequeuePrivate dequeueOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Private enqueuePrivate enqueueExecutes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+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 serializable data.
-Promise that will be fulfilled when the task is completed.
+ +Private executePrivate executeFinds 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.
Private flushPrivate flushPrivate flushPrivate flushPrivate getGet the worker given its id.
+The worker if found in the pool worker nodes, undefined otherwise.
Private flushPrivate getPrivate getPrivate getGets the given worker its worker node key.
- -The worker node key if the worker is found in the pool worker nodes, -1 otherwise.
The worker.
-The worker node key if found in the pool worker nodes, -1 otherwise.
Private getPrivate getGets the given worker its tasks usage in the pool.
- -Error if the worker is not found in the pool worker nodes.
- -The worker tasks usage.
-The worker.
-Private handlePrivate handleProtected internalProtected internalProtected Abstract isProtected Abstract isPrivate pushPrivate pushPushes the given worker in the pool worker nodes.
- -The worker nodes length.
The worker.
-The worker nodes length.
+ +Protected Abstract registerPrivate registerRegisters a listener callback on the given worker.
The worker which should register a listener.
-The message listener callback.
Private removePrivate removeRemoves the given worker from the pool worker nodes.
The worker.
-Protected Abstract sendProtected Abstract 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.
-Private setPrivate setSets the given worker in the pool worker nodes.
+Sets the given worker node its tasks usage in the pool.
The worker node key.
-The worker.
-The worker tasks usage.
-The worker node.
+The worker task queue.
-Private setPrivate setSets the given worker node its tasks usage in the pool.
-The worker node.
-The worker node tasks usage.
-Protected setupProtected setupPrivate shallSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Conditions for dynamic worker creation.
Private tasksPrivate tasksPrivate updatePrivate updatePrivate updatePrivate updateProtected workerProtected 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.
Generated using TypeDoc
Base class that implements some shared logic for all poolifier pools.
-