Emitter on which events can be listened to.
Events that can currently be listened to:
'full': Emitted when the pool is dynamic and full.'busy': Emitted when the pool is busy.'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 fileProtected Readonly maxProtected Readonly numberProtected Readonly optsOptions for the pool.
+ +Options for this fixed thread pool.
Protected promiseThe execution response promise map.
key: The message id of each submitted task.Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Readonly workerPool worker nodes.
Protected fullProtected maxProtected minPrivate readyProtected typePrivate utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Protected workerThe worker.
The received message.
Protected afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
The newly created worker.
Protected beforeHook executed before the worker task execution. Can be overridden.
@@ -381,75 +409,96 @@ Can be overridden.The worker node key.
The task to execute.
+Protected chooseProtected checkProtected createChooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
The worker node key
+New, completely set up dynamic worker.
+Protected createCreates a new worker and sets it up completely in the pool worker nodes.
New, completely set up worker.
+New, completely set up worker.
Protected createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Shutdowns every current worker in this pool.
+Terminates every current worker in this pool.
Protected destroyShutdowns the given worker.
+Terminates the given worker.
A worker within workerNodes.
Optional data: DataThe task input data for the specified worker function. This can only be serializable data.
+The task input data for the specified worker function. This can only be structured-cloneable data.
Protected getGets 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 getProtected internalProtected isProtected registerThe worker which should register a listener.
Protected sendProtected sendThe worker which should receive the message.
The message.
The worker choice strategy.
Protected setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Protected workerThe listener function to execute when a message is received from a worker.
Generated using TypeDoc
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.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -73,7 +73,9 @@ When the maximum number of threads is reached and workers are busy, an event is info max
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+opts: ThreadPoolOptions = {}
Options for this dynamic thread pool.