X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=d8db2d20198d8e9160999648076707e9f1c3202d;hb=4e1212db1d198963828820471bde6902277d0388;hp=e678843dea066f4eeca2ea64ce6768a6e686812b;hpb=a13e50c30dd0e0714ace0e1ea4ea1b36cdd18ab7;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index e678843d..d8db2d20 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -
Readonly
destroyReadonly
destroyOptional
Readonly
emitterEvents that can currently be listened to:
'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.'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
enableReadonly
listLists 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.
Readonly
setSets the worker choice strategy options in this pool.
Readonly
workerReadonly
Internal
workerPool worker nodes.
Generated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Parameters
enable: boolean
-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.
Returns void
Readonly
execute Worker Node Back Pressure
+Readonly
hasType declaration
++-
+
+- (workerNodeKey): boolean
+
+
+
+
Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+Parameters
++-
+
+
workerNodeKey: number
+The worker node key.
+Returns boolean
+ +true
if the worker node has back pressure,false
otherwise.Readonly
info