X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=072c9da05dae4cb0411cc9c601675033feef32ac;hb=b2862722f44d3facf07a2e632d25d261f3dabbce;hp=657aae19b171b6d18ab2cf59ba5b1ea525035b70;hpb=5e7fdc4a7f8c01824825abd4ad57ec787a4beea7;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 657aae19..072c9da0 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 task 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
Readonly
startingPrivate
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
maxProtected
Abstract
minProtected
minPrivate
readyProtected
Abstract
typePrivate
utilizationProtected
Abstract
workerAdds 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.
Private
addhttps://nodejs.org/api/errors.html#class-error If the added worker node is not found.
Protected
afterProtected
afterProtected
beforePrivate
buildPrivate
checkPrivate
checkProtected
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkThe received message.
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
Private
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
chooseProtected
createProtected
createProtected
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.
+Protected
Abstract
destroyEnables/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.
Private
enqueueExecutes the specified function in the worker constructor with the task data input parameter.
Optional
data: DataThe task input data for the specified task 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 task function to execute. If not specified, the default task 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.
@@ -760,7 +867,7 @@ Can be overridden.Private
executeProtected
flushPrivate
flushProtected
getPrivate
getPrivate
getThe worker id.
Private
Readonly
handlePrivate
Readonly
handlePrivate
handlePrivate
handlePrivate
hasPrivate
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
redistributeProtected
Abstract
registerRegisters once a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
Abstract
registerPrivate
removeProtected
sendProtected
Abstract
sendPrivate
sendPrivate
sendPrivate
sendProtected
Abstract
sendSends a message to worker given its worker node key.
The message.
Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Private
sendSends the worker statistics message to worker given its worker node key.
+Sets the default task function in this pool.
The worker node key.
+The name of the task function.
true
if the default task function was set, false
otherwise.
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.
Private
setPrivate
setProtected
setupPrivate
shallPrivate
startPrivate
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
tasksPrivate
unsetPrivate
unsetPrivate
updatePrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerProtected
workerThis method is the listener registered for each worker message.
-The listener function to execute when a message is received from a worker.
- -This method 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
+ \ No newline at end of file
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:
-
-
+
+
+
+
'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.'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.'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