X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=99b3123235930202c64ede122fdb3b70af5ef328;hb=4ee786575c19cfc95faa0dfc2671b3ab8f680402;hp=41d1256abeb7f27f1cef3ed10e42066cbdff8a4d;hpb=f04db52f666beefda86a0444fb9a28d410211b3f;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 41d1256a..99b31232 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -
Readonly
addThe 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.
Readonly
destroyReadonly
destroyTerminates all workers in this pool.
Optional
Readonly
emitterEmitter on which events can be listened to.
+Event 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).Readonly
enableEnables/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.
Readonly
executeExecutes 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.
Readonly
hasWhether the specified task function exists in this pool.
+The name of the task function.
+true
if the task function exists, false
otherwise.
Readonly
hasInternal
+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.
Readonly
infoReadonly
listLists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Readonly
removeRemoves a task function from this pool.
+The name of the task function.
+true
if the task function was removed, false
otherwise.
Readonly
setSets the default task function in this pool.
+The name of the task function.
+true
if the default task function was set, false
otherwise.
Readonly
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.
Readonly
setSets the worker choice strategy in this pool.
Readonly
setSets the worker choice strategy options in this pool.
Readonly
startStarts the minimum number of workers in this pool.
+Readonly
workerReadonly
Internal
workerPool worker nodes.
Generated using TypeDoc
Generated using TypeDoc
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+