X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=1767983b04add9aa7d5360d287e04c72716bb93a;hb=601deb7292c99dfe7b6ad43935759933f32adca1;hp=a02e71c8f3fe5cae6c007cdad29ec4a02b9dc35a;hpb=76a3a76becd6ac41efb3271c708431a666828c30;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index a02e71c8..1767983b 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier - v2.7.1
+DynamicClusterPool | poolifier - v3.0.3
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.7.1
+
  • The search index is not available
    • poolifier - v3.0.3
    @@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -92,6 +92,7 @@ When the maximum number of workers is reached and workers are busy, an event is destroyWorkerNode enableTasksQueue execute +flagWorkerNodeAsNotReady flushTasksQueue getWorkerInfo hasTaskFunction @@ -111,7 +112,7 @@ When the maximum number of workers is reached and workers are busy, an event is setWorkerChoiceStrategyOptions setupHook start -workerListener +workerMessageListener

    Constructors

    @@ -156,13 +157,14 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:28

    • Properties

    -

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    +

    Optional emitter

    +
    emitter?: EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    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.
      • @@ -177,7 +179,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:74

    • Protected Readonly filePath

    filePath: string
    @@ -186,7 +188,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:129

    • Protected Readonly max

    max: number
    @@ -195,7 +197,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:30

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -204,7 +206,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -213,7 +215,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -227,7 +229,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -236,7 +238,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:94

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -245,7 +247,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:71

    • Accessors

    @@ -260,7 +262,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:44

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

    +
  • Defined in src/pools/cluster/dynamic.ts:39

    • Private utilization

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

    • Protected worker

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

    • Methods

    @@ -392,7 +394,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • Protected deregisterWorkerMessageListener

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    Protected flagWorkerNodeAsNotReady

    +

    Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctionNames

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

    • Protected registerOnceWorkerMessageListener

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

    • Protected registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setDefaultTaskFunction

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

    -
    -

    Protected workerListener

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

    Protected workerMessageListener

    +
  • Defined in src/pools/abstract-pool.ts:1516
    • @@ -1059,10 +1064,10 @@ Can be overridden.

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -1099,6 +1104,7 @@ Can be overridden.

  • destroyWorkerNode
  • enableTasksQueue
  • execute
    • +
  • flagWorkerNodeAsNotReady
  • flushTasksQueue
  • getWorkerInfo
  • hasTaskFunction
    • @@ -1118,9 +1124,9 @@ Can be overridden.

  • setWorkerChoiceStrategyOptions
  • setupHook
  • start
    • -
  • workerListener
    • +
  • workerMessageListener
    • -

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file