X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=e58245ddb04ce54782236ec11b5eedbc2a8ece25;hb=40baeb4e66efa6646d3221029cd012fb7bda8955;hp=583cf496c2f65a0075168252beef88dddd672a07;hpb=0770fe626b2bb3212a1d73fa4764973ac92e241a;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 583cf496..e58245dd 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -18,7 +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.

+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

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

    Properties

    Accessors

    Methods

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

    emitter?: PoolEmitter
    -

    {@inheritDoc}

    -
    +
  • Defined in src/pools/abstract-pool.ts:33
  • filePath: string
    @@ -147,14 +147,14 @@ When the maximum number of workers is reached, an event is emitted. If you want
    -
    - +
  • Defined in src/pools/abstract-pool.ts:68
  • +
    +
    max: number

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

    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • numberOfWorkers: number
    @@ -162,7 +162,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:67
  • opts: ClusterPoolOptions = {}
    @@ -170,37 +170,37 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    -

    The promise response map.

    +

    The execution response promise map.

    • key: The message id of each submitted task.
    • -
    • value: An object that contains the worker, the promise resolve and reject callbacks.
    • +
    • 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 with the promise resolve/reject bound to 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.

    +
  • Defined in src/pools/abstract-pool.ts:43
  • 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.

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

    {@inheritDoc}

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

    Inherit Doc

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

    @@ -208,53 +208,64 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/cluster/dynamic.ts:48
  • +
  • Defined in src/pools/cluster/dynamic.ts:43
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/cluster/dynamic.ts:38
  • Methods

    -
    - +
    +
      - +
    • -

      Hook executed after the worker task promise resolution. +

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

      @@ -269,16 +280,16 @@ Can be overridden.

      The received message.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:304
  • -
    - +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
    +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:293
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/abstract-pool.ts:399
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:228
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/abstract-pool.ts:216
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • +
  • Defined in src/pools/abstract-pool.ts:189
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:422