X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=48d436c8a7e1ce36227e088badf7c1e00fb46e9f;hb=8cc4ea811611b8ad77c7b0379911afe497f2e7e4;hp=d511387dbbebd301fc246fdb7819922b9de6bd6a;hpb=f45a3823ad04902b4c446c7c7de55ca183041953;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index d511387d..48d436c8 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.'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
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.
+Private
taskThe task function names.
+Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Readonly
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.
@@ -334,43 +421,43 @@ 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
beforeHook executed before the worker task execution. Can be overridden.
@@ -382,11 +469,16 @@ Can be overridden.The worker node key.
The task to execute.
+Private
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
checkProtected
choosePrivate
chooseChooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+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 worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
New, completely set up worker.
+New, completely set up dynamic worker node key.
+Protected
createProtected
Abstract
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Private
dequeueShutdowns every current worker in this pool.
+Terminates all workers in this pool.
Protected
Abstract
destroyProtected
Abstract
destroyShutdowns the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
The worker node key.
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 serializable 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.
@@ -631,25 +777,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 node key.
+The worker information.
+ +Private
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
handlePrivate
handleProtected
internalProtected
Abstract
isPrivate
pushPushes the given worker in the pool worker nodes.
+Lists 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 worker given its worker node key.
+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
The worker choice strategy.
Implementation of IPool.setWorkerChoiceStrategy
Implementation of IPool.setWorkerChoiceStrategyOptions
Private
setProtected
setupSets the given worker in the pool worker nodes.
-The worker node key.
-The worker.
-The worker tasks usage.
-The worker task queue.
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Private
setPrivate
shallSets the given worker node its tasks usage in the pool.
+Conditions for dynamic worker creation.
The worker node.
-The worker node tasks usage.
-Whether to create a dynamic worker or not.
+Private
setPrivate
startProtected
setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
-Private
tasksPrivate
updatePrivate
updatePrivate
updatePrivate
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.
@@ -1030,19 +1283,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,9 @@ number Of Workers
opts
promise Response Map
+start Timestamp
+starting
+task Functions
worker Choice Strategy Context
worker Nodes