X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=f52bd444f7e096f06c75c0598f0f43c0e575ce1a;hb=c914a50e9996ca3f869c130974bff87b117f70f5;hp=17780e30c306c90b02ec7ea16c6758fa350628d3;hpb=202bcb6b999895ba5c5ef42eccd6a95836d21602;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 17780e30..f52bd444 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier
+FixedClusterPool | poolifier - v2.6.9
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.9
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -72,7 +72,8 @@ info maxSize minSize -runTime +ready +starting type utilization worker @@ -82,6 +83,7 @@
    afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook +checkDynamicPoolSize createAndSetupDynamicWorker createAndSetupWorker createWorker @@ -136,7 +138,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -145,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 maximum 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.
    @@ -154,7 +157,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:58

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    Pool worker nodes.

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

    -
    -

    Private runTime

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

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

    Private starting

    +

    Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    Protected checkDynamicPoolSize

    +

    Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1001
    • @@ -714,13 +738,15 @@ Can be overridden.

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

  • setupHook
  • workerListener
    • -