A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
-When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.
Event emitter integrated with async resource on which events can be listened to.
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.
Pool event emitter integrated with async resource.
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.
-
'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).
+
'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).
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.
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: readonly 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.
The tasks iterable input data for the specified task function. This can only be an iterable of 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: readonly 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.
workerChoiceStrategy: Â Â Â Â | "ROUND_ROBIN" Â Â Â Â | "LEAST_USED" Â Â Â Â | "LEAST_BUSY" Â Â Â Â | "LEAST_ELU" Â Â Â Â | "FAIR_SHARE" Â Â Â Â | "WEIGHTED_ROUND_ROBIN" Â Â Â Â | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.15Class DynamicClusterPool<Data, Response>
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's
-emitter.Author
Christopher Quadflieg
-Since
2.0.0
-Type Parameters
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 (view full)
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Constructs a new poolifier dynamic cluster pool.
-Type Parameters
Data = unknown
Response = unknown
Parameters
min: number
Minimum number of workers which are always active.
-max: number
Maximum number of workers that can be created by this pool.
-filePath: string
Path to an implementation of a
-ClusterWorkerfile, which can be relative or absolute.opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
-Returns DynamicClusterPool<Data, Response>
Properties
OptionalemitterEvent emitter integrated with async resource on which events can be listened to. +When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's
+emitter.Author
Christopher Quadflieg
+Since
2.0.0
+Type Parameters
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.
+Hierarchy (view full)
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Constructs a new poolifier dynamic cluster pool.
+Type Parameters
Parameters
Minimum number of workers which are always active.
+Maximum number of workers that can be created by this pool.
+Path to an implementation of a
+ClusterWorkerfile, which can be relative or absolute.Options for this dynamic cluster pool.
+Returns DynamicClusterPool<Data, Response>
Properties
OptionalemitterPool event emitter integrated with async resource. 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.'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).'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).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.value: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-ReadonlyInternalworkerPool worker nodes.
-Accessors
ProtectedbusyWhether the pool is busy or not.
-The pool busyness boolean status.
-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
ProtectedtypeThe pool type.
-If it is
-'dynamic', it provides themaxproperty.Returns "fixed" | "dynamic"
PrivateutilizationThe approximate pool utilization.
-Returns number
The pool utilization.
-ProtectedworkerThe 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.
+ProtectedOptionalworkerWorker choice strategies context referencing worker choice algorithms implementation.
+ReadonlyInternalworkerPool worker nodes.
+Accessors
ProtectedbusyWhether the pool is busy or not.
+Returns boolean
The pool busyness boolean status.
+ProtectedemptyWhether the pool is empty or not.
+Returns boolean
The pool emptiness boolean status.
+ProtectedfullWhether the pool is full or not.
+Returns boolean
The pool fullness boolean status.
+info
Pool information.
+Returns PoolInfo
ProtectedtypeThe pool type.
+If it is
+'dynamic', it provides themaxproperty.Returns "fixed" | "dynamic"
ProtectedworkerThe worker type.
+Returns "thread" | "cluster"
Methods
add
Parameters
The name of the task function.
+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.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. +
Parameters
The worker node key.
+The received message.
+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. +
Parameters
The newly created worker node key.
+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
ProtectedcheckEmits dynamic worker creation events.
-Returns void
ProtectedcreateCreates a new, completely set up dynamic worker node.
+Parameters
The worker node key.
+The task to execute.
+Returns void
ProtectedcheckEmits dynamic worker creation events.
+Returns void
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.
-ProtectedderegisterDeregisters 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
workerNodeKey: number
The worker node key.
-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
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.
-ProtectedflagParameters
workerNodeKey: number
Returns void
ProtectedflushParameters
workerNodeKey: number
Returns number
ProtectedgetGets the worker information given its worker node key.
-Parameters
workerNodeKey: number
The worker node key.
-Returns WorkerInfo
The worker information.
-has
Whether the specified task function exists in this pool.
-Parameters
name: string
The name of the task function.
+ProtectedderegisterDeregisters a listener callback on the worker given its worker node key.
+Type Parameters
Parameters
The worker node key.
+The message listener callback.
+Parameters
Returns void
Returns void
destroy
Returns Promise<void>
Inherit Doc
ProtecteddestroyTerminates the worker node given its worker node key.
+Parameters
The worker node key.
+Returns Promise<void>
enable
Parameters
OptionaltasksQueueOptions: TasksQueueOptionsReturns void
Inherit Doc
execute
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: readonly 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 with a task function response that will be fulfilled when the task is completed.
+ProtectedflagParameters
Returns void
ProtectedflushParameters
Returns number
ProtectedgetGets the worker information given its worker node key.
+Parameters
The worker node key.
+Returns undefined | WorkerInfo
The worker information.
+has
Parameters
The name of the task function.
Returns boolean
-trueif the task function exists,falseotherwise.ProtectedinternalWhether worker nodes are executing concurrently their tasks quota or not.
+ProtectedinternalWhether worker nodes are executing concurrently their tasks quota or not.
Returns boolean
Worker nodes busyness boolean status.
-ProtectedisShould return whether the worker is the main worker or not.
-Returns boolean
list
Lists the names of task function available in this pool.
-Returns string[]
The names of task function available in this pool.
-ProtectedregisterRegisters 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
ProtectedregisterRegisters 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
name: string
The name of the task function.
+ProtectedisReturns whether the worker is the main worker or not.
+Returns boolean
+trueif the worker is the main worker,falseotherwise.list
Returns TaskFunctionProperties[]
The properties of task functions available in this pool.
+map
Parameters
The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.
+Optionalname: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+OptionaltransferList: readonly 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 with an array of task function responses that will be fulfilled when the tasks are completed.
+ProtectedregisterRegisters once a listener callback on the worker given its worker node key.
+Type Parameters
Parameters
The worker node key.
+The message listener callback.
+Parameters
Returns void
Returns void
ProtectedregisterRegisters a listener callback on the worker given its worker node key.
+Type Parameters
Parameters
The worker node key.
+The message listener callback.
+Parameters
Returns void
Returns void
remove
Parameters
The name of the task function.
Returns Promise<boolean>
-trueif the task function was removed,falseotherwise.ProtectedsendSends the startup message to worker given its worker node key.
-Parameters
workerNodeKey: number
The worker node key.
-Returns void
ProtectedsendSends a message to worker given its worker node key.
-Parameters
workerNodeKey: number
The worker node key.
-message: MessageValue<Data, unknown>
The message.
-Returns void
set
Sets the default task function in this pool.
-Parameters
name: string
The name of the task function.
+ProtectedsendSends the startup message to worker given its worker node key.
+Parameters
The worker node key.
+Returns void
ProtectedsendSends a message to worker given its worker node key.
+Parameters
The worker node key.
+The message.
+Returns void
set
Parameters
The name of the task function.
Returns Promise<boolean>
-trueif the default task function was set,falseotherwise.set
Sets the worker node tasks queue options in this pool.
-Parameters
tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-Returns 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.
-Parameters
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-Returns void
ProtectedsetupSetup hook to execute code before worker nodes are created in the abstract constructor. +
set
Parameters
Returns void
Inherit Doc
set
Parameters
    | "ROUND_ROBIN"
    | "LEAST_USED"
    | "LEAST_BUSY"
    | "LEAST_ELU"
    | "FAIR_SHARE"
    | "WEIGHTED_ROUND_ROBIN"
    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptionsReturns void
Inherit Doc
set
Parameters
The worker choice strategy options.
+Returns boolean
+trueif the worker choice strategy options were set,falseotherwise.ProtectedsetupSetup hook to execute code before worker nodes are created in the abstract constructor. Can be overridden.
-Returns void
ProtectedshallConditions for dynamic worker creation.
+Returns void
ProtectedshallConditions for dynamic worker creation.
Returns boolean
Whether to create a dynamic worker or not.
-start
Starts the minimum number of workers in this pool.
-Returns void
ProtectedReadonlyworkerThis method is the message listener registered on each worker.
-Parameters
message: MessageValue<Response, unknown>
Returns void
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
start
Returns void
Inherit Doc
ProtectedReadonlyworkerThis method is the message listener registered on each worker.
+Parameters
The message received from the worker.
+Returns void
Settings
On This Page
Constructors
Properties
Accessors
Methods