Struct Estimator

pub struct Estimator { /* private fields */ }

Bandwidth estimator as defined in Delivery Rate Estimation and BBR Congestion Control.

Implementations

impl Estimator

pub fn delivered_bytes(&self) -> u64

Gets the total amount of data in bytes delivered so far over the lifetime of the path, not including non-congestion-controlled packets such as pure ACK packets.

pub fn lost_bytes(&self) -> u64

Gets the total amount of data in bytes lost so far over the lifetime of the path

pub fn rate_sample(&self) -> RateSample

Gets the latest RateSample

pub fn is_app_limited(&self) -> bool

Returns true if the path is currently in an application-limited period

pub fn on_packet_sent( &mut self, prior_bytes_in_flight: u32, sent_bytes: usize, app_limited: Option<bool>, now: Timestamp, ) -> PacketInfo

Called when a packet is transmitted

pub fn on_ack<Pub: Publisher>( &mut self, bytes_acknowledged: usize, newest_acked_time_sent: Timestamp, newest_acked_packet_info: PacketInfo, now: Timestamp, publisher: &mut Pub, )

Called for each acknowledgement of one or more packets

pub fn on_loss(&mut self, lost_bytes: usize)

Called when packets are declared lost

pub fn on_packet_discarded(&mut self, bytes_sent: usize)

Called when packets are discarded

pub fn on_explicit_congestion(&mut self, ce_count: u64)

Called each time explicit congestion is recorded

pub fn on_app_limited(&mut self, bytes_in_flight: u32)

Mark the path as app limited until the given bytes_in_flight are acknowledged

Trait Implementations

impl Clone for Estimator

fn clone(&self) -> Estimator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Estimator

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

Formats the value using the given formatter.

impl Default for Estimator

fn default() -> Estimator

Returns the “default value” for a type.