Event 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:
@@ -120,142 +121,143 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
'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).
Executes the specified function in the worker constructor with the task data input parameter.
Parameters
Optionaldata: Data
The optional task input data for the specified task function. This can only be structured-cloneable data.
Optionalname: string
The optional name of the task function to execute. If not specified, the default task function will be executed.
OptionaltransferList: 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.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
-
PrivateexecuteTask
executeTask(workerNodeKey, task): void
Executes the given task on the worker given its worker node key.
+
PrivateexecuteTask
executeTask(workerNodeKey, task): void
Executes the given task on the worker given its worker node key.
Base class that implements some shared logic for all poolifier pools.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.12Class AbstractPool<Worker, Data, Response>
AbstractBase class that implements some shared logic for all poolifier pools.
Type Parameters
Worker extends IWorker
Type of worker which manages this pool.
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
Type of execution response. This can only be structured-cloneable data.
-Hierarchy
Implements
Index
Constructors
Hierarchy
Implements
Index
Constructors
Properties
filePath: string
Path to the worker file.
opts: PoolOptions<Worker>
Options for the pool.
OptionalmaximumNumberOfWorkers: numberMaximum number of workers that this pool manages.
-Returns AbstractPool<Worker, Data, Response>
Properties
PrivatedestroyingWhether the pool is destroying or not.
-OptionalemitterEvent emitter integrated with async resource on which events can be listened to. +
Returns AbstractPool<Worker, Data, Response>
Properties
PrivatedestroyingWhether the pool is destroying or not.
+OptionalemitterEvent 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:
@@ -120,142 +121,143 @@ The async tracking tooling identifier is
-poolifier:<PoolType>-<Wo'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).ProtectedReadonlyfilePath to the worker file.
-ProtectedOptionalReadonlymaximumMaximum number of workers that this pool manages.
-ProtectedReadonlyminimumMinimum number of workers that this pool manages.
-ProtectedReadonlyoptsOptions for the pool.
-ProtectedpromiseThe task execution response promise map:
+ProtectedReadonlyfilePath to the worker file.
+ProtectedOptionalReadonlymaximumMaximum number of workers that this pool manages.
+ProtectedReadonlyminimumMinimum number of workers that this pool manages.
+ProtectedReadonlyoptsOptions for the pool.
+ProtectedpromiseThe 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.
-PrivatereadyWhether the pool ready event has been emitted or not.
-PrivateReadonlystartThe start timestamp of the pool.
-PrivatestartedWhether the pool is started or not.
-PrivatestartingWhether the pool is starting or not.
-PrivateReadonlytaskThe task functions added at runtime map:
+PrivatereadyWhether the pool ready event has been emitted or not.
+PrivateReadonlystartThe start timestamp of the pool.
+PrivatestartedWhether the pool is started or not.
+PrivatestartingWhether the pool is starting or not.
+PrivateReadonlytaskThe task functions added at runtime map:
-key: The task function name.value: The task function itself.ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-ReadonlyInternalworkerPool worker nodes.
-Accessors
ProtectedAbstractbusyWhether the pool is busy or not.
+ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
+ReadonlyInternalworkerPool worker nodes.
+Accessors
ProtectedAbstractbusyWhether the pool is busy or not.
The pool busyness boolean status.
-Returns boolean
ProtectedfullWhether the pool is full or not.
+Returns boolean
ProtectedfullWhether the pool is full or not.
The pool filling boolean status.
-Returns boolean
info
Pool information.
-Returns PoolInfo
PrivatereadyThe pool readiness boolean status.
-Returns boolean
ProtectedAbstracttypeThe pool type.
+Returns boolean
info
Pool information.
+Returns PoolInfo
PrivatereadyThe pool readiness boolean status.
+Returns boolean
ProtectedAbstracttypeThe pool type.
If it is
-'dynamic', it provides themaxproperty.Returns "fixed" | "dynamic"
PrivateutilizationThe approximate pool utilization.
+Returns "fixed" | "dynamic"
PrivateutilizationThe approximate pool utilization.
Returns number
The pool utilization.
-ProtectedAbstractworkerThe worker type.
-Returns "thread" | "cluster"
Methods
add
Adds a task function to this pool. +
ProtectedAbstractworkerThe worker type.
+Returns "thread" | "cluster"
Methods
add
Adds a task function to this pool. If a task function with the same name already exists, it will be overwritten.
Parameters
name: string
The name of the task function.
fn: TaskFunction<Data, Response>
The task function.
Returns Promise<boolean>
trueif the task function was added,falseotherwise.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
nameparameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
-fnparameter is not a function.PrivateaddAdds the given worker node in the pool worker nodes.
+PrivateaddAdds the given worker node in the pool worker nodes.
Parameters
workerNode: IWorkerNode<Worker, Data>
The worker node.
Returns number
The added worker node key.
Throws
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
-ProtectedafterHook executed after the worker task execution. +
ProtectedafterHook executed after the worker task execution. Can be overridden.
Parameters
workerNodeKey: number
The worker node key.
message: MessageValue<Response, unknown>
The received message.
-Returns void
ProtectedafterMethod hooked up after a worker node has been newly created. +
Returns void
ProtectedafterMethod hooked up after a worker node has been newly created. Can be overridden.
Parameters
workerNodeKey: number
The newly created worker node key.
-Returns void
ProtectedbeforeHook executed before the worker task execution. +
Returns void
ProtectedbeforeHook executed before the worker task execution. Can be overridden.
Parameters
workerNodeKey: number
The worker node key.
task: Task<Data>
The task to execute.
-Returns void
PrivatebuildParameters
tasksQueueOptions: TasksQueueOptions
Returns TasksQueueOptions
PrivatecheckReturns void
PrivatecheckReturns void
PrivatecheckReturns void
PrivatecheckChecks if the worker id sent in the received message from a worker is valid.
+Returns void
PrivatebuildParameters
tasksQueueOptions: TasksQueueOptions
Returns TasksQueueOptions
PrivatecannotReturns boolean
ProtectedAbstractcheckEmits dynamic worker creation events.
+Returns void
PrivatecheckReturns void
PrivatecheckReturns void
PrivatecheckChecks if the worker id sent in the received message from a worker is valid.
Parameters
message: MessageValue<Data | Response, unknown>
The received message.
Returns void
Throws
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
-PrivatecheckParameters
minimumNumberOfWorkers: number
Returns void
PrivatecheckParameters
opts: PoolOptions<Worker>
Returns void
PrivatecheckReturns void
PrivatecheckParameters
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
PrivatechooseChooses a worker node for the next task.
+PrivatecheckParameters
minimumNumberOfWorkers: number
Returns void
PrivatecheckParameters
opts: PoolOptions<Worker>
Returns void
PrivatecheckReturns void
PrivatecheckParameters
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
PrivatechooseChooses a worker node for the next task.
The default worker choice strategy uses a round robin algorithm to distribute the tasks.
Returns number
The chosen worker node key
-ProtectedcreateCreates a new, completely set up dynamic worker node.
+ProtectedcreateCreates a new, completely set up dynamic worker node.
Returns number
New, completely set up dynamic worker node key.
-ProtectedcreateCreates a new, completely set up worker node.
+ProtectedcreateCreates a new, completely set up worker node.
Returns number
New, completely set up worker node key.
-PrivatecreateCreates a worker node.
+PrivatecreateCreates a worker node.
Returns IWorkerNode<Worker, Data>
The created worker node.
-PrivatedeleteParameters
name: string
Returns void
PrivatedequeueParameters
workerNodeKey: number
Returns undefined | Task<Data>
ProtectedAbstractderegisterDeregisters a listener callback on the worker given its worker node key.
+PrivatedeleteParameters
name: string
Returns void
PrivatedequeueParameters
workerNodeKey: number
Returns undefined | Task<Data>
ProtectedAbstractderegisterDeregisters a listener callback on the worker given its worker node key.
Type Parameters
Message
Parameters
workerNodeKey: number
The worker node key.
listener: ((message) => void)
The message listener callback.
-Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
destroy
Terminates all workers in this pool.
-Returns Promise<void>
ProtecteddestroyTerminates the worker node given its worker node key.
+Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
destroy
Terminates all workers in this pool.
+Returns Promise<void>
ProtecteddestroyTerminates the worker node given its worker node key.
Parameters
workerNodeKey: number
The worker node key.
-Returns Promise<void>
enable
Enables/disables the worker node tasks queue in this pool.
+Returns Promise<void>
enable
Enables/disables the worker node tasks queue in this pool.
Parameters
enable: boolean
Whether to enable or disable the worker node tasks queue.
OptionaltasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Returns void
PrivateenqueueParameters
workerNodeKey: number
task: Task<Data>
Returns number
execute
Executes the specified function in the worker constructor with the task data input parameter.
+Returns void
PrivateenqueueParameters
workerNodeKey: number
task: Task<Data>
Returns number
execute
Executes the specified function in the worker constructor with the task data input parameter.
Parameters
Optionaldata: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
Optionalname: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
OptionaltransferList: 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.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
-PrivateexecuteExecutes the given task on the worker given its worker node key.
+PrivateexecuteExecutes the given task on the worker given its worker node key.
Parameters
workerNodeKey: number
The worker node key.
task: Task<Data>
The task to execute.
-Returns void
ProtectedflagParameters
workerNodeKey: number
Returns void
ProtectedflushParameters
workerNodeKey: number
Returns number
PrivateflushReturns void
ProtectedgetGets the worker information given its worker node key.
+Returns void
ProtectedflagParameters
workerNodeKey: number
Returns void
ProtectedflushParameters
workerNodeKey: number
Returns number
PrivateflushReturns void
ProtectedgetGets the worker information given its worker node key.
Parameters
workerNodeKey: number
The worker node key.
Returns WorkerInfo
The worker information.
-PrivategetGets the worker node key given its worker id.
+PrivategetGets the worker node key given its worker id.
Parameters
workerId: undefined | number
The worker id.
Returns number
The worker node key if the worker id is found in the pool worker nodes,
--1otherwise.PrivateReadonlyhandleParameters
eventDetail: WorkerNodeEventDetail
Returns void
PrivateReadonlyhandleParameters
eventDetail: WorkerNodeEventDetail
OptionalpreviousStolenTask: Task<Data>Returns void
PrivatehandleParameters
workerNodeKey: number
task: Task<Data>
Returns void
PrivatehandleParameters
message: MessageValue<Response, unknown>
Returns void
PrivatehandleParameters
message: MessageValue<Response, unknown>
Returns void
PrivatehasReturns boolean
has
Whether the specified task function exists in this pool.
+PrivateReadonlyhandleParameters
eventDetail: WorkerNodeEventDetail
Returns void
PrivateReadonlyhandleParameters
eventDetail: WorkerNodeEventDetail
OptionalpreviousStolenTask: Task<Data>Returns void
PrivatehandleParameters
workerNodeKey: number
task: Task<Data>
Returns void
PrivatehandleParameters
message: MessageValue<Response, unknown>
Returns void
PrivatehandleParameters
message: MessageValue<Response, unknown>
Returns void
PrivatehasReturns boolean
has
Whether the specified task function exists in this pool.
Parameters
name: string
The name of the task function.
Returns boolean
-trueif the task function exists,falseotherwise.has
InternalWhether the worker node has back pressure (i.e. its tasks queue is full).
+has
InternalWhether the worker node has back pressure (i.e. its tasks queue is full).
Parameters
workerNodeKey: number
The worker node key.
Returns boolean
-trueif the worker node has back pressure,falseotherwise.PrivateinitializeReturns void
ProtectedinternalWhether worker nodes are executing concurrently their tasks quota or not.
+PrivateinitializeReturns void
ProtectedinternalWhether worker nodes are executing concurrently their tasks quota or not.
Returns boolean
Worker nodes busyness boolean status.
-ProtectedAbstractisShould return whether the worker is the main worker or not.
-Returns boolean
PrivateisParameters
workerNodeKey: number
Returns boolean
list
Lists the names of task function available in this pool.
+ProtectedAbstractisShould return whether the worker is the main worker or not.
+Returns boolean
PrivateisParameters
workerNodeKey: number
Returns boolean
list
Lists the names of task function available in this pool.
Returns string[]
The names of task function available in this pool.
-PrivateredistributeParameters
workerNodeKey: number
Returns void
ProtectedAbstractregisterRegisters once a listener callback on the worker given its worker node key.
+PrivateredistributeParameters
workerNodeKey: number
Returns void
ProtectedAbstractregisterRegisters once a listener callback on the worker given its worker node key.
Type Parameters
Message
Parameters
workerNodeKey: number
The worker node key.
listener: ((message) => void)
The message listener callback.
-Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
ProtectedAbstractregisterRegisters a listener callback on the worker given its worker node key.
+Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
ProtectedAbstractregisterRegisters a listener callback on the worker given its worker node key.
Type Parameters
Message
Parameters
workerNodeKey: number
The worker node key.
listener: ((message) => void)
The message listener callback.
-Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
remove
Removes a task function from this pool.
+Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
remove
Removes a task function from this pool.
Parameters
name: string
The name of the task function.
Returns Promise<boolean>
-trueif the task function was removed,falseotherwise.PrivateremoveRemoves the worker node from the pool worker nodes.
+PrivateremoveRemoves the worker node from the pool worker nodes.
Parameters
workerNode: IWorkerNode<Worker, Data>
The worker node.
-Returns void
PrivateresetParameters
workerNodeKey: number
taskName: string
Returns void
PrivateresetParameters
workerNodeKey: number
Returns void
PrivatesendParameters
workerNodeKey: number
Returns Promise<void>
ProtectedAbstractsendSends the startup message to worker given its worker node key.
+Returns void
PrivateresetParameters
workerNodeKey: number
taskName: string
Returns void
PrivateresetParameters
workerNodeKey: number
Returns void
PrivatesendParameters
workerNodeKey: number
Returns Promise<void>
ProtectedAbstractsendSends the startup message to worker given its worker node key.
Parameters
workerNodeKey: number
The worker node key.
-Returns void
PrivatesendSends the statistics message to worker given its worker node key.
+Returns void
PrivatesendSends the statistics message to worker given its worker node key.
Parameters
workerNodeKey: number
The worker node key.
-Returns void
PrivatesendParameters
workerNodeKey: number
message: MessageValue<Data, unknown>
Returns Promise<boolean>
PrivatesendParameters
message: MessageValue<Data, unknown>
Returns Promise<boolean>
ProtectedAbstractsendSends a message to worker given its worker node key.
+Returns void
PrivatesendParameters
workerNodeKey: number
message: MessageValue<Data, unknown>
Returns Promise<boolean>
PrivatesendParameters
message: MessageValue<Data, unknown>
Returns Promise<boolean>
ProtectedAbstractsendSends a message to worker given its worker node key.
Parameters
workerNodeKey: number
The worker node key.
message: MessageValue<Data, unknown>
The message.
OptionaltransferList: TransferListItem[]The optional array of transferable objects.
-Returns void
set
Sets the default task function in this pool.
+Returns void
set
Sets the default task function in this pool.
Parameters
name: string
The name of the task function.
Returns Promise<boolean>
-trueif the default task function was set,falseotherwise.PrivatesetReturns void
set
Sets the worker node tasks queue options in this pool.
+PrivatesetReturns void
set
Sets the worker node tasks queue options in this pool.
Parameters
tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-Returns void
PrivatesetParameters
size: number
Returns void
PrivatesetReturns void
set
Sets the worker choice strategy in this pool.
+Returns void
PrivatesetParameters
size: number
Returns void
PrivatesetReturns void
set
Sets the worker choice strategy in this pool.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Returns void
set
Sets the worker choice strategy options in this pool.
+Returns void
set
Sets the worker choice strategy options in this pool.
Parameters
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-Returns void
ProtectedsetupSetup hook to execute code before worker nodes are created in the abstract constructor. +
Returns void
ProtectedsetupSetup hook to execute code before worker nodes are created in the abstract constructor. Can be overridden.
-Returns void
PrivateshallConditions for dynamic worker creation.
+Returns void
ProtectedAbstractshallConditions for dynamic worker creation.
Returns boolean
Whether to create a dynamic worker or not.
-PrivateshallParameters
workerNodeKey: number
Returns boolean
PrivateshallWhether the worker node shall update its task function worker usage or not.
+PrivateshallParameters
workerNodeKey: number
Returns boolean
PrivateshallWhether the worker node shall update its task function worker usage or not.
Parameters
workerNodeKey: number
The worker node key.
Returns boolean
-trueif the worker node shall update its task function worker usage,falseotherwise.start
Starts the minimum number of workers in this pool.
-Returns void
PrivatetasksParameters
workerNodeKey: number
Returns number
PrivateunsetReturns void
PrivateunsetReturns void
PrivateupdateParameters
workerNodeKey: number
taskName: string
Returns void
PrivateupdateParameters
workerNodeKey: number
Returns void
PrivateupdateParameters
workerNodeKey: number
taskName: string
Returns void
ProtectedReadonlyworkerThis method is the message listener registered on each worker.
-Parameters
message: MessageValue<Response, unknown>
Returns void
PrivateReadonlyworkerParameters
workerNodeKey: number
Returns undefined | Task<Data>
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc