X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=d8db2d20198d8e9160999648076707e9f1c3202d;hb=e905ea64c054a25ef73885e41fc063279bc599ca;hp=a0145ff4ed8c9672193021d82f4f81366d7e72ac;hpb=c65efde664ab9e4dcd2ed9e827d8171e7e081359;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index a0145ff4..d8db2d20 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.24
+IPool | poolifier - v2.6.44
-
+
  • The search index is not available
  • poolifier - v2.6.44 +
    @@ -46,19 +46,21 @@ +
  • Defined in src/pools/pool.ts:182
  • - +

    Properties

    -
    destroy +
    destroy emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info +listTaskFunctions setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -67,7 +69,7 @@

    Properties

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

    Type declaration

    @@ -81,23 +83,25 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:235
  • 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:218
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -108,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:266
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -161,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
    @@ -169,7 +198,24 @@
    +
  • Defined in src/pools/pool.ts:190
  • +
    + +
    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,22 +224,22 @@
    +
  • Defined in src/pools/pool.ts:275
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -202,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:248
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -231,7 +277,7 @@
    +
  • Defined in src/pools/pool.ts:257
  • - +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:196
  • @@ -278,73 +324,38 @@
  • emitter
  • enableTasksQueue
  • execute
  • +
  • hasWorkerNodeBackPressure
  • info
  • +
  • listTaskFunctions
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • workerNodes
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file