X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=b3ec1fcd098b9a7c331027fd555c2115cbef04e9;hb=15bb637a91abd156aae586ce14c663101a8c6697;hp=61d1b615339d614f5a4bdc682e20f12d7041e67f;hpb=ec06e4dd01adf7aa4bab470c59da42c19d863d0b;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 61d1b615..b3ec1fcd 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -14,7 +14,7 @@ -

Interface IPool<Data, Response>

+

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

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

Type Parameters

Hierarchy

@@ -44,8 +52,14 @@

Properties

Properties

@@ -63,7 +77,7 @@

Returns Promise<void>

+
  • Defined in src/pools/pool.ts:163
  • emitter?: PoolEmitter
    @@ -75,40 +89,107 @@
    +
  • Defined in src/pools/pool.ts:142
  • +
    + +
    enableTasksQueue: ((enable: boolean, tasksQueueOptions?: TasksQueueOptions) => void)
    +
    +

    Type declaration

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

    Type declaration

    +
  • Defined in src/pools/pool.ts:159
  • +
    + +
    findFreeWorkerNodeKey: (() => number)
    +
    +

    Type declaration

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

    Type declaration

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

    Type declaration

    Returns void

    +
  • Defined in src/pools/pool.ts:170
  • +
    + +
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => void)
    +
    +

    Type declaration

    +
    +
    + +
    type: PoolType
    +

    Pool type.

    +

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

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

    Pool worker nodes.

    +
    +
  • findFreeWorkerNodeKey
  • +
  • setTasksQueueOptions
  • +
  • setWorkerChoiceStrategy
  • +
  • setWorkerChoiceStrategyOptions
  • +
  • type
  • +
  • workerNodes