Struct CongestionWindow

pub(crate) struct CongestionWindow {
    params: CongestionWindowParams,
    value: u32,
    is_full: bool,
}

A congestion window. This is generic for all algorithms but their parameters’ value will differ depending on the selected algorithm.

Fields

params: CongestionWindowParams

Congestion window parameters from the consensus.

value: u32

The actual value of our congestion window.

is_full: bool

The congestion window is full.

Implementations

impl CongestionWindow

fn new(params: &CongestionWindowParams) -> Self

Constructor taking consensus parameters.

pub(crate) fn dec(&mut self)

Decrement the window by the increment value.

pub(crate) fn inc(&mut self)

Increment the window by the increment value.

pub(crate) fn get(&self) -> u32

Return the current value.

pub(crate) fn update_rate(&self, state: &State) -> u32

Return the expected rate for which the congestion window should be updated at.

See CWND_UPDATE_RATE in prop324.

pub(crate) fn min(&self) -> u32

Return minimum value of the congestion window.

pub(crate) fn set(&mut self, value: u32)

Set the congestion window value with a new value.

pub(crate) fn increment(&self) -> u32

Return the increment value.

pub(crate) fn increment_rate(&self) -> u32

Return the rate at which we should increment the window.

pub(crate) fn is_full(&self) -> bool

Return true iff this congestion window is full.

pub(crate) fn reset_full(&mut self)

Reset the full flag meaning it is now not full.

pub(crate) fn sendme_per_cwnd(&self) -> u32

Return the number of expected SENDMEs per congestion window.

Spec: prop324 SENDME_PER_CWND definition

pub(crate) fn rfc3742_ss_inc(&mut self, ss_cap: u32) -> u32

Return the RFC3742 slow start increment value.

Spec: prop324 rfc3742_ss_inc definition

pub(crate) fn eval_fullness( &mut self, inflight: u32, full_gap: u32, full_minpct: u32, )

Evaluate the fullness of the window with the given parameters.

Spec: prop324 see cwnd_is_full and cwnd_is_nonfull definition. C-tor: cwnd_became_full() and cwnd_became_nonfull()

pub(crate) fn sendme_inc(&self) -> u32

Return the SENDME increment value.

pub(crate) fn params(&self) -> &CongestionWindowParams

Available on crate feature conflux only.

Return the congestion window params.

Trait Implementations

impl Clone for CongestionWindow

fn clone(&self) -> CongestionWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CongestionWindow

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

Formats the value using the given formatter.