Enum libp2p_yamux::WindowUpdateMode

pub enum WindowUpdateMode {
    OnReceive,
    OnRead,
}

Specifies when window update frames are sent.

Variants

OnReceive

Send window updates as soon as a Stream's receive window drops to 0.

This ensures that the sender can resume sending more data as soon as possible but a slow reader on the receiving side may be overwhelmed, i.e. it accumulates data in its buffer which may reach its limit (see set_max_buffer_size). In this mode, window updates merely prevent head of line blocking but do not effectively exercise back pressure on senders.

OnRead

Send window updates only when data is read on the receiving end.

This ensures that senders do not overwhelm receivers and keeps buffer usage low. However, depending on the protocol, there is a risk of deadlock, namely if both endpoints want to send data larger than the receivers window and they do not read before finishing their writes. Use this mode only if you are sure that this will never happen, i.e. if

• Endpoints A and B never write at the same time, or
• Endpoints A and B write at most n frames concurrently such that the sum of the frame lengths is less or equal to the available credit of A and B respectively.

Trait Implementations

impl Clone for WindowUpdateMode

fn clone(&self) -> WindowUpdateMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for WindowUpdateMode

impl Debug for WindowUpdateMode

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

Formats the value using the given formatter.

impl Eq for WindowUpdateMode

impl PartialEq<WindowUpdateMode> for WindowUpdateMode

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.