X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=740e3b8eb00235c2d5f748a35952d59f3e1aafe5;hb=71056a0ac555e096c1428d6341ef45c7980a6332;hp=43cd610eefdf892c836cea47fbc633cc309784b7;hpb=0770fe626b2bb3212a1d73fa4764973ac92e241a;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 43cd610e..740e3b8e 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier
+IPool | poolifier
-
+
-

Interface IPool<Data, Response>

+

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

-
-
+
+
+

Type Parameters

-
    +
      +
    • +

      Worker extends IWorker

      +

      Type of worker which manages this pool.

      +
      +
    • -

      Data = unknown

      +

      Data = unknown

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

      -
      • +
+
  • -

    Response = unknown

    -

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

    -
    • +

    Response = unknown

    +

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

    +
    +

    Hierarchy

    @@ -42,72 +54,149 @@

    Properties

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

    Properties

    -
    -

    destroy

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

    destroy

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

    Type declaration

    • -
        -
      • (): Promise<void>
        • +
          +
        • (): Promise<void>

        • Shutdowns every current worker in this pool.

          -

          Returns Promise<void>

    -
    -

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    +
  • Defined in src/pools/pool.ts:191
    • +
    +

    Optional Readonly emitter

    +
    emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'busy'
      • +
    • 'full': Emitted when the pool is dynamic and full.
      • +
    • 'busy': Emitted when the pool is busy.
      • +
    • 'error': Emitted when an uncaught error occurs.
      • +
    • 'taskError': Emitted when an error occurs while executing a task.
    -
    -
    -

    execute

    -
    execute: ((data: Data) => Promise<Response>)
    +
  • Defined in src/pools/pool.ts:179
    • +
    +

    enableTasksQueue

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

    Type declaration

    • -
        -
      • (data: Data): Promise<Response>
        • +
          +
        • (enable, tasksQueueOptions?): void
        • -

          Performs the task specified in the constructor with the data parameter.

          +

          Enables/disables the worker tasks queue in this pool.

          +
          +
          +

          Parameters

          +
            +
          • +
            enable: boolean
            +

            Whether to enable or disable the worker tasks queue.

            +
            +
            • +
          • +
            Optional tasksQueueOptions: TasksQueueOptions
            +

            The worker tasks queue options.

            +
            +
          +

          Returns void

          +
    +
    +

    execute

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

    Type declaration

    +
      +
    • +
        +
      • (data?, name?): Promise<Response>
        • +
      • +

        Executes the specified function in the worker constructor with the task data input parameter.

        +
        +
        +

        Parameters

        +
          +
        • +
          Optional data: Data
          +

          The task input data for the specified worker function. This can only be serializable data.

          +
          +
          • +
        • +
          Optional name: string
          +

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

          +
          +
        +

        Returns Promise<Response>

        Promise that will be fulfilled when the task is completed.

        -

        Returns

        Promise that will be resolved when the task is successfully completed.

        +
    +
    +

    Readonly info

    +
    info: PoolInfo
    +

    Pool information.

    +
    +
    +
    +

    setTasksQueueOptions

    +
    setTasksQueueOptions: ((tasksQueueOptions) => void)
    +
    +

    Type declaration

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

        Sets the worker tasks queue options in this pool.

        Parameters

        • -
          data: Data
          -

          The input for the specified task. This can only be serializable data.

          -
        -

        Returns Promise<Response>

    -
    -

    setWorkerChoiceStrategy

    -
    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)
    +
  • Defined in src/pools/pool.ts:225
    • +
    +

    setWorkerChoiceStrategy

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

    Type declaration

    • -
        -
      • (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
        • +
          +
        • (workerChoiceStrategy, workerChoiceStrategyOptions?): void

        • Sets the worker choice strategy in this pool.

          @@ -115,16 +204,56 @@

          Parameters

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

            The worker choice strategy.

            -
    -

    Returns void

    +
    +

    setWorkerChoiceStrategyOptions

    +
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    +
    +

    Type declaration

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

        Sets the worker choice strategy options in this pool.

        +
        +
        +

        Parameters

        +
        +

        Returns void

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

    Readonly workerNodes

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

    Pool worker nodes.

    +
    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -134,22 +263,73 @@
    • -

    Theme

    -
    +
    +

    On This Page
    - -
    +
  • destroy
    • +
  • emitter
    • +
  • enableTasksQueue
    • +
  • execute
    • +
  • info
    • +
  • setTasksQueueOptions
    • +
  • setWorkerChoiceStrategy
    • +
  • setWorkerChoiceStrategyOptions
    • +
  • workerNodes
    • +
    +
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file