X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=1716132ec7d23928b8eb717416704e153e50eace;hb=fa5bdff51f129cada6116f34289dfe5a16bb4c9e;hp=d4dc6e76b0887f32a68f5eb412b9b8c85a79ec16;hpb=de2e7182cca6b34b000a09bf6d0ddcff4757db3a;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index d4dc6e76..1716132e 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.25
+FixedClusterPool | poolifier - v2.6.30
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.25
+
  • The search index is not available
    • poolifier - v2.6.30
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -59,6 +59,7 @@

    Properties

    emitter? filePath +max? numberOfWorkers opts promiseResponseMap @@ -70,8 +71,8 @@
    busy full info -maxSize -minSize +maxSize +minSize ready type utilization @@ -92,9 +93,12 @@ execute flushTasksQueue getWorkerInfo +hasWorkerNodeBackPressure internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker sendStartupMessageToWorker sendToWorker setTasksQueueOptions @@ -141,7 +145,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -150,17 +154,19 @@

    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 >= pool maximum size^2).
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

    filePath: string
    @@ -169,7 +175,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
    • +
    +

    Protected Optional Readonly max

    +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +

    Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -178,7 +193,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:109

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -210,16 +225,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

    @@ -234,7 +249,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:120

    • Protected full

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

    • info

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

    Protected maxSize

    -
      +
      • get maxSize(): number

      • The pool maximum size.

        Returns number

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

    Protected minSize

    -
      +
      • get minSize(): number

      • The pool minimum size.

        Returns number

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    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:657

    • Protected isMain

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

    listTaskFunctions

    +

    Protected registerWorkerMessageListener

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

    Protected sendKillMessageToWorker

    +

    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:618

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1174
    • @@ -826,6 +891,7 @@ Can be overridden.

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

  • busy
  • full
  • info
    • -
  • maxSize
    • -
  • minSize
    • +
  • maxSize
    • +
  • minSize
  • ready
  • type
  • utilization
    • @@ -853,9 +919,12 @@ Can be overridden.

  • execute
  • flushTasksQueue
  • getWorkerInfo
    • +
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
    • +
  • listTaskFunctions
  • registerWorkerMessageListener
    • +
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
    • @@ -864,7 +933,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -