X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=e8b72506f4c49ce6987cf3c620b54dd1296f57f9;hb=6cd5248f7b289828220cac63f8fe77d021c572e9;hp=c44a88aa1c850c9d206bd19790d7e6b594697ce1;hpb=b667be1103b9362ae29d094de05f812468464d4f;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index c44a88aa..e8b72506 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Readonly
destroyOptional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'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.'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.
+Optional
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
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
+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.
+Optional
Promise that will be fulfilled when the task is completed.
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
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.
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
Readonly
setSets the worker choice strategy options in this pool.
The worker choice strategy options.
-Readonly
workerReadonly
Internal
workerPool worker nodes.
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Terminates every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>