X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=e47007644f326d0f597368c00ba04242c6cce985;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=488af2256da5e6129e0d55a34e7cda2bc7b4bea0;hpb=c0b0686de0f8c5483b20b94fac97d2b8175c0556;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 488af225..e4700764 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,18 +1,20 @@ -IPool | poolifier
+IPool | poolifier
-
+
-
+
-

Interface IPool<Data, Response>

+

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

@@ -20,82 +22,233 @@

Type Parameters

Hierarchy

    -
  • IPool
-

Methods

-
destroy -execute -setWorkerChoiceStrategy +

Properties

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

Methods

-
+

Properties

+

destroy

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

    Type declaration

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

        Shut down every current worker in this pool.

        +

        Shutdowns every current worker in this pool.

        -

        Returns Promise<void>

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

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

    enableTasksQueue

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

    Type declaration

    +
      +
    • +
        +
      • (enable: boolean, tasksQueueOptions?: 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>)
      +
      +

      Type declaration

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

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

          +

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

          -

          Returns

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

          +

          Returns

          Promise that will be fulfilled when the task is completed.

          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.

          -

          Returns Promise<Response>

    +
    +

    findFreeWorkerNodeKey

    +
    findFreeWorkerNodeKey: (() => number)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (): number
        • +
      • +

        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

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

        +
        +

        Returns number

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

    setTasksQueueOptions

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

    Type declaration

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

        Sets the worker tasks queue options in this pool.

        +
        +
        +

        Parameters

        +
        +

        Returns void

    +

    setWorkerChoiceStrategy

    -
      - +
      setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)
      +
      +

      Type declaration

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

          Set the worker choice strategy in this pool.

          +

          Sets the worker choice strategy in this pool.

          Parameters

          • -
            workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
            +
            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: WorkerChoiceStrategyOptions) => void)
    +
    +

    Type declaration

    +
      +
    • +
    +
    +

    Readonly type

    +
    type: PoolType
    +

    Pool type.

    +

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

    +
    +
    +

    Readonly workerNodes

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

    Pool worker nodes.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -106,20 +259,64 @@

    • Theme

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