Struct libp2p_mplex::MplexConfig

pub struct MplexConfig { /* private fields */ }

Configuration for the multiplexer.

Implementations

impl MplexConfig

pub fn new() -> MplexConfig

Builds the default configuration.

pub fn set_max_num_streams(&mut self, max: usize) -> &mut Self

Sets the maximum number of simultaneously used substreams.

A substream is used as long as it has not been dropped, even if it may already be closed or reset at the protocol level (in which case it may still have buffered data that can be read before the StreamMuxer API signals EOF).

When the limit is reached, opening of outbound substreams is delayed until another substream is dropped, whereas new inbound substreams are immediately answered with a Reset. If the number of inbound substreams that need to be reset accumulates too quickly (judged by internal bounds), the connection is closed with an error due to the misbehaved remote.

pub fn set_max_buffer_size(&mut self, max: usize) -> &mut Self

Sets the maximum number of frames buffered per substream.

A limit is necessary in order to avoid DoS attacks.

pub fn set_max_buffer_behaviour(
    &mut self,
    behaviour: MaxBufferBehaviour
) -> &mut Self

Sets the behaviour when the maximum buffer size is reached for a substream.

See the documentation of MaxBufferBehaviour.

pub fn set_split_send_size(&mut self, size: usize) -> &mut Self

Sets the frame size used when sending data. Capped at 1Mbyte as per the Mplex spec.

pub fn set_protocol_name(&mut self, protocol_name: &'static [u8]) -> &mut Self

Set the protocol name.

use libp2p_mplex::MplexConfig;
let mut muxer_config = MplexConfig::new();
muxer_config.set_protocol_name(b"/mplex/6.7.0");

Trait Implementations

impl Clone for MplexConfig

fn clone(&self) -> MplexConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MplexConfig

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

Formats the value using the given formatter.

impl Default for MplexConfig

fn default() -> MplexConfig

Returns the “default value” for a type.

impl<C> InboundUpgrade<C> for MplexConfigwhere
    C: AsyncRead + AsyncWrite + Unpin,

type Output = Multiplex<C>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Error

Possible error during the handshake.

type Future = Ready<Result<<MplexConfig as InboundUpgrade<C>>::Output, Error>>

Future that performs the handshake with the remote.

fn upgrade_inbound(self, socket: C, _: Self::Info) -> Self::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake.

impl<C> OutboundUpgrade<C> for MplexConfigwhere
    C: AsyncRead + AsyncWrite + Unpin,

type Output = Multiplex<C>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Error

Possible error during the handshake.

type Future = Ready<Result<<MplexConfig as OutboundUpgrade<C>>::Output, Error>>

Future that performs the handshake with the remote.

fn upgrade_outbound(self, socket: C, _: Self::Info) -> Self::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake.

impl UpgradeInfo for MplexConfig

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<<MplexConfig as UpgradeInfo>::Info>

Iterator returned by protocol_info.

fn protocol_info(&self) -> Self::InfoIter

Returns the list of protocols that are supported. Used during the negotiation process.