X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=3017080f50280e841fa22694bfd919296b6a82cb;hb=f63918da6f3fc77cc7f98e4d43e3f37955140468;hp=adb04610252b659ce602b18ff09a5772222da20f;hpb=e4b9c7f546318de7603566b141fd0e2d0118c794;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index adb04610..3017080f 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -31,7 +31,7 @@
Readonly
filePath to the worker-file.
+Path to the worker file.
Readonly
numberNumber of workers that this pool should manage.
Readonly
optsOptions for the pool.
Protected
promiseThe execution response promise map.
key
: The message id of each submitted task.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
Protected
workerDefault to a round robin algorithm.
Readonly
workerAbstract
busyProtected
Abstract
busyWhether the pool is busy or not.
The pool busyness boolean status.
Abstract
fullProtected
Abstract
fullWhether the pool is full or not.
The pool filling boolean status.
Private
numberPrivate
numberAbstract
typePool type.
If it is 'dynamic'
, it provides the max
property.
Protected
Abstract
afterProtected
beforePrivate
buildPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkProtected
chooseProtected
createProtected
Abstract
createPrivate
dequeueImplementation of IPool.destroy
Protected
Abstract
destroyEnables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Implementation of IPool.enableTasksQueue
+Private
enqueuePerforms the task specified in the constructor with the data parameter.
+Executes the function specified in the constructor with the task data input parameter.
Promise that will be resolved when the task is successfully completed.
The input for the specified task. This can only be serializable data.
+The task input data for the specified function. This can only be serializable data.
Implementation of IPool.execute
Private
executeImplementation of IPool.findFreeWorkerNodeKey
Private
flushPrivate
flushPrivate
getPrivate
getGets the given worker its tasks usage in the pool.
+Error if the worker is not found in the pool worker nodes.
+The worker tasks usage.
The worker.
Protected
internalProtected
Abstract
isPrivate
pushProtected
Abstract
registerPrivate
removeProtected
Abstract
sendSets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Implementation of IPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Implementation of IPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Implementation of IPool.setWorkerChoiceStrategyOptions
+Private
setSets the given worker in the pool worker nodes.
The worker.
The worker tasks usage.
The worker task queue.
Private
setSets the given worker node its tasks usage in the pool.
The worker node.
The worker node tasks usage.
Protected
setupPrivate
tasksProtected
worker
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
@@ -45,7 +45,7 @@@@ -67,8 +67,8 @@