X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=e2e7da263b2e264ccf64dbf2fd63d77edcfb8cb1;hb=aee467366d8c393b79e7af82c6a7ab12338ee64e;hp=76a15e97be8519bfaa041890ed7f46a001edca14;hpb=cfc6e8df4c903b63514c46cb67b3f5e24079d3ce;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 76a15e97..e2e7da26 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,37 +56,33 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Properties

    Accessors

    Methods

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

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

    Options for this dynamic cluster pool.

  • Returns DynamicClusterPool<Data, Response>

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

    emitter?: PoolEmitter
    -

    {@inheritDoc}

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

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

    -
    - -
    nextMessageId: number = 0
    -

    Id of the next message.

    -
    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • numberOfWorkers: number
    @@ -174,53 +162,45 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:66
  • -
    opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL
    +
    opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

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

    The promise map.

    +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
    + +
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    +

    The promise response map.

    -

    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
  • 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
  • -
    workers: Worker[] = []
    -

    {@inheritDoc}

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

    {@inheritDoc}

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

    @@ -228,40 +208,51 @@ When the maximum number of workers is reached, an event is emitted. If you want
    -
    - -
    +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:163
  • +
  • Defined in src/pools/cluster/dynamic.ts:38
  • Methods

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

      @@ -270,24 +261,24 @@ 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
  • -
    - +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:270
  • +
  • Defined in src/pools/abstract-pool.ts:310
  • +
  • Defined in src/pools/abstract-pool.ts:356
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:233
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • -
    - -
    -
    - +
  • Defined in src/pools/abstract-pool.ts:217
  • +
    +
    -
    - -
    -
    - -
    -
    - +
  • Defined in src/pools/abstract-pool.ts:210
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:202
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/abstract-pool.ts:479
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:178
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:385