X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=0c52886e04db9b8851f1c9de9bb4282b0de0adee;hb=3eed67feea0f527e3ee31a6ebb1063883eec3855;hp=5384f9a72a45fa9b228a6e29c183d67ff45b1d3b;hpb=019581cc38fe0b47645d9b2120f325ab37388be2;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 5384f9a7..0c52886e 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,13 +1,13 @@ -FixedThreadPool | poolifier - v2.6.28
+FixedThreadPool | poolifier - v2.6.45
-
+
  • The search index is not available
  • poolifier - v2.6.45 +
    @@ -45,20 +45,21 @@ +
  • Defined in src/pools/thread/fixed.ts:35
  • - +

    Constructors

    - +
    +
  • Defined in src/pools/thread/fixed.ts:46
  • Properties

    @@ -153,17 +156,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 >= maximum queue size).
    +
  • Defined in src/pools/abstract-pool.ts:68
  • filePath: string
    @@ -172,7 +176,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -181,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • @@ -190,11 +203,11 @@
    +
  • Defined in src/pools/thread/fixed.ts:49
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    -

    The task execution response promise map.

    +

    The task execution response promise map:

    +
  • Defined in src/pools/abstract-pool.ts:77
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -213,16 +226,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:83
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -237,7 +250,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:135
  • +
  • Defined in src/pools/abstract-pool.ts:722
  • -
    +
  • Defined in src/pools/abstract-pool.ts:342
  • +
    -
      +
      • get maxSize(): number
      • The pool maximum size.

        Returns number

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

        Returns number

    +
  • Defined in src/pools/abstract-pool.ts:548
  • +
  • Defined in src/pools/abstract-pool.ts:500
  • +
  • Defined in src/pools/thread/fixed.ts:125
  • +
  • Defined in src/pools/abstract-pool.ts:517
  • +
  • Defined in src/pools/thread/fixed.ts:130
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:935
  • +
  • Defined in src/pools/abstract-pool.ts:1209
  • +
  • Defined in src/pools/abstract-pool.ts:905
  • +
  • Defined in src/pools/abstract-pool.ts:187
  • +
  • Defined in src/pools/abstract-pool.ts:1152
  • +
  • Defined in src/pools/abstract-pool.ts:1108
  • +
  • Defined in src/pools/thread/fixed.ts:117
  • +
  • Defined in src/pools/abstract-pool.ts:850
  • +
  • Defined in src/pools/thread/fixed.ts:60
    • -

      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:779
  • +
  • Defined in src/pools/abstract-pool.ts:1542
  • +
  • Defined in src/pools/abstract-pool.ts:1458
  • +
    + +
      + +
    • 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:738
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
  • Defined in src/pools/abstract-pool.ts:758
  • +
  • Defined in src/pools/thread/fixed.ts:107
  • +
  • Defined in src/pools/abstract-pool.ts:860
  • +
  • Defined in src/pools/thread/fixed.ts:91
  • +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:650
  • +
  • Defined in src/pools/abstract-pool.ts:603
  • +
  • Defined in src/pools/abstract-pool.ts:622
  • +
  • Defined in src/pools/abstract-pool.ts:889
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1372
  • @@ -863,6 +909,7 @@ Can be overridden.

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

  • busy
  • full
  • info
  • -
  • maxSize
  • -
  • minSize
  • +
  • maxSize
  • +
  • minSize
  • ready
  • type
  • utilization
  • @@ -890,6 +937,7 @@ Can be overridden.

  • execute
  • flushTasksQueue
  • getWorkerInfo
  • +
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
  • listTaskFunctions
  • @@ -901,70 +949,33 @@ Can be overridden.

  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • +
  • start
  • workerListener
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file