0.0.1
-Optional Readonly emitterEmitter on which events can be listened to.
Events that can currently be listened to:
Readonly filePath to the worker file.
Readonly numberNumber of workers that this pool should manage.
Readonly optsOptions for the 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 fullPrivate numberPrivate numberProtected afterHook executed after the worker task execution. Can be overridden.
@@ -273,21 +272,21 @@ Can be overridden.The 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.
The newly created worker.
Protected beforeHook executed before the worker task execution. Can be overridden.
@@ -321,60 +320,58 @@ Can be overridden.Protected chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
Protected createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
Protected createReturns a newly created worker.
Protected destroyShutdowns the given worker.
A worker within workerNodes.
Enables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
Optional tasksQueueOptions: TasksQueueOptionsOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Executes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
Optional data: DataThe task input data for the specified worker function. This can only be serializable data.
Finds a free worker node key based on the number of tasks the worker has applied.
-If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1 is returned.
A worker node key if there is one, -1 otherwise.
Protected internalProtected isProtected registerRegisters a listener callback on the given worker.
The worker which should register a listener.
Protected sendSends a message to the given worker.
The worker which should receive the message.
The message.
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: WorkerChoiceStrategyOptionsOptional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Protected setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -595,35 +576,33 @@ Can be overriddenProtected workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a 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.
The listener function to execute when a message is received from a worker.
+
Type of data sent to the worker. This can only be serializable data.
@@ -38,13 +38,13 @@Hierarchy
-- AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
+
- AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
- FixedThreadPool
-- DynamicThreadPool
@@ -84,7 +84,6 @@ destroy
constructor
-- new
+- new
-
+
Constructs a new poolifier fixed thread pool.
Type Parameters
-+-
-
@@ -123,18 +122,18 @@
-
-
Data = unknown
Path to an implementation of a
ThreadWorkerfile, which can be relative or absolute.opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Options for this fixed thread pool.