Abstract Type of worker which manages this pool.
-Type of data sent to the worker. This can only be structured-cloneable data.
-Type of execution response. This can only be structured-cloneable data.
-Abstract Base class that implements some shared logic for all poolifier pools.
+Type of worker which manages this pool.
+Type of data sent to the worker. This can only be structured-cloneable data.
+Type of execution response. This can only be structured-cloneable data.
+Constructs a new poolifier pool.
-Minimum number of workers that this pool manages.
+Constructs a new poolifier pool.
+Minimum number of workers that this pool manages.
Path to the worker file.
-Options for the pool.
+Options for the pool.
Optional maximumNumberOfWorkers: numberMaximum number of workers that this pool manages.
-Private destroyingWhether the pool is destroying or not.
-Optional emitterEvent emitter integrated with async resource on which events can be listened to. +
Private destroyingWhether the pool is destroying or not.
+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:
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is 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.'empty': Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum 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 filePath to the worker file.
-Protected Optional Readonly maximumMaximum number of workers that this pool manages.
-Protected Readonly minimumMinimum number of workers that this pool manages.
-Protected Readonly optsOptions for the pool.
-Protected promiseThe task execution response promise map:
+Protected Readonly filePath to the worker file.
+Protected Optional Readonly maximumMaximum number of workers that this pool manages.
+Protected Readonly minimumMinimum number of workers that this pool manages.
+Protected Readonly optsOptions for the pool.
+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 readyWhether the pool ready event has been emitted or not.
-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:
+Private readyWhether the pool ready event has been emitted or not.
+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 workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Readonly Internal workerPool worker nodes.
-Protected Abstract busyWhether the pool is busy or not.
+Protected Optional workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Readonly Internal workerPool worker nodes.
+Protected Abstract busyWhether the pool is busy or not.
The pool busyness boolean status.
-Protected fullWhether the pool is full or not.
+Protected emptyThe pool emptiness boolean status.
+Protected fullWhether the pool is full or not.
The pool filling boolean status.
-Private readyThe pool readiness boolean status.
-Protected Abstract typeThe pool type.
+Private readyThe pool readiness boolean status.
+Protected Abstract typeThe pool type.
If it is 'dynamic', it provides the max property.
Private utilizationThe approximate pool utilization.
+Private utilizationThe approximate pool utilization.
The pool utilization.
-Protected Abstract workerThe worker type.
-Adds a task function to this pool. +
Protected Abstract workerThe 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.
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 node in the pool worker nodes.
-The worker node.
+Private addAdds the given worker node in the pool worker nodes.
+The worker node.
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.
The worker node key.
-The received message.
-Protected afterMethod hooked up after a worker node has been newly created. +
The received message.
+Protected afterProtected beforeProtected beforeHook executed before the worker task execution. Can be overridden.
The worker node key.
-The task to execute.
-Private buildProtected Abstract checkPrivate checkPrivate checkPrivate checkChecks if the worker id sent in the received message from a worker is valid.
-The received message.
+The task to execute.
+Private buildPrivate cannotProtected Abstract checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkChecks if the worker id sent in the received message from a worker is valid.
+The received message.
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
-Private checkPrivate checkPrivate checkPrivate checkPrivate choosePrivate checkPrivate checkPrivate checkPrivate checkPrivate chooseProtected createCreates a new, completely set up dynamic worker node.
+Protected createProtected createCreates a new, completely set up worker node.
+Protected createPrivate createCreates a worker node.
-The created worker node.
-Private deletePrivate dequeueProtected Abstract deregisterDeregisters a listener callback on the worker given its worker node key.
-The worker node key.
+Private createCreates a worker node.
+The created worker node.
+Private deletePrivate dequeueProtected Abstract deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
The message listener callback.
-Protected destroyTerminates the worker node given its worker node key.
+Protected destroyEnables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker node tasks queue.
Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Private enqueuePrivate enqueueExecutes the specified function in the worker constructor with the task data input parameter.
+Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
Optional name: stringThe 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 chosen 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 executeExecutes the given task on the worker given its worker node key.
+Optional transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen 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 executeExecutes the given task on the worker given its worker node key.
The worker node key.
-The task to execute.
-Protected flagProtected flushPrivate flushProtected getGets the worker information given its worker node key.
+The task to execute.
+Protected flagProtected flushPrivate flushProtected getGets the worker information given its worker node key.
The worker node key.
-The worker information.
-Private getThe worker information.
+Private getPrivate Readonly handlePrivate Readonly handleOptional previousStolenTask: Task<Data>Private handlePrivate handlePrivate handlePrivate hasWhether the specified task function exists in this pool.
+Private handlePrivate handlePrivate Readonly handlePrivate Readonly handleOptional previousStolenTask: Task<Data>Private handlePrivate hasPrivate initializeProtected internalWhether worker nodes are executing concurrently their tasks quota or not.
+Private initializeProtected internalProtected Abstract isPrivate isLists the names of task function available in this pool.
+Protected Abstract isPrivate isPrivate redistributeProtected Abstract registerRegisters once a listener callback on the worker given its worker node key.
-The worker node key.
+Private redistributeProtected Abstract registerRegisters once a listener callback on the worker given its worker node key.
+The worker node key.
The message listener callback.
-Protected Abstract registerRegisters a listener callback on the worker given its worker node key.
-The worker node key.
+Protected Abstract registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
The message listener callback.
-Removes a task function from this pool.
+Private removeRemoves the worker node from the pool worker nodes.
-The worker node.
-Private resetPrivate resetPrivate sendProtected Abstract sendtrue if the task function was removed, false otherwise.
Private removeRemoves the worker node from the pool worker nodes.
+The worker node.
+Private resetPrivate resetPrivate sendProtected Abstract sendPrivate sendPrivate sendPrivate sendPrivate sendProtected Abstract sendPrivate sendPrivate sendProtected Abstract sendSends a message to worker given its worker node key.
The worker node key.
-The message.
-Optional transferList: TransferListItem[]The optional array of transferable objects.
-Sets the default task function in this pool.
+The message.
+Optional transferList: TransferListItem[]The optional array of transferable objects.
+Private setSets the worker node tasks queue options in this pool.
-The worker node tasks queue options.
-Private setPrivate settrue if the default task function was set, false otherwise.
Private setSets the worker node tasks queue options in this pool.
+The worker node 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.
-Protected setupSets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Protected setupProtected Abstract shallProtected Abstract shallPrivate shallPrivate shallWhether the worker node shall update its task function worker usage or not.
+Private shallPrivate shallPrivate tasksPrivate unsetPrivate unsetPrivate updatePrivate updatePrivate updateProtected Readonly workerThis method is the message listener registered on each worker.
-Private Readonly workerGenerated using TypeDoc
Private tasksPrivate unsetPrivate unsetPrivate updatePrivate updatePrivate updateProtected Readonly workerThis method is the message listener registered on each worker.
+Private Readonly workerGenerated using TypeDoc
Base class that implements some shared logic for all poolifier pools.
-