Struct s2n_quic_transport::recovery::cubic::CubicCongestionController

pub struct CubicCongestionController { /* private fields */ }

A congestion controller that implements “CUBIC for Fast Long-Distance Networks” as specified in https://tools.ietf.org/html/rfc8312. The Hybrid Slow Start algorithm is used for determining the slow start threshold.

Implementations

impl CubicCongestionController

pub fn new(max_datagram_size: u16) -> CubicCongestionController

Trait Implementations

impl Clone for CubicCongestionController

fn clone(&self) -> CubicCongestionController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CongestionController for CubicCongestionController

fn congestion_window(&self) -> u32

Returns the size of the current congestion window in bytes

fn bytes_in_flight(&self) -> u32

Returns the current bytes in flight

fn is_congestion_limited(&self) -> bool

Returns true if the congestion window does not have sufficient space for a packet of max_datagram_size considering the current bytes in flight

fn requires_fast_retransmission(&self) -> bool

Returns true if the current state of the congestion controller requires a packet to be transmitted without respecting the available congestion window

fn on_packet_sent(
    &mut self,
    time_sent: Timestamp,
    bytes_sent: usize,
    rtt_estimator: &RttEstimator
)

Invoked whenever a congestion controlled packet is sent

fn on_rtt_update(&mut self, time_sent: Timestamp, rtt_estimator: &RttEstimator)

Invoked each time the round trip time is updated, which is whenever the largest acknowledged packet in an ACK frame is newly acknowledged

fn on_packet_ack(
    &mut self,
    largest_acked_time_sent: Timestamp,
    sent_bytes: usize,
    rtt_estimator: &RttEstimator,
    ack_receive_time: Timestamp
)

Invoked for each newly acknowledged packet

fn on_packets_lost(
    &mut self,
    lost_bytes: u32,
    persistent_congestion: bool,
    timestamp: Timestamp
)

Invoked when packets are declared lost

fn on_congestion_event(&mut self, event_time: Timestamp)

Invoked from on_packets_lost, but is also directly invoked when the Explicit Congestion Notification counter increases.

fn on_mtu_update(&mut self, max_datagram_size: u16)

Invoked when the path maximum transmission unit is updated.

fn on_packet_discarded(&mut self, bytes_sent: usize)

Invoked for each packet discarded when a packet number space is discarded.

fn earliest_departure_time(&self) -> Option<Timestamp>

Returns the earliest time that a packet may be transmitted.

impl Debug for CubicCongestionController

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

Formats the value using the given formatter.