X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=26706be591388e6711d133b5d89c868b9567d7b9;hb=3882157ecadc80e686b319068bd73a9cc218e10c;hp=45920751382ff64c0eec999f49433a94b0bf5801;hpb=f4ff239c096df6dfb39c94eb3f83fd070d3d85d8;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 45920751..26706be5 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.23
+IPool | poolifier - v2.6.30
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.23
+
  • The search index is not available
  • poolifier - v2.6.30
    +
  • Defined in src/pools/pool.ts:224
  • 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.
    • +
    • '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 >= pool maximum size^2).
    +
  • Defined in src/pools/pool.ts:207
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -126,16 +130,16 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:255
  • -
    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 +148,49 @@
        • Optional data: Data
          -

          The task input data for the specified task 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 name: string
          -

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

          +

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

          +
          +
        • +
        • +
          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.

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
  • Defined in src/pools/pool.ts:216
  • +
    + +
    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 +198,24 @@
    +
  • Defined in src/pools/pool.ts:179
  • +
    + +
    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,7 +224,7 @@
    +
  • Defined in src/pools/pool.ts:264
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -197,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:237
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -226,7 +277,7 @@
    +
  • Defined in src/pools/pool.ts:246
  • - +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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