X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=e8b72506f4c49ce6987cf3c620b54dd1296f57f9;hb=6cd5248f7b289828220cac63f8fe77d021c572e9;hp=fa5693f5038395cc509a11608b576aba5a23e309;hpb=7e36fa9f0f844e3e60f0c22de3e28665dd8cc9d1;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index fa5693f5..e8b72506 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Type of worker which manages this pool.
-Type of data sent to the worker. 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 serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Readonly
destroyShutdowns every current worker in this pool.
+Terminates all workers in this pool.
Optional
Readonly
emitterOptional
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 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.
Readonly
infoPool information.
+Readonly
listFinds a free worker node key based on the number of tasks the worker has applied.
-If a worker is found with 0
running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1
is returned.
Lists the names of task function available in this pool.
+The names of task function available in this pool.
-A worker node key if there is one, -1
otherwise.
Readonly
setSets the worker node tasks queue options in this pool.
Readonly
setSets the worker choice strategy in this pool.
The worker choice strategy.
-Readonly
typePool type.
-If it is 'dynamic'
, it provides the max
property.
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
Contract definition for a poolifier pool.
-