X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=8be64b4f62398dc2fffc57fc4fa410e4a605658c;hb=7d6b5ad23febf5c7830f98a10fb75fb29853bcdb;hp=0386e65b205229b799bc4793b2b3dddfe5c7d8bb;hpb=842d8918a19fc2720d4436789a2e373bc623452e;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 0386e65b..8be64b4f 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -33,7 +33,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Readonly
filePath to the worker-file.
+Path to the worker file.
Readonly
maxMaximum number of workers that can be created by this pool.
Readonly
numberReadonly
optsProtected
promiseProtected
workerReadonly
workerProtected
busyWhether the pool is busy or not.
@@ -219,10 +222,10 @@ When the maximum number of workers is reached and workers are busy, an event isProtected
fullWhether the pool is full or not.
@@ -231,7 +234,7 @@ When the maximum number of workers is reached and workers are busy, an event isPrivate
numberPrivate
numberProtected
afterProtected
beforeProtected
chooseProtected
createProtected
createProtected
destroyShutdowns the given worker.
@@ -395,27 +398,49 @@ Can be overridden.Enables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Performs the task specified in the constructor with the data parameter.
+Executes the function specified in the worker constructor with the task data input parameter.
-Promise that will be resolved when the task is successfully completed.
+Promise that will be fulfilled when the task is completed.
The input for the specified task. This can only be serializable data.
+Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
Protected
internalProtected
isProtected
registerRegisters a listener callback on the given worker.
@@ -488,7 +513,7 @@ Can be overridden.Protected
sendSets 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: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Protected
setupProtected
worker
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
@@ -42,7 +42,7 @@ When the maximum number of workers is reached and workers are busy, an event is@@ -65,8 +65,8 @@ When the maximum number of workers is reached and workers are busy, an event is