X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=9ce4f0626ab3a7517f45a8ce6a048756cab84058;hb=a109e1c64ce3cff450fa79aebfa4de0ac3662be9;hp=3cb42f1cfbc559f7d01d7a6ffc267ee285fcd3c4;hpb=ac2cb9e206b5e67cc52124eb334507f5dce230d5;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 3cb42f1c..9ce4f062 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier - v2.6.12
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.12
    @@ -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
    • @@ -73,7 +73,8 @@ When the maximum number of workers is reached and workers are busy, an event is info maxSize minSize -runTime +ready +starting type utilization worker @@ -83,6 +84,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook +checkDynamicPoolSize createAndSetupDynamicWorker createAndSetupWorker createWorker @@ -142,7 +144,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

    @@ -151,8 +153,9 @@ 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 full.
      • -
    • 'busy': Emitted when the pool is busy.
      • +
    • '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.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    @@ -160,7 +163,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:58

    • Protected Readonly filePath

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

    • Protected Readonly max

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

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -195,7 +198,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<Worker, Response>> = ...
    @@ -209,7 +212,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

    -
    workerNodes: WorkerNode<Worker, Data>[] = []
    +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    • Accessors

    @@ -242,7 +245,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:48

    • Protected full

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

    • info

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

    • Protected maxSize

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

      @@ -291,20 +294,25 @@ When the maximum number of workers is reached and workers are busy, an event is
    -
    -

    Private runTime

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

    Private ready

      -
    • get runTime(): number
      • +
    • get ready(): boolean
    • -

      Gets the pool run time.

      -
      -

      Returns number

      The pool run time in milliseconds.

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

    Private starting

    +

    Protected type

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

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

    • Protected worker

      @@ -342,7 +350,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:87

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    Protected checkDynamicPoolSize

    +

    Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1025
    • @@ -729,13 +753,15 @@ Can be overridden.

  • info
  • maxSize
  • minSize
    • -
  • runTime
    • +
  • ready
    • +
  • starting
  • type
  • utilization
  • worker
  • afterTaskExecutionHook
  • afterWorkerSetup
  • beforeTaskExecutionHook
    • +
  • checkDynamicPoolSize
  • createAndSetupDynamicWorker
  • createAndSetupWorker
  • createWorker
    • @@ -752,7 +778,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -