X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=10e968f8a809e4966a607183ffab07d4170bbe17;hb=665702eef3ad8153279b344e0276687f7f50c10f;hp=7dc1e34c7624196e79cddd20c558c3f55cb67f0f;hpb=d8e6bb3c5f8adc1797760260a1a22c228f76e984;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 7dc1e34c..10e968f8 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,13 +1,13 @@ -DynamicClusterPool | poolifier - v2.6.27
+DynamicClusterPool | poolifier - v2.6.42
-
+
  • The search index is not available
    • poolifier - v2.6.42 +
    @@ -45,21 +45,21 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:15
    • - +

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    emitter? +
    emitter? filePath -max +max numberOfWorkers opts promiseResponseMap @@ -68,10 +68,10 @@ When the maximum number of workers is reached and workers are busy, an event is

    Accessors

    -
    busy +
    busy full info -maxSize +maxSize minSize ready type @@ -80,7 +80,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Methods

    -
    afterTaskExecutionHook +
    afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize @@ -93,6 +93,7 @@ When the maximum number of workers is reached and workers are busy, an event is execute flushTasksQueue getWorkerInfo +hasWorkerNodeBackPressure internalBusy isMain listTaskFunctions @@ -109,7 +110,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Constructors

    -

    constructor

    +

    constructor

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

    • Properties

    @@ -159,17 +160,18 @@ When the maximum number of workers is reached and workers are busy, an event is

    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

    • Protected Readonly filePath

    filePath: string
    @@ -178,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:117
    • +

    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
    @@ -195,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:116

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -204,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>> = ...
    @@ -218,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:78

    • Protected workerChoiceStrategyContext

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

    Readonly workerNodes

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

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

    • Accessors

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

      @@ -264,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:689

    • info

      @@ -276,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:350
    • +

    Protected maxSize

    -
      +
      • get maxSize(): number

      • The pool maximum size.

        Returns number

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

    • Protected minSize

      @@ -300,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:555

    • Private ready

      @@ -312,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:507

    • Protected type

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

      @@ -338,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:524

    • Protected worker

      @@ -350,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:119

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

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

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -872,7 +896,7 @@ Can be overridden.

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

  • busy
  • full
  • info
    • -
  • maxSize
    • +
  • maxSize
  • minSize
  • ready
  • type
    • @@ -900,6 +924,7 @@ Can be overridden.

  • execute
  • flushTasksQueue
  • getWorkerInfo
    • +
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
  • listTaskFunctions
    • @@ -913,68 +938,30 @@ Can be overridden.

  • setupHook
  • workerListener
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file