X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=ae97fc9c47f17ba9f1c4a5f03a3d8e2956420eaf;hb=a09a79a68dbaf04a9dff2f9d9dcc37da8c7dd314;hp=11212b2005cb21a76266044a1d3316fcba230c16;hpb=f7d15c1217381b306300beb7926b42fde93bc579;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 11212b20..ae97fc9c 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier - v2.7.0
+DynamicClusterPool | poolifier - v3.0.5
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.7.0
+
  • The search index is not available
    • poolifier - v3.0.5
    @@ -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
    • @@ -84,14 +84,15 @@ When the maximum number of workers is reached and workers are busy, an event is afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook -checkDynamicPoolSize createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue execute +flagWorkerNodeAsNotReady flushTasksQueue getWorkerInfo hasTaskFunction @@ -99,6 +100,7 @@ When the maximum number of workers is reached and workers are busy, an event is internalBusy isMain listTaskFunctionNames +registerOnceWorkerMessageListener registerWorkerMessageListener removeTaskFunction sendKillMessageToWorker @@ -110,7 +112,7 @@ When the maximum number of workers is reached and workers are busy, an event is setWorkerChoiceStrategyOptions setupHook start -workerListener +workerMessageListener

    Constructors

    @@ -155,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.
      • @@ -176,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:75

    • Protected Readonly filePath

    filePath: string
    @@ -185,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:130

    • Protected Readonly max

    max: number
    @@ -194,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
    @@ -203,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:129

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -212,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>> = ...
    @@ -226,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:89

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -235,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:95

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -244,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:72

    • Accessors

    @@ -259,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:660

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

    -
    -

    Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    Protected deregisterWorkerMessageListener

    +

    destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    Protected flagWorkerNodeAsNotReady

    +

    Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctionNames

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

    Protected registerOnceWorkerMessageListener

    +

    Protected registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Protected sendKillMessageToWorker

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

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

    -
    -

    Protected workerListener

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

    Protected workerMessageListener

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

    Member Visibility

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

    • Theme

    @@ -1024,14 +1096,15 @@ Can be overridden.

  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
    • -
  • checkDynamicPoolSize
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
    • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
  • execute
    • +
  • flagWorkerNodeAsNotReady
  • flushTasksQueue
  • getWorkerInfo
  • hasTaskFunction
    • @@ -1039,6 +1112,7 @@ Can be overridden.

  • internalBusy
  • isMain
  • listTaskFunctionNames
    • +
  • registerOnceWorkerMessageListener
  • registerWorkerMessageListener
  • removeTaskFunction
  • sendKillMessageToWorker
    • @@ -1050,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