X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=5b2e41c469fad567ee589be0967741fee5ef8c44;hb=4608939f425568da5553db1f5bf883d4cca18e02;hp=0ccad3578199b61ef5dbf320ddeb39b9165bbf88;hpb=fa5bdff51f129cada6116f34289dfe5a16bb4c9e;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 0ccad357..5b2e41c4 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,13 +1,13 @@ -DynamicClusterPool | poolifier - v2.6.30
+DynamicClusterPool | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    @@ -45,19 +45,19 @@ 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 numberOfWorkers @@ -68,7 +68,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Accessors

    -
    busy +
    busy full info maxSize @@ -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 @@ -105,12 +105,13 @@ When the maximum number of workers is reached and workers are busy, an event is setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook +start workerListener

    Constructors

    -

    constructor

    +

    constructor

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

    • Properties

    @@ -160,18 +161,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 >= 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:68

    • Protected Readonly filePath

    filePath: string
    @@ -180,7 +181,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 max

    max: number
    @@ -189,7 +190,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 +199,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:115

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -207,11 +208,11 @@ 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>> = ...
    -

    The task execution response promise map.

    +

    The task execution response promise map:

    • key: The message id of each submitted task.
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.
      • @@ -221,7 +222,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -230,7 +231,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:83

    • Readonly Internal workerNodes

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

    • Accessors

    @@ -254,7 +255,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 +268,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:676

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

      @@ -328,7 +329,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 +342,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:509

    • Protected worker

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

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

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

    • Protected sendKillMessageToWorker

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    start

    +

    Protected workerListener

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

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -936,70 +949,33 @@ Can be overridden.

  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
    • +
  • start
  • workerListener
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file