Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of response of execution. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Constructs a new poolifier fixed thread pool.
Number of threads for this pool.
-Path to an implementation of a ThreadWorker file, which can be relative or absolute.
Options for this fixed thread pool.
-Optional Readonly emitterReadonly filePath to the worker-file.
-Readonly numberOptional Readonly emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
+'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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 at least one task.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.Protected Readonly filePath to the worker file.
+Protected Readonly numberNumber of workers that this pool should manage.
-Readonly optsOptions for the pool.
-Protected promiseThe execution response promise map.
+Protected Readonly optsOptions for this fixed thread 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 workerProtected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonly workerReadonly workerPool worker nodes.
+Protected busyProtected fullPrivate numberWhether the pool is full or not.
+The pool filling boolean status.
+Number of tasks queued in the pool.
+Pool information.
Private numberProtected maxNumber of tasks running in the pool.
+The pool maximum size.
Protected minPrivate 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 afterHook executed after the worker task execution. Can be overridden.
@@ -262,37 +350,45 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Protected afterProtected afterMethod hooked up after a worker node has been newly created. +Can be overridden.
+Protected beforeThe newly created worker node key.
+Protected beforeHook executed before the worker task execution. Can be overridden.
@@ -301,238 +397,454 @@ Can be overridden.The worker node key.
-The task to execute.
+Protected checkProtected chooseProtected createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
+Creates a new, completely set up dynamic worker node.
+New, completely set up dynamic worker node key.
-[worker node key, worker node].
+ +Protected createCreates a new, completely set up worker node.
Protected createNew, completely set up worker node key.
+ +Protected createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new worker.
+Newly created worker.
-New, completely set up worker.
+ +Terminates all workers in this pool.
Protected createProtected destroyEnables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Executes the specified function in the worker constructor with the task data input parameter.
+Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+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.
+Promise that will be fulfilled when the task is completed.
+ +Protected flushProtected getProtected internalGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Protected internalProtected isProtected isShould return whether the worker is the main worker or not.
+Protected registerThe worker node key.
+The message listener callback.
+Protected sendProtected sendProtected sendProtected setupProtected sendSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Sends a message to worker given its worker node key.
Protected workerThe worker node key.
+The message.
+Optional transferList: TransferListItem[]The optional array of transferable objects.
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
+Sets the worker tasks queue options in this pool.
The worker tasks queue options.
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+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 message.
- -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
A thread pool with a fixed number of threads.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the threads in a round robin fashion.
- -Author
Alessandro Pio Ardizio
+Author
Alessandro Pio Ardizio
-Since
0.0.1
+Since
0.0.1