X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=f2be816aa26c6b07d2bd10a30f95af68045c57b6;hb=4e1212db1d198963828820471bde6902277d0388;hp=5f3005ffccbc63730c4117fd06db226d3a0ec71f;hpb=a47027a0bf90ce21b528708dadd0eb23b5537b43;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 5f3005ff..f2be816a 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,13 +1,13 @@ -
Protected
Readonly
fileProtected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
+Protected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
workerReadonly
workerReadonly
Internal
workerPool worker nodes.
Protected
fullProtected
maxThe pool maximum size.
Protected
minThe pool minimum size.
Private
readyProtected
typePrivate
utilizationProtected
workerProtected
afterProtected
beforeProtected
checkProtected
createProtected
createProtected
createProtected
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.
Executes 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.
@@ -546,7 +566,7 @@ Can be overridden.Protected
flushProtected
getProtected
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
isProtected
registerProtected
sendProtected
sendProtected
sendSends a message to worker given its 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.
Protected
setupProtected
workerGenerated using TypeDoc
Generated using TypeDoc
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).