X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=26706be591388e6711d133b5d89c868b9567d7b9;hb=edc0cdb11d19cc5993ca98004a7dbbf49439acd8;hp=181044d6a1cfa1507091e2eb185059179ac1c24a;hpb=912e1dfaa2988c8337b3410e7acbaf859afd2212;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 181044d6..26706be5 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.8
+IPool | poolifier - v2.6.30
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.8
+
  • The search index is not available
    • poolifier - v2.6.30
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:171
    • @@ -58,7 +58,9 @@ emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info +listTaskFunctions setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -67,7 +69,7 @@

    Properties

    -

    destroy

    +

    Readonly destroy

    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:224

    • Optional Readonly emitter

    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 >= pool maximum size^2).
    +
  • Defined in src/pools/pool.ts:207
    • -

    enableTasksQueue

    +

    Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)

    Type declaration

    @@ -125,16 +130,16 @@

    Returns void

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

    execute

    -
    execute: ((data?, name?) => Promise<Response>)
    +

    Readonly execute

    +
    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:216
    • +
    +

    Readonly hasWorkerNodeBackPressure

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

        + +

    Readonly info

    info: PoolInfo
    @@ -163,16 +198,33 @@
    +
  • Defined in src/pools/pool.ts:179
    • +
    +

    Readonly listTaskFunctions

    +
    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

    +

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

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

      • Sets the worker tasks queue options in this pool.

        @@ -187,16 +239,16 @@

        Returns void

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

    setWorkerChoiceStrategy

    +

    Readonly setWorkerChoiceStrategy

    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:237
    • -

    setWorkerChoiceStrategyOptions

    +

    Readonly setWorkerChoiceStrategyOptions

    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:246
    • -

    Readonly workerNodes

    -
    workerNodes: WorkerNode<Worker, Data>[]
    +

    Readonly Internal workerNodes

    +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:185
    • @@ -272,13 +324,15 @@
  • emitter
  • enableTasksQueue
  • execute
    • +
  • hasWorkerNodeBackPressure
  • info
    • +
  • listTaskFunctions
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • workerNodes
    • -