X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=78d7a5444b3643a0c2f85c1795080a1f98dd3dae;hb=817dcda1d42ecdaf8894bea4737aa8d98eb418dc;hp=e678843dea066f4eeca2ea64ce6768a6e686812b;hpb=a13e50c30dd0e0714ace0e1ea4ea1b36cdd18ab7;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index e678843d..78d7a544 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.27
+IPool | poolifier - v2.6.35
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.27
+
  • The search index is not available
  • poolifier - v2.6.35
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:182
  • @@ -58,6 +58,7 @@ emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info listTaskFunctions setTasksQueueOptions @@ -82,7 +83,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:235
  • emitter?: PoolEmitter
    @@ -92,14 +93,15 @@
  • '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.
  • +
  • '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).
  • +
  • Defined in src/pools/pool.ts:218
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -110,25 +112,25 @@
    +
  • Defined in src/pools/pool.ts:266
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -163,7 +165,32 @@
    +
  • Defined in src/pools/pool.ts:227
  • +
    + +
    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    +
    +

    Type 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.

        + +
    info: PoolInfo
    @@ -171,7 +198,7 @@
    +
  • Defined in src/pools/pool.ts:190
  • listTaskFunctions: (() => string[])
    @@ -180,7 +207,7 @@
    +
  • Defined in src/pools/pool.ts:241
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -197,22 +224,22 @@
    +
  • Defined in src/pools/pool.ts:275
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -221,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:248
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -250,7 +277,7 @@
    +
  • Defined in src/pools/pool.ts:257
  • - +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:196