X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=57b75a1a6da1adfb6f25fa46a5518a8e1ce7ed62;hb=4ee786575c19cfc95faa0dfc2671b3ab8f680402;hp=0fac7c90924665fc6ec4b6f672c2f0c11ef95575;hpb=c914a50e9996ca3f869c130974bff87b117f70f5;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 0fac7c90..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 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
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
maxPool maximum size.
+The pool maximum size.
Protected
Abstract
minProtected
minPool minimum size.
+The pool minimum size.
Private
readyPrivate
startingProtected
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.
Adds 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.
Implementation of IPool.addTaskFunction
+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.
@@ -381,8 +496,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
checkPrivate
checkProtected
checkPrivate
checkPrivate
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
deletePrivate
dequeueProtected
Abstract
deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Terminates 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.
Enables/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.
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.
@@ -711,25 +867,34 @@ Can be overridden.Implementation of IPool.execute
Private
executePrivate
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
handlePrivate
handlePrivate
hasWhether the specified task function exists in this pool.
+The name of the task function.
+true
if the task function exists, false
otherwise.
Implementation of IPool.hasTaskFunction
+Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+The worker node key.
+true
if the worker node has back pressure, false
otherwise.
Implementation of IPool.hasWorkerNodeBackPressure
+Private
initializeProtected
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
isPrivate
pushPushes the given worker in the pool worker nodes.
-The worker.
+Lists the names of task function available in this pool.
The worker nodes length.
+The names of task function available in this pool.
Implementation of IPool.listTaskFunctionNames
Private
redistributePrivate
registerProtected
Abstract
registerRegisters a listener callback on the given worker.
+Registers once a listener callback on the worker given its worker node key.
The worker which should register a listener.
+The worker node key.
Protected
Abstract
registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Removes a task function from this pool.
+The name of the task function.
+true
if the task function was removed, false
otherwise.
Implementation of IPool.removeTaskFunction
+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.
+Private
sendPrivate
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.
Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Sets the default task function in this pool.
+The name of the task function.
+true
if the default task function was set, false
otherwise.
Implementation of IPool.setDefaultTaskFunction
+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.
Implementation of IPool.setTasksQueueOptions
Private
setPrivate
setImplementation of IPool.setWorkerChoiceStrategy
Implementation of IPool.setWorkerChoiceStrategyOptions
Private
setProtected
setupPrivate
shallPrivate
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.
Starts the minimum number of workers in this pool.
+Private
taskPrivate
tasksPrivate
tasksPrivate
unsetPrivate
unsetPrivate
updatePrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerProtected
workerThis function is the listener registered for each worker message.
-The listener function to execute when a message is received from a worker.
- -This function 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
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:
+
+
-
-
+
+
'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 concurrently their tasks quota.'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 maximum 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.'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