X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=d7c1a3d61996c22fecaacad3ea76b8e772c1402f;hb=36df5bd40369d98d6ccb60400e66dce1aa980d54;hp=685d002dcd2886b23057ba20ab83f8c34ed523dd;hpb=52d3ec6b2aea8279b0ac670bd6291efa90466a60;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 685d002d..d7c1a3d6 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -
Protected
Readonly
numberProtected
Readonly
optsProtected
promisePrivate
Readonly
startThe start timestamp of the pool.
+Private
Readonly
startingWhether the pool is starting or not.
+Protected
workerReadonly
workerPool worker nodes.
Protected
fullProtected
Abstract
maxProtected
Abstract
minPrivate
readyProtected
Abstract
typePrivate
utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Protected
Abstract
workerPrivate
addProtected
afterProtected
afterProtected
beforePrivate
buildPrivate
checkProtected
checkPrivate
checkPrivate
checkChecks if the worker id sent in the received message from a worker is valid.
+The received message.
+https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+Private
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
chooseProtected
createProtected
createProtected
Abstract
createPrivate
dequeueTerminate every current worker in this pool.
+Terminates every current worker in this pool.
Protected
Abstract
destroyPrivate
enqueuePrivate
executeExecutes the given task on the given worker.
+Private
flushPrivate
flushPrivate
getPrivate
getGets the worker information.
+The worker node key.
+Private
getThe worker.
The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
The worker node key if found in the pool worker nodes, -1
otherwise.
Private
getPrivate
handleOptional
workerNodeKey: numberPrivate
handleProtected
internalProtected
Abstract
isPrivate
pushPrivate
redistributePushes the given worker in the pool worker nodes.
-The worker.
-The worker nodes length.
- -Private
registerPrivate
removeProtected
Abstract
sendPrivate
sendPrivate
setSets the given worker node its tasks usage in the pool.
-The worker node.
-The worker usage.
-Private
setProtected
setupPrivate
shallPrivate
tasksPrivate
tasksPrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerGenerated using TypeDoc
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -185,7 +195,7 @@ +'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
file