X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=83acc6eb74f7161a5f5c73c93a55ab53475f3c0d;hb=7455be54c58f74c6f0d0dd597aa431a88da0a9d8;hp=ad0632c4ab6cb95e036940eebfd90db161e77d22;hpb=1416660efeb6aabf366295ebc79067ccc4df9897;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index ad0632c4..83acc6eb 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,13 +1,13 @@ -DynamicThreadPool | poolifier - v2.6.30
+DynamicThreadPool | poolifier - v2.6.42
-
+
  • The search index is not available
    • poolifier - v2.6.42 +
    @@ -45,19 +45,19 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:15
    • - +

    Constructors

    -
    constructor +
    constructor

    Properties

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

    Accessors

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

    Methods

    -
    afterTaskExecutionHook +
    afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize @@ -110,7 +110,7 @@ When the maximum number of threads is reached and workers are busy, an event is

    Constructors

    -

    constructor

    +

    constructor

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

    • Properties

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

    • Protected Readonly max

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

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

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

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

    • Protected worker

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

    • Methods

    @@ -381,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/thread/fixed.ts:117

    • destroy

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

    • Protected destroyWorkerNode

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

    • 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

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • 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/abstract-pool.ts:842

    • Protected workerListener

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

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -943,68 +943,30 @@ Can be overridden.

  • setupHook
  • workerListener
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file