Class RoundTripTimeState

State for tracking RTT using exponential moving average.

Note

Used by both client and host to calculate smoothed RTT and jitter. Initialize with default values and pass to CalculateRoundTripTime for each sample.

Index

Constructors

Properties

_jitter _sampleCount _smoothedRoundTripTime

Accessors

jitter sampleCount smoothedRoundTripTime

Methods

clone isEqual isEqual

Constructors

constructor

new RoundTripTimeState(
    smoothedRoundTripTime?: number,
    jitter?: number,
    sampleCount?: number,
): RoundTripTimeState
Parameters
- OptionalsmoothedRoundTripTime: number
- Optionaljitter: number
- OptionalsampleCount: number
Returns RoundTripTimeState

Properties

`Protected`_jitter

_jitter: number

`Protected`_sampleCount

_sampleCount: number

`Protected`_smoothedRoundTripTime

_smoothedRoundTripTime: number

Accessors

jitter

get jitter(): number

RTT jitter (variation) in milliseconds.

Returns number

sampleCount

get sampleCount(): number

Number of RTT samples collected.

Returns number

smoothedRoundTripTime

get smoothedRoundTripTime(): number

Smoothed round-trip time in milliseconds.

Returns number

Methods

clone

clone(): RoundTripTimeState

Clones this instance and returns a new RoundTripTimeState with identical values.

Returns RoundTripTimeState

isEqual

isEqual(
this: Immutable<RoundTripTimeState>,
other: Immutable<RoundTripTimeState>,
): boolean
Determines if this RoundTripTimeState instance is equal to the other instance.
Parameters
- this: Immutable<RoundTripTimeState>
- other: Immutable<RoundTripTimeState>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<RoundTripTimeState>,
rhs: Immutable<RoundTripTimeState>,
): boolean
Determines if both RoundTripTimeState instances are equal.
Parameters
- lhs: Immutable<RoundTripTimeState>
- rhs: Immutable<RoundTripTimeState>
Returns boolean