X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=4d24d8d5c9d1f1103dc8c8e25269d6f791f3e402;hb=f9a95a93439b96a3ba1262ef807e1ba39b65bca4;hp=5e8ceb76f84d47a8c1fd4f1d335bec4060a9200f;hpb=c0b0686de0f8c5483b20b94fac97d2b8175c0556;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 5e8ceb76..4d24d8d5 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,11 +1,13 @@ DynamicClusterPool | poolifier
-
+
@@ -16,11 +18,7 @@

A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's emitter.

- -

Template

of data sent to the worker. This can only be serializable data.

- -

Template

of response of execution. This can only be serializable data.

+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

Author

Christopher Quadflieg

@@ -30,9 +28,13 @@ When the maximum number of workers is reached, an event is emitted. If you want

Type Parameters

  • -

    Data = unknown

    • +

    Data = unknown

    +

    Type of data sent to the worker. This can only be serializable data.

    +
  • -

    Response = unknown

+

Response = unknown

+

Type of response of execution. This can only be serializable data.

+

Hierarchy

    @@ -40,7 +42,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    • DynamicClusterPool
+
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -54,40 +56,36 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Properties

    emitter? filePath -max -nextMessageId +max numberOfWorkers opts -promiseMap -tasks +promiseResponseMap workerChoiceStrategyContext -workers +workerNodes

    Accessors

    busy -numberOfRunningTasks +full +numberOfQueuedTasks +numberOfRunningTasks type

    Methods

    -
    afterWorkerSetup -chooseWorker +
    afterTaskExecutionHook +afterWorkerSetup +beforeTaskExecutionHook +chooseWorkerNode createAndSetupWorker createWorker -decreaseWorkersTasks destroy destroyWorker execute -findFreeWorker -getWorkerIndex -getWorkerRunningTasks -increaseWorkersTask -internalExecute -internalGetBusyStatus +findFreeWorkerNodeKey +internalBusy isMain registerWorkerMessageListener -removeWorker sendToWorker setWorkerChoiceStrategy setupHook @@ -98,7 +96,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    constructor

      - +

    • Constructs a new poolifier dynamic cluster pool.

      @@ -125,95 +123,84 @@ When the maximum number of workers is reached, an event is emitted. If you want

      Path to an implementation of a ClusterWorker file, which can be relative or absolute.

    • -
      Optional opts: ClusterPoolOptions = {}
      +
      opts: ClusterPoolOptions = {}

      Options for this dynamic cluster pool.

    Returns DynamicClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/dynamic.ts:28

    • Properties

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    +
    emitter?: PoolEmitter

    Inherit Doc

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

    • Readonly filePath

    -
    filePath: string
    -
    +
  • Defined in src/pools/abstract-pool.ts:68
    • +

    Readonly max

    max: number
    -
    -

    Inherit Doc

    -
    -

    Protected nextMessageId

    -
    nextMessageId: number = 0
    -

    Id of the next message.

    +

    Maximum number of workers that can be created by this pool.

    +
  • Defined in src/pools/cluster/dynamic.ts:30

    • Readonly numberOfWorkers

    -
    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:67

    • Readonly opts

    -
    opts: ClusterPoolOptions = {}
    -
    -

    Protected promiseMap

    -
    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    -

    The promise map.

    +
  • Defined in src/pools/cluster/fixed.ts:53
    • +
    +

    Protected promiseResponseMap

    +
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    +

    The execution response promise map.

      -
    • key: This is the message Id of each submitted task.
      • -
    • value: An object that contains the worker, the resolve function and the reject function.
      • +
    • key: The message id of each submitted task.
      • +
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.
    -

    When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.

    +

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

    -
    -

    Readonly tasks

    -
    tasks: Map<Worker, number> = ...
    -
    -

    Inherit Doc

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    -

    Worker choice strategy instance implementing the worker choice algorithm.

    -

    Default to a strategy implementing a round robin algorithm.

    +

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Default to a round robin algorithm.

    -
    -

    Readonly workers

    -
    workers: Worker[] = []
    +
  • Defined in src/pools/abstract-pool.ts:53
    • +
    +

    Readonly workerNodes

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

    Inherit Doc

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

    • Accessors

    @@ -226,18 +213,40 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Returns boolean

    -
    -

    numberOfRunningTasks

    -
    +
    +

    full

    +
    +
    +

    Private numberOfQueuedTasks

    +
      +
    • get numberOfQueuedTasks(): number
      • +
    • +

      Number of tasks queued in the pool.

      +
      +

      Returns number

    +
    +

    Private numberOfRunningTasks

    +
      +
    • get numberOfRunningTasks(): number
      • +
    • +

      Number of tasks running in the pool.

      +

      Returns number

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

    • type

      @@ -248,9 +257,32 @@ When the maximum number of workers is reached, an event is emitted. If you want

      Returns PoolType

    +
  • Defined in src/pools/cluster/dynamic.ts:38

    • Methods

    +
    +

    Protected afterTaskExecutionHook

    +
      + +
    • +

      Hook executed after the worker task execution. +Can be overridden.

      +
      +
      +

      Parameters

      +
        +
      • +
        worker: Worker
        +

        The worker.

        +
        • +
      • +
        message: MessageValue<Response, unknown>
        +

        The received message.

        +
      +

      Returns void

    Protected afterWorkerSetup

    -
    -

    Protected chooseWorker

    +
  • Defined in src/pools/cluster/fixed.ts:93
    • +
    +

    Protected beforeTaskExecutionHook

    +
    +
    +

    Protected chooseWorkerNode

      - +
    • -

      Choose a worker for the next task.

      -

      The default implementation uses a round robin algorithm to distribute the load.

      +

      Chooses a worker node for the next task.

      +

      The default uses a round robin algorithm to distribute the load.

      -

      Returns

      Worker.

      +

      Returns

      [worker node key, worker node].

      -

      Returns Worker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    -
    -

    Protected decreaseWorkersTasks

    -
    +
  • Defined in src/pools/cluster/fixed.ts:88

    • destroy

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

    • destroyWorker

    +
  • Defined in src/pools/cluster/fixed.ts:69

    • execute

    -
    -

    findFreeWorker

    -
    -
    -

    getWorkerIndex

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

    findFreeWorkerNodeKey

    -
    -

    getWorkerRunningTasks

    -
    -
    -

    Protected increaseWorkersTask

    -
    -
    -

    Protected internalExecute

    -
    -
    -

    Protected internalGetBusyStatus

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

    Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:64

    • registerWorkerMessageListener

    -
    -

    Protected removeWorker

    -
    +
  • Defined in src/pools/cluster/fixed.ts:80

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:75

    • setWorkerChoiceStrategy

      - +

    • Inherit Doc

      @@ -544,11 +493,11 @@ When the maximum number of workers is reached, an event is emitted. If you want

      Parameters

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

    Returns void

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

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:59

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:422
    • @@ -616,34 +565,30 @@ When the maximum number of workers is reached, an event is emitted. If you want
  • constructor
  • emitter?
  • filePath
    • -
  • max
    • -
  • nextMessageId
    • +
  • max
  • numberOfWorkers
  • opts
    • -
  • promiseMap
    • -
  • tasks
    • +
  • promiseResponseMap
  • workerChoiceStrategyContext
    • -
  • workers
    • +
  • workerNodes
  • busy
    • -
  • numberOfRunningTasks
    • +
  • full
    • +
  • numberOfQueuedTasks
    • +
  • numberOfRunningTasks
  • type
    • +
  • afterTaskExecutionHook
  • afterWorkerSetup
    • -
  • chooseWorker
    • +
  • beforeTaskExecutionHook
    • +
  • chooseWorkerNode
  • createAndSetupWorker
  • createWorker
    • -
  • decreaseWorkersTasks
  • destroy
  • destroyWorker
  • execute
    • -
  • findFreeWorker
    • -
  • getWorkerIndex
    • -
  • getWorkerRunningTasks
    • -
  • increaseWorkersTask
    • -
  • internalExecute
    • -
  • internalGetBusyStatus
    • +
  • findFreeWorkerNodeKey
    • +
  • internalBusy
  • isMain
  • registerWorkerMessageListener
    • -
  • removeWorker
  • sendToWorker
  • setWorkerChoiceStrategy
  • setupHook