Constructs a new poolifier dynamic cluster pool.
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 ClusterWorker file, which can be relative or absolute.
Options for this dynamic cluster pool.
-Optional Readonly emitterProtected busyProtected fullProtected maxPool maximum size.
+Protected minPool minimum size.
+Private readyProtected typePrivate utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Protected workerGets the worker type.
+Protected afterProtected afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
-The worker.
+The Promise response.
-Protected afterThe received message.
+Protected afterProtected beforeProtected beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-The worker node key.
+The task to execute.
+Protected checkProtected chooseProtected createChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Protected createCreates a new worker for this pool and sets it up completely.
+New, completely set up dynamic worker.
-New, completely set up worker.
+ +Protected createProtected createProtected createProtected destroyOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Promise that will be fulfilled when the task is completed.
+ + -Protected getInitializes tasks usage statistics.
+Gets the worker information from the given worker.
The worker.
-The worker information.
+ +https://nodejs.org/api/errors.html#class-error If the worker is not found.
+Protected internalProtected getProtected internalThe worker node key if found in the pool worker nodes, -1 otherwise.
Protected internalProtected isProtected isProtected registerThe worker which should register a listener.
+The message listener callback.
+Protected sendProtected sendSends a message to the given worker.
+The worker which should receive the message.
+Sets the worker tasks queue options in this pool.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Protected setupProtected setupProtected workerProtected workerThis function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+This 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.
- -The listener function to execute when a message is received from a worker.
+This function is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
+ +Generated using TypeDoc
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, an event is emitted. If you want to listen to this event, use the pool's
- -emitter.Author
Christopher Quadflieg
+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'semitter. +Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0