X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=ff7878f0b7e8b6b16d6551605d12b7ca51350006;hb=da66e34cda2cbcb3a94865d24696c668f50a1437;hp=740e3b8eb00235c2d5f748a35952d59f3e1aafe5;hpb=71056a0ac555e096c1428d6341ef45c7980a6332;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 740e3b8e..ff7878f0 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier
+IPool | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    @@ -29,12 +29,12 @@

  • Data = unknown

    -

    Type of data sent to the worker. This can only be serializable data.

    +

    Type of data sent to the worker. This can only be structured-cloneable data.

  • Response = unknown

    -

    Type of execution response. This can only be serializable data.

    +

    Type of execution response. This can only be structured-cloneable data.

    • @@ -46,28 +46,31 @@
    +
  • Defined in src/pools/pool.ts:205
    • - +

    Properties

    -
    destroy +
    destroy emitter? enableTasksQueue execute +hasWorkerNodeBackPressure info +listTaskFunctions setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions +start workerNodes

    Properties

    -

    destroy

    +

    Readonly destroy

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

    Type declaration

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

      Shutdowns every current worker in this pool.

      +

      Terminates all workers in this pool.

      Returns Promise<void>

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

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

    enableTasksQueue

    +

    Readonly enableTasksQueue

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

    Type declaration

    @@ -107,34 +113,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:293
    • -

    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 +149,49 @@
        • Optional data: Data
          -

          The task input data for the specified worker function. This can only be serializable 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:250
    • +
    +

    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,40 +199,57 @@
    +
  • Defined in src/pools/pool.ts:213
    • +
    +

    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.

        +

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

    setWorkerChoiceStrategy

    +

    Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

    Type declaration

      • -
      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void
        • +
      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void

      • Sets the worker choice strategy in this pool.

        @@ -204,7 +257,7 @@

        Parameters

        • -
          workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
          +
          workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

          The worker choice strategy.

          • @@ -216,16 +269,16 @@

          Returns void

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

    setWorkerChoiceStrategyOptions

    +

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

      • -
      • (workerChoiceStrategyOptions): void
        • +
      • (workerChoiceStrategyOptions): void

      • Sets the worker choice strategy options in this pool.

        @@ -240,28 +293,44 @@

        Returns void

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

    Readonly start

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

    Type declaration

    +
      +
    • +
        +
      • (): void
        • +
      • +

        Starts the minimum number of workers in this pool.

        +
        +

        Returns void

        +
    -

    Readonly workerNodes

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

    Readonly Internal workerNodes

    +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -272,64 +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