X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=15300e68c3ac6e51bde0f9c6a83ca2732d1da3f7;hb=1316707177f592284f8ea03303dc076245f8ed35;hp=4738a04d6e29cce5cd52e342377c437c20928b8a;hpb=ce9e97f17ed0d1b2928919244dce5a7887f843f5;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 4738a04d..15300e68 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,13 @@ -FixedClusterPool | poolifier - v2.6.29
+FixedClusterPool | poolifier - v2.6.44
-
+
  • The search index is not available
  • poolifier - v2.6.44 +
    @@ -45,20 +45,21 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
  • - +

    Constructors

    -

    Properties

    -

    Accessors

    -

    Methods

    -
    afterTaskExecutionHook +
    afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize @@ -109,7 +110,7 @@

    Constructors

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

    @@ -154,18 +155,18 @@

    Events that can currently be listened to:

    • '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.
    • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    • '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.
    • +
    • '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 >= pool maximum size^2).
    • +
    • '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:68
  • filePath: string
    @@ -174,7 +175,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -183,7 +193,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • @@ -192,7 +202,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -206,7 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -215,7 +225,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:84
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -224,7 +234,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • Accessors

    @@ -239,7 +249,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:124
  • +
  • Defined in src/pools/abstract-pool.ts:689
  • -
    +
  • Defined in src/pools/abstract-pool.ts:350
  • +
    -
      +
      • get maxSize(): number
      • The pool maximum size.

        Returns number

    -
    +
  • Defined in src/pools/abstract-pool.ts:562
  • +
    -
      +
      • get minSize(): number
      • The pool minimum size.

        Returns number

    +
  • Defined in src/pools/abstract-pool.ts:555
  • +
  • Defined in src/pools/abstract-pool.ts:507
  • +
  • Defined in src/pools/cluster/fixed.ts:114
  • +
  • Defined in src/pools/abstract-pool.ts:524
  • +
  • Defined in src/pools/cluster/fixed.ts:119
  • Methods

    @@ -366,7 +376,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:888
  • +
  • Defined in src/pools/abstract-pool.ts:1162
  • +
  • Defined in src/pools/abstract-pool.ts:858
  • +
  • Defined in src/pools/abstract-pool.ts:187
  • +
  • Defined in src/pools/abstract-pool.ts:1105
  • +
  • Defined in src/pools/abstract-pool.ts:1061
  • +
  • Defined in src/pools/cluster/fixed.ts:109
  • +
  • Defined in src/pools/abstract-pool.ts:803
  • +
  • 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:643
  • +
  • Defined in src/pools/abstract-pool.ts:747
  • +
  • Defined in src/pools/abstract-pool.ts:1491
  • +
  • Defined in src/pools/abstract-pool.ts:1407
  • +
  • Defined in src/pools/abstract-pool.ts:1449
  • +
  • Defined in src/pools/abstract-pool.ts:705
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:726
  • +
  • Defined in src/pools/cluster/fixed.ts:101
  • +
  • Defined in src/pools/abstract-pool.ts:813
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/cluster/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:655
  • +
  • Defined in src/pools/abstract-pool.ts:610
  • +
  • Defined in src/pools/abstract-pool.ts:629
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1321
  • @@ -881,6 +891,7 @@ Can be overridden.

  • constructor
  • emitter
  • filePath
  • +
  • max
  • numberOfWorkers
  • opts
  • promiseResponseMap
  • @@ -889,8 +900,8 @@ Can be overridden.

  • busy
  • full
  • info
  • -
  • maxSize
  • -
  • minSize
  • +
  • maxSize
  • +
  • minSize
  • ready
  • type
  • utilization
  • @@ -922,68 +933,30 @@ Can be overridden.

  • setupHook
  • workerListener
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file