X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FDynamicThreadPool.html;h=de09b112b82cbcb3ab9b8fc6b1fe7d89d64985af;hb=c4424e52e4924efa5eef704cb5dcb82f2760e0da;hp=cda827b9479c3fb3a538dc1ce44d0d9fd0ba40d6;hpb=a6d9dccfaf39e185c896747260d668fcb683a8ed;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index cda827b9..de09b112 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Protected
Readonly
numberProtected
Readonly
optsProtected
promiseThe execution response promise map.
+ +The 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.Protected
workerReadonly
workerPool worker nodes.
Protected
fullProtected
maxPool maximum size.
+The pool maximum size.
Protected
minPool minimum size.
+The pool minimum size.
Private
readyThe pool readiness boolean status.
+Protected
typePool type.
+The pool type.
If it is 'dynamic'
, it provides the max
property.
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected
workerGets the worker type.
+The worker type.
Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -329,8 +362,8 @@ Can be overridden.The worker.
+The worker node key.
Protected
afterProtected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +
Method hooked up after a worker node has been newly created. Can be overridden.
The newly created worker.
+The newly created worker node key.
Protected
beforeProtected
createProtected
checkCreates a new dynamic worker and sets it up completely in the pool worker nodes.
+Protected
createProtected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up worker node.
New, completely set up worker.
+New, completely set up worker node key.
+Protected
createTerminate every current worker in this pool.
+Terminates all workers in this pool.
Protected
destroyProtected
destroyTerminates the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
The worker node key.
Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
+The task input data for the specified task function. This can only be structured-cloneable data.
Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+The name of the task function to execute. If not specified, the default task function will be executed.
Promise that will be fulfilled when the task is completed.
@@ -511,20 +560,55 @@ Can be overridden.Protected
flushProtected
getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Protected
internalWhether worker nodes are executing at least one task.
+Whether worker nodes are executing concurrently their tasks quota or not.
Worker nodes busyness boolean status.
+Protected
isProtected
registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
sendProtected
sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
+The worker node key.
Protected
setupProtected
workerThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
@@ -654,7 +799,7 @@ Can be overridden.This function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
Generated using TypeDoc
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -158,7 +166,7 @@ When the maximum number of threads is reached and workers are busy, an event is +'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
max