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 emitterEmitter on which events can be listened to.
+Optional emitterEvent emitter integrated with async resource on which events can be listened to.
+The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
Events that can currently be listened to:
'full': Emitted when the pool is dynamic and full.'busy': Emitted when the pool is busy.'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'destroy': Emitted when the pool is destroyed.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected Readonly fileProtected Readonly filePath to the worker file.
-Protected Optional Readonly maxDynamic pool maximum size property placeholder.
+Protected Readonly numberProtected Readonly numberNumber of workers that this pool should manage.
-Protected Readonly optsProtected Readonly optsOptions for the pool.
-Protected promiseThe execution response promise map.
+Protected promiseThe task execution response promise map:
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 with the promise resolve/reject bound to the message id.
-Private Readonly startThe start timestamp of the pool.
+Private startedWhether the pool is started or not.
+Private startingWhether the pool is starting or not.
+Private Readonly taskThe task functions added at runtime map:
+key: The task function name.value: The task function itself.Protected workerProtected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonly workerReadonly Internal workerPool worker nodes.
-Protected Abstract busyProtected Abstract busyWhether the pool is busy or not.
The pool busyness boolean status.
Protected fullProtected fullWhether the pool is full or not.
The pool filling boolean status.
Protected Abstract maxProtected maxPool maximum size.
+The pool maximum size.
Protected Abstract minProtected minPool minimum size.
+The pool minimum size.
Private readyThe pool readiness boolean status.
+Protected Abstract typeProtected Abstract typePool type.
+The pool type.
If it is 'dynamic', it provides the max property.
Protected Abstract workerProtected Abstract workerGets the worker type.
+The worker type.
Adds 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.
Private addAdds the given worker in the pool worker nodes.
+The worker.
+The added worker node key.
+ +https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
+Protected afterProtected afterHook executed after the worker task execution. Can be overridden.
@@ -310,38 +496,43 @@ Can be overridden.The worker.
-The worker node key.
+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.
Method hooked up after a worker node has been newly created. +Can be overridden.
The newly created worker.
-Protected beforeProtected beforeThe task to execute.
+Private buildPrivate buildPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkChecks if the worker id sent in the received message from a worker is valid.
+https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+Private checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkProtected choosePrivate chooseProtected createProtected createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
New, completely set up worker.
- +Protected createProtected Abstract createProtected Abstract createReturns a newly created worker.
+Creates a new worker.
Private deletePrivate dequeuePrivate dequeueProtected Abstract deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Protected Abstract destroyEnables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Private enqueuePrivate enqueueExecutes 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.
-The optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
-The 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.
-Private executePrivate executeExecutes the given task on the worker given its worker node key.
+The worker node key.
+Private flushProtected flushPrivate flushPrivate flushPrivate getProtected getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Private getGets the given worker its worker node key.
The worker.
-The worker node key if the worker is found in the pool worker nodes, -1 otherwise.
Private getPrivate Readonly handlePrivate Readonly handlePrivate handlePrivate handlePrivate hasPrivate initializeProtected internalProtected internalProtected Abstract isProtected Abstract isPrivate pushPrivate redistributePushes the given worker in the pool worker nodes.
+Protected Abstract registerRegisters once a listener callback on the worker given its worker node key.
The worker.
-The worker nodes length.
-The message listener callback.
+Protected Abstract registerProtected Abstract registerRegisters a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
The worker which should register a listener.
-The worker node key.
+The message listener callback.
Private removePrivate removeRemoves the given worker from the pool worker nodes.
The worker.
-Protected sendProtected Abstract sendPrivate sendPrivate sendPrivate sendProtected Abstract sendProtected Abstract sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
-The worker node key.
+The message.
-Optional transferList: TransferListItem[]The optional array of transferable objects.
+Private setSets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
-Private setPrivate setSets 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 setProtected setupPrivate shallPrivate shallSets the given worker in the pool worker nodes.
+Private shallWhether the worker node shall update its task function worker usage or not.
The worker node key.
-The worker.
-The worker tasks usage.
-true if the worker node shall update its task function worker usage, false otherwise.
Private tasksPrivate unsetPrivate setPrivate unsetPrivate updateSets the given worker node its tasks usage in the pool.
-The worker node.
-The worker node tasks usage.
-Protected setupPrivate updateSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
-Private tasksPrivate updatePrivate 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.
- -This function is the listener registered for each worker message.
+This method is the message listener registered on each worker.
The listener function to execute when a message is received from a worker.
-Generated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
Base class that implements some shared logic for all poolifier pools.
-