X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FDynamicClusterPool.html;h=cdb0a3a0e218cc7e19e86ebaf205caafdaef6af5;hb=0e502832d98443e291ea5558423ca0de86b96e13;hp=26c6e3bd2c89603b0f91af5119aacda46b6e65c9;hpb=c2d2417cb80d8c14637fe6a19d58bcf5ce18ae98;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 26c6e3bd..10e968f8 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,13 +1,13 @@ -
Protected
Readonly
fileProtected
Readonly
maxMaximum number of workers that can be created by this pool.
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
workerReadonly
Internal
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
utilizationGets the approximate pool utilization.
+The 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.
@@ -343,8 +368,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
checkProtected
createCreates a new dynamic worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
New, completely set up dynamic worker.
+New, completely set up dynamic worker node key.
-Protected
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
createTerminates 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.
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
+Whether to enable or disable the worker node tasks queue.
Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+The worker node tasks queue options.
Executes the specified function in the worker constructor with the task data input parameter.
Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
+The optional 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 optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional
transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Promise that will be fulfilled when the task is completed.
@@ -525,20 +571,76 @@ 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
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.
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
+The worker node tasks queue options.
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.
@@ -668,7 +860,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
Generated using TypeDoc
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.'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 concurrently their tasks quota.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'destroy'
: Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).