X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=925961b5b1ff0d5d09dc885ac9c7ca9a65577abb;hb=c97a785f1274883c88a77d2bf418ba6480d20d04;hp=7806afafcb178b8bbc6d42415b006abc25d90b0a;hpb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 7806afaf..925961b5 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -
Emitter on which events can be listened to.
Events that can currently be listened to:
'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
fileProtected
Readonly
numberProtected
Readonly
optsProtected
promiseThe 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
startThe start timestamp of the pool.
+Private
Readonly
startingWhether the pool is starting or not.
+Protected
workerReadonly
workerPool worker nodes.
Protected
fullProtected
Abstract
maxPool maximum size.
+The pool maximum size.
Protected
Abstract
minPool minimum size.
+The pool minimum size.
Private
readyThe pool readiness boolean status.
+Protected
Abstract
typePool type.
+The pool type.
If it is 'dynamic'
, it provides the max
property.
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected
Abstract
workerGets the worker type.
+The worker type.
Private
addAdds the given worker in the pool worker nodes.
+The worker.
+The added worker node key.
+ +https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
+Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -337,39 +409,39 @@ Can be overridden.The worker.
+The worker node key.
The received message.
Protected
Abstract
afterProtected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-Can be used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
Method hooked up after a worker node has been newly created. +Can be overridden.
The newly created worker.
+The newly created worker node key.
Protected
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
chooseChooses a worker node for the next task.
The default worker choice strategy uses a round robin algorithm to distribute the tasks.
The worker node key
+The chosen worker node key
Protected
createProtected
createCreates a new dynamic worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
New, completely set up dynamic worker.
+New, completely set up dynamic worker node key.
-Protected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up worker node.
New, completely set up worker.
+New, completely set up worker node key.
+Protected
Abstract
createPrivate
dequeueTerminate every current worker in this pool.
+Terminates all workers in this pool.
Protected
Abstract
destroyProtected
Abstract
destroyTerminates the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
The worker node key.
Private
enqueueOptional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+The task input data for the specified task function. This can only be structured-cloneable data.
Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+The name of the task function to execute. If not specified, the default task function will be executed.
Promise that will be fulfilled when the task is completed.
@@ -652,25 +760,34 @@ Can be overridden.Private
executeExecutes the given task on the worker given its worker node key.
+The worker node key.
+Private
flushProtected
flushPrivate
flushPrivate
getProtected
getGets the worker information given its worker node key.
+The worker information.
+ +Private
getPrivate
getThe 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
getPrivate
handlePrivate
handleProtected
internalProtected
Abstract
isPrivate
pushPrivate
redistributeProtected
Abstract
registerRegisters a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
The worker which should register a listener.
+The worker node key.
Private
removeProtected
Abstract
sendProtected
Abstract
sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
+The worker node key.
The message.
Private
sendPrivate
setSets the given worker node its tasks usage in the pool.
-The worker node.
-The worker usage.
-Private
setProtected
setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Private
shallPrivate
startPrivate
tasksPrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
@@ -1074,19 +1233,19 @@ Can be overriddenThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -66,6 +66,8 @@ number Of Workers
opts
promise Response Map
+start Timestamp
+starting
worker Choice Strategy Context
worker Nodes