X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=0978d5eb30cec731c40f8eb99172a245b9a4ec44;hb=970b38d6f87c7d0d29498f13af934c8ff6d472f5;hp=09eed2ccd74c661b02a4ff7b9d05a1e9f8676dee;hpb=013a4697317eeedbe32d0e233b2e255027dd84fe;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 09eed2cc..0978d5eb 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier - v2.6.26
+DynamicClusterPool | poolifier - v2.6.34
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.26
+
  • The search index is not available
  • poolifier - v2.6.34
    @@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:15
  • @@ -59,7 +59,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Properties

    emitter? filePath -max +max numberOfWorkers opts promiseResponseMap @@ -71,7 +71,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    busy full info -maxSize +maxSize minSize ready type @@ -93,6 +93,7 @@ When the maximum number of workers is reached and workers are busy, an event is execute flushTasksQueue getWorkerInfo +hasWorkerNodeBackPressure internalBusy isMain listTaskFunctions @@ -149,7 +150,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:27
  • Properties

    @@ -158,17 +159,19 @@ When the maximum number of workers is reached and workers are busy, an event is

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
    • +
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • +
    • 'destroy': Emitted when the pool is destroyed.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    • +
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -177,15 +180,16 @@ When the maximum number of workers is reached and workers are busy, an event is
    -
    +
  • Defined in src/pools/abstract-pool.ts:115
  • +
    max: number

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

    +
  • Defined in src/pools/cluster/dynamic.ts:29
  • numberOfWorkers: number
    @@ -194,7 +198,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:114
  • @@ -203,7 +207,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -217,7 +221,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -226,16 +230,16 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:82
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -250,7 +254,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:43
    • @@ -263,7 +267,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:682
    • @@ -275,19 +279,19 @@ When the maximum number of workers is reached and workers are busy, an event is
    -
    +
  • Defined in src/pools/abstract-pool.ts:354
  • +
    -
      +
      • get maxSize(): number
      • The pool maximum size.

        Returns number

    +
  • Defined in src/pools/abstract-pool.ts:555
    • @@ -299,7 +303,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:548
    • @@ -311,7 +315,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:500
    • @@ -324,7 +328,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:38
    • @@ -337,7 +341,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:517
    • @@ -349,7 +353,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:115
  • Methods

    @@ -377,7 +381,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:879
  • +
  • Defined in src/pools/abstract-pool.ts:1151
  • +
  • Defined in src/pools/abstract-pool.ts:849
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:1094
  • +
  • Defined in src/pools/abstract-pool.ts:1050
  • +
  • Defined in src/pools/cluster/fixed.ts:105
  • +
  • Defined in src/pools/abstract-pool.ts:794
  • +
  • Defined in src/pools/cluster/fixed.ts:63
    • -

      Enables/disables the worker tasks queue in this pool.

      +

      Enables/disables the worker node tasks queue in this pool.

      Parameters

      • enable: boolean
        -

        Whether to enable or disable the worker tasks queue.

        +

        Whether to enable or disable the worker node tasks queue.

      • Optional tasksQueueOptions: TasksQueueOptions
        -

        The worker tasks queue options.

        +

        The worker node tasks queue options.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:636
  • +
  • Defined in src/pools/abstract-pool.ts:732
  • +
  • Defined in src/pools/abstract-pool.ts:1475
    • - +
    • Gets the worker information given its worker node key.

      @@ -597,12 +601,33 @@ Can be overridden.

      The worker node key.

    -

    Returns WorkerInfo

    The worker information.

    +

    Returns undefined | WorkerInfo

    The worker information.

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

      Whether the worker node has back pressure (i.e. its tasks queue is full).

      +
      +
      +

      Parameters

      +
        +
      • +
        workerNodeKey: number
        +

        The worker node key.

        +
        +
      +

      Returns boolean

      true if the worker node has back pressure, false otherwise.

      + +
    +
  • Defined in src/pools/abstract-pool.ts:698
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:719
  • +
  • Defined in src/pools/cluster/fixed.ts:97
  • +
  • Defined in src/pools/abstract-pool.ts:804
  • +
  • Defined in src/pools/cluster/fixed.ts:89
  • +
  • Defined in src/pools/cluster/fixed.ts:81
  • +
  • Defined in src/pools/abstract-pool.ts:648
  • +
  • Defined in src/pools/abstract-pool.ts:603
  • +
  • Defined in src/pools/abstract-pool.ts:622
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1302