X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=d706dad9582035dcadb4311ddd3455441468ff05;hb=9867896b122160ea5d8e6dbccba4cc5916bf523b;hp=26706be591388e6711d133b5d89c868b9567d7b9;hpb=46e29227a97fe04f886969199f1c14338af50543;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 26706be5..d706dad9 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.30
+IPool | poolifier - v2.6.45
-
+
  • The search index is not available
  • poolifier - v2.6.45 +
    @@ -46,15 +46,15 @@ +
  • Defined in src/pools/pool.ts:205
  • - +

    Properties

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

    Type declaration

    @@ -83,7 +84,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:262
  • emitter?: PoolEmitter
    @@ -91,17 +92,17 @@

    Events that can currently be listened to:

    • '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.
    • +
    • '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).
    • +
    • '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)
    @@ -112,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>)
    @@ -165,7 +166,7 @@
    +
  • Defined in src/pools/pool.ts:250
  • hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -190,7 +191,7 @@
    +
  • Defined in src/pools/pool.ts:227
  • info: PoolInfo
    @@ -198,7 +199,7 @@
    +
  • Defined in src/pools/pool.ts:213
  • listTaskFunctions: (() => string[])
    @@ -215,7 +216,7 @@
    +
  • Defined in src/pools/pool.ts:268
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -226,20 +227,20 @@
    +
  • Defined in src/pools/pool.ts:302
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -268,7 +269,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:275
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -292,7 +293,23 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:284
  • +
    + +
    start: (() => void)
    +
    +

    Type declaration

    +
    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -300,20 +317,20 @@
    +
  • Defined in src/pools/pool.ts:219
  • @@ -330,70 +347,33 @@
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • +
  • start
  • workerNodes
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file