Struct RttEstimator

pub struct RttEstimator { /* private fields */ }

Implementations

impl RttEstimator

pub fn new(initial_rtt: Duration) -> Self

Creates a new RTT Estimator with the given initial_rtt

on_max_ack_delay must be called when the max_ack_delay transport parameter is received to initialize the max_ack_delay value.

pub fn for_new_path(&self, initial_rtt: Duration) -> Self

Creates a new RTT Estimator with the max_ack_delay from the current instance

pub fn latest_rtt(&self) -> Duration

Gets the latest round trip time sample

pub fn smoothed_rtt(&self) -> Duration

Gets the weighted average round trip time

pub fn min_rtt(&self) -> Duration

Gets the minimum round trip time

pub fn rttvar(&self) -> Duration

Gets the variance in observed round trip time samples

pub fn first_rtt_sample(&self) -> Option<Timestamp>

Gets the timestamp of the first RTT sample

pub fn max_ack_delay(&self) -> Duration

Gets the max_ack_delay

pub fn pto_period(&self, pto_backoff: u32, space: PacketNumberSpace) -> Duration

pub fn on_max_ack_delay(&mut self, max_ack_delay: MaxAckDelay)

Sets the max_ack_delay value from the peer MaxAckDelay transport parameter

pub fn update_rtt( &mut self, ack_delay: Duration, rtt_sample: Duration, timestamp: Timestamp, is_handshake_confirmed: bool, space: PacketNumberSpace, )

Updates the RTT estimate using the given rtt_sample

pub fn persistent_congestion_threshold(&self) -> Duration

Calculates the persistent congestion threshold used for determining if persistent congestion is being encountered.

pub fn loss_time_threshold(&self) -> Duration

pub fn on_persistent_congestion(&mut self)

Allows min_rtt and smoothed_rtt to be overwritten on the next RTT sample after persistent congestion is established.

Trait Implementations

impl Clone for RttEstimator

fn clone(&self) -> RttEstimator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RttEstimator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RttEstimator

fn default() -> Self

Creates a new RTT Estimator with default initial values

impl Hash for RttEstimator

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RttEstimator

fn eq(&self, other: &RttEstimator) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RttEstimator

impl Eq for RttEstimator

impl StructuralPartialEq for RttEstimator