Module connection-manager/latency-monitor

Index

Classes

Type aliases

Variables

Type aliases

Events

Events: EventEmitterFactory

LatencyMonitorOptions

LatencyMonitorOptions: { asyncTestFn?: Function | undefined; dataEmitIntervalMs?: number | undefined; latencyCheckIntervalMs?: number | undefined; latencyRandomPercentage?: number | undefined }

Type declaration

  • Optional asyncTestFn?: Function | undefined
    • What cb-style async function to use
  • Optional dataEmitIntervalMs?: number | undefined
    • How often to summarize latency check events. null or 0 disables event firing
  • Optional latencyCheckIntervalMs?: number | undefined
    • How often to add a latency check event (ms)
  • Optional latencyRandomPercentage?: number | undefined
    • What percent (+/-) of latencyCheckIntervalMs should we randomly use? This helps avoid alignment to other events.

SummaryObject

SummaryObject: { avgMs: number; events: number; lengthMs: number; maxMS: number; minMS: number }

Type declaration

  • avgMs: number

    What was the average time for a cb to be called

  • events: number

    How many events were called

  • lengthMs: number

    How long this interval was in ms

  • maxMS: number

    What was the max time for a cb to be called

  • minMS: number

    What was the min time for a cb to be called

Variables

Const LatencyMonitor_base

LatencyMonitor_base: EventEmitterFactory