Skip to main content

BandwidthEstimator

Struct BandwidthEstimator 

Source
pub struct BandwidthEstimator { /* private fields */ }
Expand description

BBR-like Bandwidth Estimator

Implementations§

Source§

impl BandwidthEstimator

Source

pub fn new() -> Self

Create a new estimator starting in Startup state.

Source

pub fn on_send(&mut self, bytes: u64)

Notify the estimator that bytes were sent (increases inflight).

Source

pub fn on_ack(&mut self, sample: DeliverySample) -> u64

Process an ACK and update bandwidth estimates.

Returns the new recommended pacing rate (bytes/sec).

Source

pub fn on_loss(&mut self, bytes: u64)

Notify a packet loss — triggers BBRv3 Fast Recovery.

Unlike earlier BBR versions that ignored loss, BBRv3 immediately backs off pacing rate and CWND relative to the lost bytes fraction.

Source

pub fn set_app_limited(&mut self)

Mark the sender as application-limited (not sending at line rate).

Call this when there is no data to send but the CWND has room. Samples produced during app-limited periods won’t update the BW filter, preventing bandwidth underestimation.

Source

pub fn is_app_limited(&self) -> bool

Whether the sender is currently considered application-limited.

Source

pub fn pacing_rate(&self) -> u64

Get current recommended pacing rate (bytes/sec).

Source

pub fn cwnd(&self) -> u64

Get recommended congestion window size (bytes).

Source

pub fn bdp(&self) -> u64

Get the Bandwidth-Delay Product (BDP) in bytes.

Source

pub fn inflight_bytes(&self) -> u64

Get current bytes in flight.

Source

pub fn bottleneck_bandwidth(&self) -> u64

Get estimated bottleneck bandwidth (bytes/sec).

Source

pub fn min_rtt(&self) -> Duration

Get minimum observed RTT.

Source

pub fn state(&self) -> BbrState

Get current BBR state.

Source

pub fn delivered_bytes(&self) -> u64

Get total bytes delivered.

Source

pub fn round_count(&self) -> u32

Get the round count.

Trait Implementations§

Source§

impl Debug for BandwidthEstimator

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BandwidthEstimator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T>
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
Source§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more