X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=c6e2995e72f26d899d8bb6aaed60a5b8c82f28e3;hb=8d1797ad15cb2d87ac3c9904ce6df3db45c0c742;hp=071c59d5926ddfbe3a763dd6300d28b8d70476e5;hpb=94ab998f44abe7ed2184a0702c45621b06f5641f;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 071c59d5..c6e2995e 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.

@@ -22,19 +22,27 @@

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
@@ -42,31 +50,37 @@

Properties

-
destroy -emitter? -execute -setWorkerChoiceStrategy +
destroy +emitter? +enableTasksQueue +execute +findFreeWorkerNodeKey +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +type +workerNodes

Properties

-
+

destroy

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

Type declaration

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

      • Shutdowns every current worker in this pool.

        -

        Returns Promise<void>

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

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    +
    emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      @@ -75,40 +89,107 @@
    -
    +
  • Defined in src/pools/pool.ts:142
    • +
    +

    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

    +

    execute

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

    Type declaration

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

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

        + +

        Returns

        Promise that will be fulfilled when the task is completed.

        +
        +
        +

        Parameters

        +
          +
        • +
          Optional data: Data
          +

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

          +
        +

        Returns Promise<Response>

    +
    +

    findFreeWorkerNodeKey

    +
    findFreeWorkerNodeKey: (() => number)

    Type declaration

    • -
        -
      • (data: Data): Promise<Response>
        • +
          +
        • (): number
        • -

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

          +

          Finds a free worker node key based on the number of tasks the worker has applied.

          +

          If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.

          +

          If no free worker is found, -1 is returned.

          -

          Returns

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

          +

          Returns

          A worker node key if there is one, -1 otherwise.

          +
          +

          Returns number

    +
    +

    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.

          +
          tasksQueueOptions: TasksQueueOptions
          +

          The worker tasks queue options.

        -

        Returns Promise<Response>

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

    setWorkerChoiceStrategy

    -
    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)
    +
    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.

          @@ -116,16 +197,58 @@

          Parameters

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

            The worker choice strategy.

            +
            • +
          • +
            Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
            +

            The worker choice strategy options.

            +
    +

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

    Readonly type

    +
    type: PoolType
    +

    Pool type.

    +

    If it is 'dynamic', it provides the max property.

    +
    +
    +

    Readonly workerNodes

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

    Pool worker nodes.

    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -135,22 +258,65 @@
    • -

    Theme

    -
    +
    +

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

    Generated using TypeDoc

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