X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=909eb463fafa2a8a77fd8217a6a920f8823018e5;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=2ade942cc1ea7b0e9fdd3cf7317abf0a95cd8522;hpb=e4b9c7f546318de7603566b141fd0e2d0118c794;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 2ade942c..909eb463 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
promiseThe execution response promise map.
key
: The message id of each submitted task.Protected
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
numberPool type.
If it is 'dynamic'
, it provides the max
property.
Inherited from FixedClusterPool.afterTaskExecutionHook
Protected
afterInherited from FixedClusterPool.afterWorkerSetup
Protected
beforeInherited from FixedClusterPool.beforeTaskExecutionHook
Protected
chooseInherited from FixedClusterPool.chooseWorkerNode
Protected
createInherited from FixedClusterPool.createAndSetupWorker
Protected
createInherited from FixedClusterPool.createWorker
Inherited from FixedClusterPool.destroy
Protected
destroyShutdowns the given worker.
@@ -395,27 +398,49 @@ Can be overridden.Inherited from FixedClusterPool.destroyWorker
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.
+Inherited from FixedClusterPool.enableTasksQueue
+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.
Inherited from FixedClusterPool.execute
Inherited from FixedClusterPool.findFreeWorkerNodeKey
Protected
internalInherited from FixedClusterPool.internalBusy
Protected
isInherited from FixedClusterPool.isMain
Protected
registerRegisters a listener callback on the given worker.
@@ -488,7 +513,7 @@ Can be overridden.Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
sendInherited from FixedClusterPool.sendToWorker
Sets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Inherited from FixedClusterPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
+Protected
setupInherited from FixedClusterPool.setupHook
Protected
workerInherited from FixedClusterPool.workerListener
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