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 fixed cluster pool.
Number of workers for this pool.
Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Optional opts: ClusterPoolOptions = {}Options for this fixed cluster pool.
Optional Readonly emitterReadonly fileOptional Readonly maxProtected nextId of the next message.
-Readonly numberReadonly optsProtected promiseThe promise map.
-key: This is the message Id of each submitted task.value: An object that contains the worker, the resolve function and the reject function.Optional Readonly emitterEmitter on which events can be listened to.
+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).When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
-Readonly tasksProtected workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Readonly workersProtected Readonly filePath to the worker file.
+Protected Optional Readonly maxDynamic pool maximum size property placeholder.
+Protected Readonly numberNumber of workers that this pool should manage.
+Protected Readonly optsOptions for this fixed cluster 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.
+Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Readonly Internal workerPool worker nodes.
+Protected busyProtected fullWhether the pool is full or not.
+The pool filling boolean status.
+Protected maxThe pool maximum size.
+Protected minThe pool minimum size.
+Private readyThe pool readiness boolean status.
+Protected typeThe pool type.
+If it is 'dynamic', it provides the max property.
Private utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected workerThe worker type.
+Protected afterProtected afterProtected chooseProtected createThe worker node key.
+The received message.
+Protected afterCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Method hooked up after a worker node has been newly created. +Can be overridden.
Protected createProtected decreaseProtected beforeDecrease the number of tasks that the given worker has applied.
+Hook executed before the worker task execution. +Can be overridden.
Worker whose tasks are decreased.
+The worker node key.
+The task to execute.
Protected checkProtected createProtected createProtected createProtected destroyWhether to enable or disable the worker node tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Optional Protected increaseOptional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
+Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional Optional transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+Optional Promise that will be fulfilled when the task is completed.
+ +Protected flushProtected internalProtected getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Protected internaltrue if the worker node has back pressure, false otherwise.
Protected internalProtected isProtected isProtected registerThe worker node key.
+The message listener callback.
+Protected removeProtected sendRemoves the given worker from the pool.
+Protected sendSends the startup message to worker given its worker node key.
Worker that will be removed.
+The worker node key.
Protected sendProtected sendThe message.
+Protected setupThe worker node tasks queue options.
+Protected workerSets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Optional This function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+Sets the worker choice strategy options in this pool.
The worker choice strategy options.
+Protected setupProtected workerThis method 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 method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
+ +Generated using TypeDoc
Generated using TypeDoc
A cluster pool with a fixed number of workers.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the workers in a round robin fashion.
- -Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
- -Author
Christopher Quadflieg
+Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0