X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=f5fb5b04c54c4735cf97df2d0618922fe483d64f;hb=26fb3c18b678a1daab6b18a351a238fb5a3ed5df;hp=1716132ec7d23928b8eb717416704e153e50eace;hpb=3882157ecadc80e686b319068bd73a9cc218e10c;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 1716132e..f5fb5b04 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.30
+FixedClusterPool | poolifier - v2.6.35
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.30
+
  • The search index is not available
    • poolifier - v2.6.35
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -145,7 +145,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -157,16 +157,16 @@
  • '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.
  • '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:67

    • Protected Readonly filePath

    filePath: string
    @@ -175,7 +175,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116

    • Protected Optional Readonly max

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

    @@ -249,7 +249,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:120

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

      - +

    • Gets the worker information given its worker node key.

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

      The worker node key.

    -

    Returns WorkerInfo

    The worker information.

    +

    Returns undefined | WorkerInfo

    The worker information.

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1343
    • @@ -933,18 +933,19 @@ Can be overridden.

  • setupHook
  • workerListener
    • -