X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=becf83d83cb2b9d6db65d63c8e1fc02522d3a0d2;hb=68887e30ceca3df78b70e0b8f1b262a76f2d7cd8;hp=47a53f506dc9615c5baccdbce6ff2e21cb00a6d8;hpb=52d3ec6b2aea8279b0ac670bd6291efa90466a60;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 47a53f50..becf83d8 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier
+FixedClusterPool | 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 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -72,7 +72,10 @@ info maxSize minSize +ready +starting type +utilization worker
    @@ -80,6 +83,7 @@
    afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook +checkDynamicPoolSize createAndSetupDynamicWorker createAndSetupWorker createWorker @@ -134,7 +138,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -143,8 +147,9 @@

    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.
    @@ -152,7 +157,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:59

    • Protected Readonly filePath

    filePath: string
    @@ -161,7 +166,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -170,7 +175,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:96

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -179,7 +184,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -193,7 +198,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:69

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -202,16 +207,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Readonly workerNodes

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

    Pool worker nodes.

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

    • Accessors

    @@ -226,7 +231,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:102

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    Private ready

    +
    +
    +

    Private starting

    +

    Protected type

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

    Private utilization

    +
      +
    • get utilization(): number
      • +
    • +

      Gets the approximate pool utilization.

      +
      +

      Returns number

      The pool utilization.

      + +

    Protected worker

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

    • Methods

    @@ -328,7 +364,7 @@ Can be overridden.

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    Protected checkDynamicPoolSize

    +

    Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1038
    • @@ -686,11 +738,15 @@ Can be overridden.

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

  • setupHook
  • workerListener
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file