X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=6f720e7c98342ea3ac3d0427867ba85476e0aad9;hb=fa6436344997918dbda3e94063b4c2e2e4a892c3;hp=051f7ce50d1267c4d8f903d1404441fa329dbba0;hpb=e83f3916315e18f3ca0c614d6ec9e064ab76c13c;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 051f7ce5..6f720e7c 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,39 +56,33 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Properties

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

    Accessors

    busy -numberOfRunningTasks +full +numberOfRunningTasks type

    Methods

    -
    afterPromiseWorkerResponseHook +
    afterPromiseResponseHook afterWorkerSetup -beforePromiseWorkerResponseHook +beforePromiseResponseHook chooseWorker createAndSetupWorker createWorker destroy destroyWorker execute -findFreeWorker -getWorkerAverageTasksRunTime -getWorkerIndex -getWorkerRunningTasks -initWorkerTasksUsage -internalExecute -internalGetBusyStatus +findFreeWorkerKey +internalBusy isMain registerWorkerMessageListener removeWorker @@ -100,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.

      @@ -127,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:32

    • Readonly filePath

    -
    filePath: string
    -
    -

    Readonly max

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

    Private 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:66

    • 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 promise response 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 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.

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

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

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

    • Readonly workers

    -
    workers: Worker[] = []
    +
    workers: WorkerType<Worker>[] = []

    Inherit Doc

    -
    -

    Readonly workersTasksUsage

    -
    workersTasksUsage: Map<Worker, TasksUsage> = ...
    -
    -

    Inherit Doc

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

    • Accessors

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

    Returns boolean

    -
    -

    numberOfRunningTasks

    -
    +
    +

    full

    +
    +
    +

    Private numberOfRunningTasks

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

      Number of tasks concurrently running in the pool.

      +

      Returns number

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

    • type

      @@ -250,13 +246,13 @@ 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 afterPromiseWorkerResponseHook

    +
    +

    Protected afterPromiseResponseHook

      - +

    • Hook executed after the worker task promise resolution. Can be overridden.

      @@ -265,17 +261,17 @@ Can be overridden.

      Parameters

      • -
        message: MessageValue<Response, unknown>
        -

        The received message.

        +
        worker: Worker
        +

        The worker.

      • -
        promise: PromiseWorkerResponseWrapper<Worker, Response>
        -

        The Promise response.

        +
        message: MessageValue<Response, unknown>
        +

        The received message.

      Returns void

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

    • Protected afterWorkerSetup

    -
    -

    Protected beforePromiseWorkerResponseHook

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

    Protected beforePromiseResponseHook

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

    • Protected chooseWorker

      - +

    • Chooses a worker for the next task.

      -

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

      +

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

      -

      Returns

      Worker.

      +

      Returns

      [worker key, worker].

      -

      Returns Worker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

    -
    -

    findFreeWorker

    -
    -
    -

    getWorkerAverageTasksRunTime

    -
    -
    -

    getWorkerIndex

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

    findFreeWorkerKey

    -
    -

    getWorkerRunningTasks

    -
    -
    -

    initWorkerTasksUsage

    -
    -
    -

    Protected internalExecute

    -
    -
    -

    Protected internalGetBusyStatus

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

    Protected internalBusy

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

    • Protected removeWorker

      @@ -551,12 +465,12 @@ Can be overridden.

      • worker: Worker
        -

        Worker that will be removed.

        +

        The worker that will be removed.

    Returns void

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

      - +

    • Inherit Doc

      @@ -586,11 +500,11 @@ Can be overridden.

      Parameters

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

    Returns void

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:385
    • @@ -658,33 +572,27 @@ Can be overridden.

  • constructor
  • emitter?
  • filePath
    • -
  • max
    • -
  • nextMessageId
    • +
  • max
  • numberOfWorkers
  • opts
    • -
  • promiseMap
    • +
  • promiseResponseMap
  • workerChoiceStrategyContext
  • workers
    • -
  • workersTasksUsage
  • busy
    • -
  • numberOfRunningTasks
    • +
  • full
    • +
  • numberOfRunningTasks
  • type
    • -
  • afterPromiseWorkerResponseHook
    • +
  • afterPromiseResponseHook
  • afterWorkerSetup
    • -
  • beforePromiseWorkerResponseHook
    • +
  • beforePromiseResponseHook
  • chooseWorker
  • createAndSetupWorker
  • createWorker
  • destroy
  • destroyWorker
  • execute
    • -
  • findFreeWorker
    • -
  • getWorkerAverageTasksRunTime
    • -
  • getWorkerIndex
    • -
  • getWorkerRunningTasks
    • -
  • initWorkerTasksUsage
    • -
  • internalExecute
    • -
  • internalGetBusyStatus
    • +
  • findFreeWorkerKey
    • +
  • internalBusy
  • isMain
  • registerWorkerMessageListener
  • removeWorker