X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=fdaa85b21e5b0882c478d62dad99358cfd3c0acf;hb=3882157ecadc80e686b319068bd73a9cc218e10c;hp=c7323502811497d57439240f1692d47b9ae3f03b;hpb=cea16128a949e8f118627f00ccb33b08db281c45;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index c7323502..26706be5 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 >= pool maximum size^2).Readonly
enablePerforms the task specified in the constructor with the data parameter.
+Enables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Readonly
executeExecutes 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
name: stringThe 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.
-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.
-true
if the worker node has back pressure, false
otherwise.
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 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
Contract definition for a poolifier pool.
-