Enum libp2p_mplex::MaxBufferBehaviour
source · pub enum MaxBufferBehaviour {
ResetStream,
Block,
}
Expand description
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§
source§impl Clone for MaxBufferBehaviour
impl Clone for MaxBufferBehaviour
source§fn clone(&self) -> MaxBufferBehaviour
fn clone(&self) -> MaxBufferBehaviour
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more