X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=7205a9f1379b20393b207782b2df174c2fc238a5;hb=22c85455d2f30345148aa3e1304d3b0840102f72;hp=3c6ad18f2bd08808bb6087cf236ca8d602453b9e;hpb=6f0e7f0609e779dbf314d3f1a31660e7d369f591;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 3c6ad18f..7205a9f1 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Type of data sent to the worker. This can only be serializable data.
-Type of worker which manages this pool.
+Type of response of execution. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of execution response. This can only be structured-cloneable data.
+Optional
Readonly
emitterReadonly
destroyTerminates all workers in this pool.
+Optional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
'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 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
enableShutdowns every current worker in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Optional
Readonly
executePerforms the task specified in the constructor with the data parameter.
+Executes the specified function in the worker constructor with the task data input parameter.
+Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
Optional
name: stringThe 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.
-Promise that will be resolved when the task is successfully completed.
+Readonly
hasInternal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
The input for the specified task. This can only be serializable data.
+The worker node key.
true
if the worker node has back pressure, false
otherwise.
Readonly
infoPool information.
+Readonly
listLists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Readonly
setSets the worker node tasks queue options in this pool.
+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
Internal
workerPool worker nodes.
+Generated using TypeDoc
Generated using TypeDoc
Contract definition for a poolifier pool.
-