X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e306ebe9c5021637043ffb8fb5f345c46cc09b4e;hb=36bbc24763855c9e69db294545404e0e3adbae85;hp=08cf199db605182faa03c59bc7b3ef5e04cd156b;hpb=f04db52f666beefda86a0444fb9a28d410211b3f;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 08cf199d..e306ebe9 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -
Protected
Readonly
fileProtected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
+Protected
Readonly
numberProtected
Readonly
optsProtected
promisePrivate
Readonly
startPrivate
startedWhether the pool is started or not.
+Private
Readonly
startingProtected
workerReadonly
workerReadonly
Internal
workerPool worker nodes.
Protected
fullProtected
Abstract
maxProtected
maxProtected
Abstract
minProtected
minPrivate
readyProtected
Abstract
typePrivate
utilizationProtected
Abstract
workerThe worker type.
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
Protected
afterProtected
afterProtected
beforePrivate
buildPrivate
checkPrivate
checkPrivate
checkPrivate
checkProtected
checkPrivate
checkPrivate
checkhttps://nodejs.org/api/errors.html#class-error If the worker id is invalid.
Private
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
chooseProtected
createProtected
createProtected
Abstract
createPrivate
dequeueProtected
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 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.
@@ -760,7 +813,7 @@ Can be overridden.Private
executeProtected
flushPrivate
flushProtected
getPrivate
getPrivate
getPrivate
handlePrivate
handlePrivate
hasProtected
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
registerPrivate
removeProtected
sendProtected
Abstract
sendProtected
Abstract
sendPrivate
sendSends a message to worker given its worker node key.
+Sends the statistics message to worker given its worker node key.
The worker node key.
The message.
-Private
sendProtected
Abstract
sendSends the worker statistics message to worker given its worker node key.
+Sends a message to worker given its worker node key.
The worker node key.
The message.
+Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Sets 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
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.
Private
startPrivate
taskPrivate
tasksPrivate
tasksPrivate
updatePrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerGenerated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
Emitter on which events can be listened to.
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).