Class DynamicClusterPool<Data, Response> Protected send send ( workerNodeKey , message ) : void Returns void set set ( name ) : Promise < boolean > Returns Promise < boolean > set set ( tasksQueueOptions ) : void Returns void set set ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) : void Parameters workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" Optional workerChoiceStrategyOptions : WorkerChoiceStrategyOptions Returns void set set ( workerChoiceStrategyOptions ) : void Returns void Returns void set set ( name ) : Promise < boolean > Returns Promise < boolean > set set ( tasksQueueOptions ) : void Returns void set set ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) : void Parameters workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" Optional workerChoiceStrategyOptions : WorkerChoiceStrategyOptions Returns void set set ( workerChoiceStrategyOptions ) : void Returns void Protected setup setup ( ) : void Returns void Protected shall shall ( ) : boolean Returns void Protected shall start start ( ) : void Returns void Protected Readonly worker worker ( message ) : void Returns void
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 - v3.1.30Class 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
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
Hierarchy (view full)
Index
Constructors
Properties
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. +
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:
@@ -72,71 +72,72 @@ 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.
-ProtectedOptionalworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-ReadonlyInternalworkerPool worker nodes.
-Accessors
ProtectedbusyWhether the pool is busy or not.
+ProtectedOptionalworkerWorker 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
ProtectedemptyThe pool emptiness boolean status.
-Returns boolean
ProtectedfullWhether the pool is full or not.
+Returns boolean
ProtectedemptyThe pool emptiness 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.
+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 "fixed" | "dynamic"
PrivateutilizationThe approximate pool utilization.
Returns number
The pool utilization.
-ProtectedworkerThe worker type.
-Returns "thread" | "cluster"
Methods
add
Parameters
Returns Promise<boolean>
Inherit Doc
ProtectedafterHook executed after the worker task execution. +
ProtectedworkerThe worker type.
+Returns "thread" | "cluster"
Methods
add
Parameters
Returns Promise<boolean>
Inherit Doc
ProtectedafterHook executed after the worker task execution. Can be overridden.
Parameters
The worker node key.
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
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
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 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.
+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
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: DataOptionalname: stringOptionaltransferList: TransferListItem[]Returns Promise<Response>
Inherit Doc
ProtectedflagParameters
Returns void
ProtectedflushParameters
Returns number
ProtectedgetGets the worker information given its worker node key.
+Returns Promise<void>
enable
Parameters
OptionaltasksQueueOptions: TasksQueueOptionsReturns void
Inherit Doc
execute
Parameters
Optionaldata: DataOptionalname: stringOptionaltransferList: readonly TransferListItem[]Returns Promise<Response>
Inherit Doc
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
Returns boolean
Inherit Doc
ProtectedinternalWhether worker nodes are executing concurrently their tasks quota or not.
+has
Parameters
Returns boolean
Inherit Doc
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
Returns string[]
Inherit Doc
ProtectedregisterRegisters once a listener callback on the worker given its worker node key.
+ProtectedisReturns whether the worker is the main worker or not.
+Returns boolean
+trueif the worker is the main worker,falseotherwise.list
Returns string[]
Inherit Doc
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.
+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
Returns Promise<boolean>
Inherit Doc
ProtectedsendSends the startup message to worker given its worker node key.
+Parameters
Returns void
Returns void
remove
Parameters
Returns Promise<boolean>
Inherit Doc
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.
+Returns void