X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=f6dbd0ce3b65a4ad520c18ec1c3647da6b675961;hb=969223ea18802a84dfea369e254332e11bf8e419;hp=57e9ccccfead65be11efd5eb325a391180142862;hpb=0e16e60a89029abe61cda7ba293c036298cced05;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 57e9cccc..f6dbd0ce 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.26
+IPool | poolifier - v2.6.33
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.26
+
  • The search index is not available
  • poolifier - v2.6.33
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:181
  • @@ -58,6 +58,7 @@ emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info listTaskFunctions setTasksQueueOptions @@ -82,23 +83,25 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:234
  • 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 >= maximum queue size).
    +
  • Defined in src/pools/pool.ts:217
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -109,25 +112,25 @@
    • (enable, tasksQueueOptions?): void
    • -

      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: TasksQueueOptions
        -

        The worker tasks queue options.

        +

        The worker node tasks queue options.

      Returns void

    +
  • Defined in src/pools/pool.ts:265
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -162,7 +165,32 @@
    +
  • Defined in src/pools/pool.ts:226
  • +
    + +
    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:189
  • listTaskFunctions: (() => string[])
    @@ -179,7 +207,7 @@
    +
  • Defined in src/pools/pool.ts:240
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -196,22 +224,22 @@
    +
  • Defined in src/pools/pool.ts:274
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -220,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:247
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -249,7 +277,7 @@
    +
  • Defined in src/pools/pool.ts:256
  • - +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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