X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=3c06ec2642e78afc09fa51d4a8240e0980269e52;hb=ef29303558d4caf5ff412db9579ea28346b77f3f;hp=549b03ff6d62285e25aaab7f586d4c2783f243bb;hpb=969223ea18802a84dfea369e254332e11bf8e419;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 549b03ff..3c06ec26 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,13 @@ -FixedClusterPool | poolifier - v2.6.33
+FixedClusterPool | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    @@ -45,19 +45,19 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • - +

    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/cluster/fixed.ts:44

    • Properties

    @@ -155,9 +156,9 @@

    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 >= maximum queue size).
      • @@ -166,7 +167,7 @@
    +
  • 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: ClusterPoolOptions = {}
    @@ -202,11 +203,11 @@
    +
  • 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:

    +
  • 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/cluster/fixed.ts:124

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

    @@ -376,7 +377,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

    +
  • 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

      - +

    • Gets the worker information given its worker node key.

      @@ -596,12 +597,12 @@ Can be overridden.

      The worker node key.

    -

    Returns undefined | WorkerInfo

    The worker information.

    +

    Returns WorkerInfo

    The worker information.

    +
  • 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

    @@ -931,71 +944,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