X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=4738a04d6e29cce5cd52e342377c437c20928b8a;hb=c22b117f8593bba575a4385b8f125f14b4bf1099;hp=7a09afa0faab302eec9e2721794724bd6598faaa;hpb=8cc4ea811611b8ad77c7b0379911afe497f2e7e4;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 7a09afa0..4738a04d 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.28
+FixedClusterPool | poolifier - v2.6.29
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.28
+
  • The search index is not available
    • poolifier - v2.6.29
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -92,6 +92,7 @@ execute flushTasksQueue getWorkerInfo +hasWorkerNodeBackPressure internalBusy isMain listTaskFunctions @@ -143,7 +144,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -158,12 +159,13 @@
  • '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).
    • +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

    filePath: string
    @@ -172,7 +174,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -181,7 +183,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -190,7 +192,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -204,7 +206,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -213,16 +215,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:81
    • -

    Readonly workerNodes

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    • Accessors

    @@ -237,7 +239,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:130

    • Protected full

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

    • info

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

    • Protected maxSize

    +
  • Defined in src/pools/cluster/fixed.ts:125

    • Protected minSize

    +
  • Defined in src/pools/cluster/fixed.ts:120

    • Private ready

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

    • Protected type

    +
  • Defined in src/pools/cluster/fixed.ts:110

    • Private utilization

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

    • Protected worker

    +
  • Defined in src/pools/cluster/fixed.ts:115

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:105

    • destroy

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

    • Protected destroyWorkerNode

    +
  • Defined in src/pools/cluster/fixed.ts:63

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    hasWorkerNodeBackPressure

    +
      + +
    • 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.

      + +

    Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:58

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/cluster/fixed.ts:97

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:89

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:81

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1164
    • @@ -885,6 +908,7 @@ Can be overridden.

  • execute
  • flushTasksQueue
  • getWorkerInfo
    • +
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
  • listTaskFunctions
    • @@ -898,7 +922,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -