X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=089d3914170dc88a6b071f5e1a68bf46ecdde8cd;hb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;hp=98a3dbfbeb4b07937ae4b88c9a004e3558eeb830;hpb=5e972953bf3193a557a14fa794d559b2acc1d6de;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 98a3dbfb..089d3914 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.18
+IPool | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.18
+
  • The search index is not available
  • poolifier - v2.6.40
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:182
  • @@ -58,7 +58,9 @@ emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info +listTaskFunctions setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -76,28 +78,30 @@
    • (): Promise<void>
    • -

      Terminates every current worker in this pool.

      +

      Terminates all workers in this pool.

      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,34 +112,32 @@
    • (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.

      +
      Optional

    Returns void

    +
  • Defined in src/pools/pool.ts:266
  • -
    execute: ((data?, name?) => Promise<Response>)
    +
    execute: ((data?, name?, transferList?) => Promise<Response>)

    Type declaration

      • -
      • (data?, name?): Promise<Response>
      • +
      • (data?, name?, transferList?): Promise<Response>
      • Executes the specified function in the worker constructor with the task data input parameter.

        @@ -144,19 +146,45 @@
        • Optional data: Data
          -

          The task input data for the specified worker function. This can only be structured-cloneable data.

          -
          -
        • +

          The optional task input data for the specified task function. This can only be structured-cloneable data.

          +
          Optional
        • Optional name: string
          -

          The name of the worker function to execute. If not specified, the default worker function will be executed.

          -
          -
    +

    The optional name of the task function to execute. If not specified, the default task function will be executed.

    +
    Optional +
  • +
    Optional transferList: TransferListItem[]
    +

    An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

    +
    Optional
  • Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
  • 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
    @@ -164,7 +192,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)
    @@ -173,22 +218,21 @@
    +
  • Defined in src/pools/pool.ts:275
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -197,7 +241,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:248
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -226,7 +268,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:257
  • - +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file