Type of data sent to the worker. This can only be serializable data.
Type of response of execution. This can only be serializable 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
emitterEmitter 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.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.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.
Default to a round robin algorithm.
Readonly
workerPool worker nodes.
Protected
busyWhether the pool is busy or not.
The pool busyness boolean status.
Protected
fullWhether the pool is full or not.
The pool filling boolean status.
Private
numberNumber of tasks queued in the pool.
Private
numberNumber of tasks running in the pool.
Protected
afterHook executed after the worker task execution. 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
beforeProtected
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
.
Performs the task specified in the constructor with the data parameter.
Promise that will be resolved when the task is successfully completed.
The input for the specified task. 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.
The message listener callback.
Protected
sendSends a message to the given worker.
The worker which should receive the message.
The message.
Sets the worker choice strategy in this pool.
The worker choice strategy.
Protected
setupProtected
workerThis 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 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
Since
0.0.1