X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=ff7878f0b7e8b6b16d6551605d12b7ca51350006;hb=41e3e08eb7fbcde0a69cea17e697aacb222990a6;hp=d6ec3d6cf983bf8dc984a454794b77c0c112311f;hpb=89757908a0cf61d60dcf28323c5c23c4ef66fcf2;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index d6ec3d6c..ff7878f0 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.26
+IPool | poolifier - v2.6.45
-
+
  • The search index is not available
  • poolifier - v2.6.45 +
    @@ -46,29 +46,31 @@ +
  • Defined in src/pools/pool.ts:205
  • - +

    Properties

    - +
    destroy: (() => Promise<void>)

    Type declaration

    @@ -82,23 +84,25 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:262
  • 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.
    • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    • +
    • '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:241
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -109,25 +113,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:293
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -162,7 +166,32 @@
    +
  • Defined in src/pools/pool.ts:250
  • +
    + +
    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 +199,7 @@
    +
  • Defined in src/pools/pool.ts:213
  • listTaskFunctions: (() => string[])
    @@ -179,7 +208,7 @@
    +
  • Defined in src/pools/pool.ts:268
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -196,22 +225,22 @@
    +
  • Defined in src/pools/pool.ts:302
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -220,7 +249,7 @@
    +
  • Defined in src/pools/pool.ts:275
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -249,7 +278,7 @@
    +
  • Defined in src/pools/pool.ts:284
  • +
    + +
    start: (() => void)
    +
    +

    Type declaration

    +
    - +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:219
  • @@ -296,74 +341,39 @@
  • emitter
  • enableTasksQueue
  • execute
  • +
  • hasWorkerNodeBackPressure
  • info
  • listTaskFunctions
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • +
  • start
  • workerNodes
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file