X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=93f4694004b0290113fc74ab1cb6a676cc29565e;hb=460aaab4b4cb6857827d3e56e11122bffc01db8a;hp=39bf3862b55dde4572e9e3f553d8d0e96955d5d7;hpb=e83f3916315e18f3ca0c614d6ec9e064ab76c13c;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 39bf3862..93f46940 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,84 +1,187 @@ -IPool | poolifier
+IPool | poolifier
-
+
-
+
-

Interface IPool<Data, Response>

+

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

-
+

Type Parameters

-
    +
    • -

      Data = unknown

      +

      Worker extends IWorker

      +

      Type of worker which manages this pool.

      +
      • +
    • +

      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

    -
  • IPool
+
+

Implemented by

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

    Methods

    -
    destroy -execute -setWorkerChoiceStrategy +

    Properties

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

    Methods

    -
    +

    Properties

    +

    destroy

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

      Type declaration

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

        • Shutdowns every current worker in this pool.

          -

          Returns Promise<void>

    +
    +

    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.
      • +
    • 'error': Emitted when an uncaught error occurs.
      • +
    • 'taskError': Emitted when an error occurs while executing a task.
      • +
    +
    +
    +

    enableTasksQueue

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

    Type declaration

    +
      +
    • +
        +
      • (enable, tasksQueueOptions?): void
        • +
      • +

        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

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

    execute

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

      Type declaration

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

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

          - -

          Returns

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

          +

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

          Parameters

          • -
            data: Data
            -

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

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

    +
    +

    Readonly info

    +
    info: PoolInfo
    +

    Pool information.

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

    setTasksQueueOptions

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

    Type declaration

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

        Sets the worker tasks queue options in this pool.

        +
        +
        +

        Parameters

        +
        +

        Returns void

    +

    setWorkerChoiceStrategy

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

      Type declaration

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

        • Sets the worker choice strategy in this pool.

          @@ -86,16 +189,50 @@

          Parameters

          • -
            workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "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.

            +
            • +
          • +
            Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
            +

            The worker choice strategy options.

      -

      Returns void

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

    setWorkerChoiceStrategyOptions

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

    Type declaration

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

        Sets the worker choice strategy options in this pool.

        +
        +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Readonly workerNodes

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

    Pool worker nodes.

    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -105,21 +242,70 @@
    • -

    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