X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=26706be591388e6711d133b5d89c868b9567d7b9;hb=c38a523624d95c0329fac3d0748883c361db9d93;hp=92f13dd905df1ab0c97e3351d6517be76ad1b2d0;hpb=8ad621cc1d32ed396fca3ef2ec48337e42d2dcc2;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 92f13dd9..26706be5 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.25
+IPool | poolifier - v2.6.30
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.25
+
  • The search index is not available
  • poolifier - v2.6.30
    +
  • 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)
    @@ -126,7 +130,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:255
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -161,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
    @@ -169,7 +198,24 @@
    +
  • Defined in src/pools/pool.ts:179
  • +
    + +
    listTaskFunctions: (() => string[])
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (): string[]
      • +
      • +

        Lists the names of task function available in this pool.

        +
        +

        Returns string[]

        The names of task function available in this pool.

        + +
    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -178,7 +224,7 @@
    +
  • Defined in src/pools/pool.ts:264
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -202,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:237
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -231,7 +277,7 @@
    +
  • Defined in src/pools/pool.ts:246
  • - +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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