X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=49561424d415e22520b0d7118a81b4e3afe65aa4;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=4de49fa047c5c5c72c246d84c00ee82e56462e16;hpb=658b9aa08266ed9a8ae3c0fc947d237fa2674f09;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 4de49fa0..49561424 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.9
+IPool | poolifier - v2.6.32
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.9
+
  • The search index is not available
  • poolifier - v2.6.32
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:177
  • @@ -58,7 +58,9 @@ emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info +listTaskFunctions setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -67,7 +69,7 @@

    Properties

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

    Type declaration

    @@ -76,29 +78,32 @@
    • (): Promise<void>
    • -

      Terminates every current worker in this pool.

      +

      Terminates all workers in this pool.

      Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:230
  • 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 full.
    • -
    • 'busy': Emitted when the pool is busy.
    • +
    • '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 >= maximum queue size).
    +
  • Defined in src/pools/pool.ts:213
  • - +
    enableTasksQueue: ((enable, tasksQueueOptions?) => void)

    Type declaration

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

        @@ -143,19 +148,49 @@
        • 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 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 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:222
  • +
    + +
    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
    @@ -163,40 +198,57 @@
    +
  • Defined in src/pools/pool.ts:185
  • +
    + +
    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)

    Type declaration

      • -
      • (tasksQueueOptions): void
      • +
      • (tasksQueueOptions): void
      • -

        Sets the worker tasks queue options in this pool.

        +

        Sets the worker node tasks queue options in this pool.

        Parameters

        • tasksQueueOptions: TasksQueueOptions
          -

          The worker tasks queue options.

          +

          The worker node tasks queue options.

        Returns void

    +
  • Defined in src/pools/pool.ts:270
  • - +
    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

    Type declaration

      • -
      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void
      • +
      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void
      • Sets the worker choice strategy in this pool.

        @@ -216,16 +268,16 @@

        Returns void

    +
  • Defined in src/pools/pool.ts:243
  • - +
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

      • -
      • (workerChoiceStrategyOptions): void
      • +
      • (workerChoiceStrategyOptions): void
      • Sets the worker choice strategy options in this pool.

        @@ -240,15 +292,15 @@

        Returns void

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

    Pool worker nodes.

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