X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=0b232f29be2d00227a28ed520f67771f3a571334;hb=6c525543a7ed67a926b7c1f4bf98985aaad1f088;hp=39bf3862b55dde4572e9e3f553d8d0e96955d5d7;hpb=fec1c97860619dd6356803fee392205474010d5b;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 39bf3862..0b232f29 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,6 +22,10 @@

Type Parameters

+
+

Implemented by

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

    Methods

    -
    destroy -execute -setWorkerChoiceStrategy +

    Properties

    +
    busy +destroy +emitter? +execute +findFreeWorkerNodeKey +full +setWorkerChoiceStrategy +type +workerNodes
    -

    Methods

    -
    -

    destroy

    -
      - +

      Properties

      +
      +

      Readonly busy

      +
      busy: boolean
      +

      Whether the pool is busy or not.

      +

      The pool busyness boolean status.

      +
      +
      +

      destroy

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

      Type declaration

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

        • Shutdowns every current worker in this pool.

          -

          Returns Promise<void>

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

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

    execute

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

      Type declaration

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

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

          @@ -69,16 +115,48 @@

          Parameters

          • -
            data: Data
            +
            data: Data

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

          -

          Returns Promise<Response>

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

    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

    +
    +

    Readonly full

    +
    full: boolean
    +

    Whether the pool is full or not.

    +

    The pool filling boolean status.

    +
    +

    setWorkerChoiceStrategy

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

      Type declaration

      +
        +
      • +
          +
        • (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void

        • Sets the worker choice strategy in this pool.

          @@ -86,16 +164,32 @@

          Parameters

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

            The worker choice strategy.

      -

      Returns void

    +
    +

    Readonly type

    +
    type: PoolType
    +

    Pool type.

    +

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

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

    Readonly workerNodes

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

    Pool worker nodes.

    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -106,20 +200,54 @@

    • Theme

    - -
    -
    +
  • busy
    • +
  • destroy
    • +
  • emitter
    • +
  • execute
    • +
  • findFreeWorkerNodeKey
    • +
  • full
    • +
  • setWorkerChoiceStrategy
    • +
  • type
    • +
  • workerNodes
    • +
    +
    +

    Generated using TypeDoc

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