X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=48d436c8a7e1ce36227e088badf7c1e00fb46e9f;hb=fb8fbcfd7983c1eadc39411c9b29054e6fa97d5b;hp=984c1c21c2da8ba185da4297fe494a7610100b85;hpb=b881e803f1a32ce8d8218d3ba3638ad317ae87bc;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 984c1c21..48d436c8 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -
Protected
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
startPrivate
Readonly
startingPrivate
taskThe task function names.
+Protected
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.
@@ -405,8 +421,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
enqueueExecutes the specified function in the worker constructor with the task data input parameter.
Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
+The optional 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 optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional
transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Promise that will be fulfilled when the task is completed.
@@ -756,19 +777,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.
@@ -777,10 +801,10 @@ Can be overridden.Private
flushProtected
flushPrivate
flushPrivate
getGet the worker given its id.
-The worker id.
-The worker if found in the pool worker nodes, undefined
otherwise.
Private
getProtected
getGets the worker information from the given worker node key.
+Gets the worker information given its worker node key.
Protected
getPrivate
getGets the worker information from the given worker.
+Gets the given worker its worker node key.
The worker.
The worker information.
+The worker node key if found in the pool worker nodes, -1
otherwise.
https://nodejs.org/api/errors.html#class-error If the worker is not found.
-Protected
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
internalWhether worker nodes are executing at least one task.
+Whether worker nodes are executing concurrently their tasks quota or not.
Worker nodes busyness boolean status.
Protected
Abstract
isLists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Implementation of IPool.listTaskFunctions
+Private
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
sendProtected
Abstract
sendSends the startup message to the given worker.
+Sends the startup message to worker given its worker node key.
The worker which should receive the startup message.
+The worker node key.
Private
sendSends the statistics 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.
The message.
Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Implementation 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.
@@ -1242,7 +1283,7 @@ Can be overridden.This function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
Emitter on which events can be listened to.
Events that can currently be listened to:
-
+
+- '
@@ -197,7 +200,7 @@ +'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.'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.Protected
Readonly
file