X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=5bbe0ff4edc5dc2d845e531f55e0390415945100;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=0ccad3578199b61ef5dbf320ddeb39b9165bbf88;hpb=fa5bdff51f129cada6116f34289dfe5a16bb4c9e;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 0ccad357..5bbe0ff4 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier - v2.6.30
+DynamicClusterPool | poolifier - v2.6.32
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.30
+
  • 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
    • @@ -150,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

    @@ -165,13 +165,13 @@ When the maximum number of workers is reached and workers are busy, an event is
  • '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).
    • +
  • '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
    @@ -180,7 +180,7 @@ 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
    @@ -189,7 +189,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:29

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -198,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 = {}
    @@ -207,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>> = ...
    @@ -221,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>
    @@ -230,7 +230,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -239,7 +239,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Accessors

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

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

      @@ -279,7 +279,7 @@ 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

      @@ -291,7 +291,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:546

    • Protected minSize

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

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

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

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

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

    @@ -381,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.

      @@ -601,12 +601,12 @@ 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

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • 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
    • @@ -938,18 +938,18 @@ Can be overridden.

  • setupHook
  • workerListener
    • -