X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=57b75a1a6da1adfb6f25fa46a5518a8e1ce7ed62;hb=4ee786575c19cfc95faa0dfc2671b3ab8f680402;hp=fed14871d0bf865335550610105d45cdbd2823d4;hpb=de2e7182cca6b34b000a09bf6d0ddcff4757db3a;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index fed14871..57b75a1a 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -
Optional
Readonly
emitterProtected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
+Protected
Readonly
numberProtected
Readonly
optsProtected
promiseThe task 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.Private
Readonly
startPrivate
startedWhether the pool is started or not.
+Private
Readonly
startingPrivate
startingWhether the pool is starting or not.
Private
Readonly
taskThe task functions added at runtime map:
+key
: The task function name.value
: The task function itself.Protected
workerReadonly
workerReadonly
Internal
workerPool worker nodes.
Protected
fullProtected
Abstract
maxProtected
maxProtected
Abstract
minProtected
minPrivate
readyProtected
Abstract
typePrivate
utilizationProtected
Abstract
workerAdds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+The name of the task function.
+The task function.
+true
if the task function was added, false
otherwise.
https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Private
addhttps://nodejs.org/api/errors.html#class-error If the added worker node is not found.
Protected
afterProtected
afterProtected
beforePrivate
buildPrivate
checkPrivate
checkProtected
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkThe 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
deletePrivate
dequeueProtected
Abstract
deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
Abstract
destroyEnables/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.
Private
enqueuePrivate
executeProtected
flushPrivate
flushProtected
getPrivate
getPrivate
getThe worker id.
Private
handlePrivate
handlePrivate
hasPrivate
initializeProtected
internalProtected
Abstract
isPrivate
redistributeProtected
Abstract
registerRegisters once a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
Abstract
registerPrivate
removeProtected
sendProtected
Abstract
sendPrivate
sendPrivate
sendPrivate
sendProtected
Abstract
sendPrivate
sendSends the worker statistics message to worker given its worker node key.
+Sets the default task function in this pool.
The worker node key.
+The name of the task function.
true
if the default task function was set, false
otherwise.
Private
setSets 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.
Private
setPrivate
setProtected
setupPrivate
shallPrivate
startPrivate
shallPrivate
shallWhether the worker node shall update its task function worker usage or not.
+The worker node key.
+true
if the worker node shall update its task function worker usage, false
otherwise.
Private
taskPrivate
tasksPrivate
tasksPrivate
unsetPrivate
unsetPrivate
updatePrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerProtected
workerThis method is the listener registered for each worker message.
-The listener function to execute when a message is received from a worker.
- -This method is the listener registered for each worker message.
+This method is the message listener registered on each worker.
The listener function to execute when a message is received from a worker.
- - +Generated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
Emitter on which events can be listened to.
+
+Optional
emitterEvent emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool
.Events that can currently be listened to:
-
-
+
+
+
+
'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.'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).Protected
Readonly
file