X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=925961b5b1ff0d5d09dc885ac9c7ca9a65577abb;hb=c97a785f1274883c88a77d2bf418ba6480d20d04;hp=935d5d9fdb3a225639fbf3f58e1a0c97db52237e;hpb=177be4a662e85919499d34984db6c77c6e5da5f6;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 935d5d9f..925961b5 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -
Protected
Readonly
fileProtected
Readonly
numberProtected
Readonly
optsProtected
promisePrivate
Readonly
startingProtected
workerReadonly
workerProtected
fullProtected
Abstract
maxPool maximum size.
+The pool maximum size.
Protected
Abstract
minPool minimum size.
+The pool minimum size.
Private
readyProtected
Abstract
typePool type.
+The pool type.
If it is 'dynamic'
, it provides the max
property.
Private
utilizationGets the approximate pool utilization.
+The approximate pool utilization.
The pool utilization.
Protected
Abstract
workerGets the worker type.
+The worker type.
The worker.
The worker nodes length.
+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.
@@ -404,8 +409,8 @@ Can be overridden.The worker.
+The worker node key.
Protected
afterProtected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +
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
checkhttps://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
dequeueTerminates every current worker in this pool.
+Terminates all workers in this pool.
Implementation of IPool.destroy
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.
Implementation of IPool.enableTasksQueue
Private
enqueueOptional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable 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.
@@ -755,19 +760,22 @@ Can be overridden.Implementation of IPool.execute
Private
executeExecutes the given task on the given worker.
+Executes the given task on the worker given its worker node key.
The worker node key.
+The task to execute.
@@ -776,10 +784,10 @@ Can be overridden.Private
flushProtected
flushPrivate
flushPrivate
getProtected
getGet the worker given its id.
+Gets the worker information given its worker node key.
The worker id.
+The worker node key.
The worker if found in the pool worker nodes, undefined
otherwise.
The worker information.
Private
getPrivate
getGets the worker information.
+Gets the given worker its worker node key.
The worker node key.
+The worker.
The worker node key if found in the pool worker nodes, -1
otherwise.
Private
getPrivate
getGets the given worker its worker node key.
+Gets the worker node key given its worker id.
The worker.
+The worker id.
The worker node key if found in the pool worker nodes, -1
otherwise.
The worker node key if the worker id is found in the pool worker nodes, -1
otherwise.
Private
handlePrivate
handleProtected
internalProtected
Abstract
isPrivate
redistributePrivate
registerProtected
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
sendSends the startup message to worker given its worker node key.
+The worker node key.
+Protected
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.
Private
sendPrivate
sendImplementation of IPool.setTasksQueueOptions
Implementation of IPool.setWorkerChoiceStrategy
Implementation of IPool.setWorkerChoiceStrategyOptions
Private
setProtected
setupPrivate
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.
@@ -1212,7 +1233,7 @@ Can be overridden.This function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The 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
start