X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=928ef50d5aa4d6e385e62a2b6ed791968fc7dfc6;hb=88499cf9c298c12aa8235e60d27657f50d3c38ee;hp=76ccf9cf047bf35c7ee11d02c6eb7af5e0e12f4b;hpb=2a6631992868d900762f62e4c228dce4e4ee549a;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 76ccf9cf..928ef50d 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -DynamicThreadPool | poolifier
+DynamicThreadPool | poolifier - v2.6.17
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.17
    @@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:15
    • @@ -73,7 +73,7 @@ When the maximum number of threads is reached and workers are busy, an event is info maxSize minSize -runTime +ready type utilization worker @@ -83,6 +83,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook +checkDynamicPoolSize createAndSetupDynamicWorker createAndSetupWorker createWorker @@ -142,7 +143,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:27

    • Properties

    @@ -151,8 +152,9 @@ When the maximum number of threads 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 +162,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:63

    • Protected Readonly filePath

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

    • Protected Readonly max

    max: number
    @@ -177,7 +179,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:29

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -195,7 +197,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:46

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -209,7 +211,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    Pool worker nodes.

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

      @@ -279,7 +281,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:43

    • Protected minSize

      @@ -291,20 +293,16 @@ When the maximum number of threads is reached and workers are busy, an event is
    -
    -

    Private runTime

    +
  • Defined in src/pools/thread/fixed.ts:86
    • +
    +

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

    • Protected type

      @@ -317,7 +315,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:38

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    Protected checkDynamicPoolSize

    +

    Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    +
  • Defined in src/pools/thread/fixed.ts:68

    • destroy

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

    • Protected destroyWorker

    +
  • Defined in src/pools/thread/fixed.ts:57

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/thread/fixed.ts:52

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1075
    • @@ -729,13 +743,14 @@ Can be overridden.

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

  • setupHook
  • workerListener
    • -