X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=d706dad9582035dcadb4311ddd3455441468ff05;hb=9867896b122160ea5d8e6dbccba4cc5916bf523b;hp=1135bfdc7c48600d194d29e380410af18d594b98;hpb=fb8fbcfd7983c1eadc39411c9b29054e6fa97d5b;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 1135bfdc..d706dad9 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.28
+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 +
    destroy emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info listTaskFunctions setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions +start workerNodes

    Properties

    -

    Readonly destroy

    +

    Readonly destroy

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

    Type declaration

    @@ -82,7 +84,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -90,16 +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 >= maximum queue size).
    +
  • Defined in src/pools/pool.ts:241

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -110,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

    • Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -163,7 +166,32 @@
    +
  • Defined in src/pools/pool.ts:250
    • +
    +

    Readonly hasWorkerNodeBackPressure

    +
    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    +
    +

    Type declaration

    +

    Readonly info

    info: PoolInfo
    @@ -171,7 +199,7 @@
    +
  • Defined in src/pools/pool.ts:213

    • Readonly listTaskFunctions

    listTaskFunctions: (() => string[])
    @@ -180,7 +208,7 @@
    +
  • Defined in src/pools/pool.ts:268

    • Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -197,22 +225,22 @@
    +
  • Defined in src/pools/pool.ts:302

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -221,7 +249,7 @@
    +
  • Defined in src/pools/pool.ts:275

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -250,7 +278,7 @@
    +
  • Defined in src/pools/pool.ts:284
    • +
    +

    Readonly start

    +
    start: (() => void)
    +
    +

    Type declaration

    +
    -

    Readonly workerNodes

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:219
    • -

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -297,75 +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