X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=49561424d415e22520b0d7118a81b4e3afe65aa4;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=1135bfdc7c48600d194d29e380410af18d594b98;hpb=019581cc38fe0b47645d9b2120f325ab37388be2;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 1135bfdc..49561424 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Optional
Readonly
emitterdestroy
': 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.
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