X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=3ea66d2bf241c9981fcdd2653c177139cd5de2ff;hb=41e3e08eb7fbcde0a69cea17e697aacb222990a6;hp=f2bd8f7c02c44eeb3d3b2001c782a4b32c53e750;hpb=c38a523624d95c0329fac3d0748883c361db9d93;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index f2bd8f7c..3ea66d2b 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,13 +1,13 @@ -FixedThreadPool | poolifier - v2.6.30
+FixedThreadPool | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    @@ -45,19 +45,19 @@ +
  • Defined in src/pools/thread/fixed.ts:35
    • - +

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    emitter? +
    emitter? filePath max? numberOfWorkers @@ -68,7 +68,7 @@

    Accessors

    -
    busy +
    busy full info maxSize @@ -80,7 +80,7 @@

    Methods

    -
    afterTaskExecutionHook +
    afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize @@ -105,12 +105,13 @@ setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook +start workerListener

    Constructors

    -

    constructor

    +

    constructor

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

    • Properties

    @@ -155,18 +156,18 @@

    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
    @@ -175,7 +176,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116

    • Protected Optional Readonly max

    max?: number
    @@ -184,7 +185,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:92

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -193,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -202,11 +203,11 @@
    +
  • Defined in src/pools/thread/fixed.ts:49

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    -

    The task execution response promise map.

    +

    The task execution response promise map:

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -225,7 +226,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:83

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -234,7 +235,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Accessors

    @@ -249,7 +250,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:135

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

    @@ -376,7 +377,7 @@ Can be overridden.

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    start

    +

    Protected workerListener

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

    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