Enum libp2p_mplex::MaxBufferBehaviour

pub enum MaxBufferBehaviour {
    ResetStream,
    Block,
}

Behaviour when the maximum length of the buffer is reached.

Variants

ResetStream

Reset the substream whose frame buffer overflowed.

Note: If more than MplexConfig::set_max_buffer_size() frames are received in succession for a substream in the context of trying to read data from a different substream, the former substream may be reset before application code had a chance to read from the buffer. The max. buffer size needs to be sized appropriately when using this option to balance maximum resource usage and the probability of premature termination of a substream.

Block

No new message can be read from the underlying connection from any substream as long as the buffer for a single substream is full, i.e. application code is expected to read from the full buffer.

Note: To avoid blocking without making progress, application tasks should ensure that, when woken, always try to read (i.e. make progress) from every substream on which data is expected. This is imperative in general, as a woken task never knows for which substream it has been woken, but failure to do so with MaxBufferBehaviour::Block in particular may lead to stalled execution or spinning of a task without progress.

Trait Implementations

impl Clone for MaxBufferBehaviour

fn clone(&self) -> MaxBufferBehaviour

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaxBufferBehaviour

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

Formats the value using the given formatter.

impl PartialEq for MaxBufferBehaviour

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MaxBufferBehaviour

impl Eq for MaxBufferBehaviour

impl StructuralPartialEq for MaxBufferBehaviour