X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=5bbe0ff4edc5dc2d845e531f55e0390415945100;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=5ac2dbd0baa978f54f22339d7a0bad5fa41d73a5;hpb=de2e7182cca6b34b000a09bf6d0ddcff4757db3a;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 5ac2dbd0..5bbe0ff4 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier - v2.6.25
+DynamicClusterPool | poolifier - v2.6.32
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.25
+
  • The search index is not available
    • poolifier - v2.6.32
    @@ -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,9 +93,12 @@ When the maximum number of workers is reached and workers are busy, an event is execute flushTasksQueue getWorkerInfo +hasWorkerNodeBackPressure internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker sendStartupMessageToWorker sendToWorker setTasksQueueOptions @@ -147,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

    @@ -156,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:65

    • Protected Readonly filePath

    filePath: string
    @@ -175,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:114
    • +

    Protected Readonly max

    max: number

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

    +
  • Defined in src/pools/cluster/dynamic.ts:29

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -192,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:113

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -201,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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -215,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:75

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -224,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:81
    • -

    Readonly workerNodes

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

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

    • Accessors

    @@ -248,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

    • Protected full

      @@ -261,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:675

    • info

      @@ -273,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:345
    • +

    Protected maxSize

    -
      +
      • get maxSize(): number

      • The pool maximum size.

        Returns number

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

    • Protected minSize

      @@ -297,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:539

    • Private ready

      @@ -309,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:491

    • Protected type

      @@ -322,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

    • Private utilization

      @@ -335,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:508

    • Protected worker

      @@ -347,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

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

    • -

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

      - +

    • Gets the worker information given its worker node key.

      @@ -595,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:1349
    • +
    +

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

    • 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:639

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1261
    • @@ -840,7 +896,7 @@ Can be overridden.

  • constructor
  • emitter
  • filePath
    • -
  • max
    • +
  • max
  • numberOfWorkers
  • opts
  • promiseResponseMap
    • @@ -849,7 +905,7 @@ Can be overridden.

  • busy
  • full
  • info
    • -
  • maxSize
    • +
  • maxSize
  • minSize
  • ready
  • type
    • @@ -868,9 +924,12 @@ Can be overridden.

  • execute
  • flushTasksQueue
  • getWorkerInfo
    • +
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
    • +
  • listTaskFunctions
  • registerWorkerMessageListener
    • +
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
    • @@ -879,18 +938,18 @@ Can be overridden.

  • setupHook
  • workerListener
    • -