X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=30e274150032886fbe6b379f1afb57adb239e5c4;hb=4445abb25ec4c9d80985ca93c65762a6c892a852;hp=d6ec3d6cf983bf8dc984a454794b77c0c112311f;hpb=89757908a0cf61d60dcf28323c5c23c4ef66fcf2;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index d6ec3d6c..30e27415 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.26
+IPool | poolifier - v2.6.31
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.26
+
  • The search index is not available
  • poolifier - v2.6.31
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:171
  • @@ -58,6 +58,7 @@ emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info listTaskFunctions setTasksQueueOptions @@ -82,23 +83,25 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:224
  • emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • '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).
    +
  • Defined in src/pools/pool.ts:207
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -127,7 +130,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:255
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -162,7 +165,32 @@
    +
  • Defined in src/pools/pool.ts:216
  • +
    + +
    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
    @@ -170,7 +198,7 @@
    +
  • Defined in src/pools/pool.ts:179
  • listTaskFunctions: (() => string[])
    @@ -179,7 +207,7 @@
    +
  • Defined in src/pools/pool.ts:230
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -196,7 +224,7 @@
    +
  • Defined in src/pools/pool.ts:264
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -220,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:237
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -249,7 +277,7 @@
    +
  • Defined in src/pools/pool.ts:246
  • - +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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