X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=9839ac139b1984a50c829efd4060c78d7cf895c8;hb=afc003b20097712625ffd053e256ef5336e27b6e;hp=6910150bf4dd6529111bb2ca763a2a2770729168;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 6910150b..9839ac13 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,57 +1,606 @@ -
Constructs a new poolifier dynamic thread pool.
-Minimum number of threads which are always active.
-Maximum number of threads that can be created by this pool.
-Path to an implementation of a ThreadWorker
file, which can be relative or absolute.
Id of the next message.
-The 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.A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
+This thread pool creates new threads when the others are busy, up to the maximum number of threads.
+When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter
.
0.0.1
+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 dynamic thread pool.
+Minimum number of threads which are always active.
+Maximum number of threads that can be created by this pool.
+Path to an implementation of a ThreadWorker
file, which can be relative or absolute.
Options for this dynamic thread pool.
+Optional
Readonly
emitter{@inheritDoc}
+Readonly
filePath to the worker-file.
+Private
Readonly
maxMaximum number of threads that can be created by this pool.
+Readonly
numberNumber of workers that this pool should manage.
+Readonly
optsOptions for the pool.
+Protected
promiseThe promise response map.
+key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
-Worker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Choose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
-Worker.
-Creates a new worker for this pool and sets it up completely.
-New, completely set up worker.
-Decrease the number of tasks that the given worker has applied.
-Worker whose tasks are decreased.
-Increase the number of tasks that the given worker has applied.
-Worker whose tasks are increased.
-Removes the given worker from the pool.
-Worker that will be removed.
-Setup hook that can be overridden by a Poolifier pool implementation +
When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
+Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
+Readonly
workers{@inheritDoc}
+{@inheritDoc}
+{@inheritDoc}
+Private
numberNumber of tasks concurrently running in the pool.
+{@inheritDoc}
+Protected
afterHook executed after the worker task promise resolution. +Can be overridden.
+The worker.
+The received message.
+Protected
after{@inheritDoc}
+Protected
beforeProtected
chooseChooses a worker for the next task.
+The default uses a round robin algorithm to distribute the load.
+ +[worker key, worker].
+Protected
createCreates a new worker for this pool and sets it up completely.
+ +New, completely set up worker.
+Protected
create{@inheritDoc}
+{@inheritDoc}
+Protected
internalProtected
is{@inheritDoc}
+Protected
removeRemoves the given worker from the pool.
+The worker that will be removed.
+Protected
send{@inheritDoc}
+Protected
setupThis function is the listener registered for each worker.
-The listener function to execute when a message is sent from a worker.
-This function is the listener registered for each worker.
-The listener function to execute when a message is sent from a worker.
-Generated using TypeDoc
Protected
workerThis function is the listener registered for each worker.
+ +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.
+Generated using TypeDoc
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
-This thread pool creates new threads when the others are busy, up to the maximum number of threads. -When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's
-emitter
.of data sent to the worker. This can only be serializable data.
-of response of execution. This can only be serializable data.
-Alessandro Pio Ardizio
-0.0.1
-