Struct libp2p_mplex::MplexConfig

source · [−]

pub struct MplexConfig { /* private fields */ }

Expand description

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.

Trait Implementations

impl Clone for MplexConfig

fn clone(&self) -> MplexConfig

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for MplexConfig

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

Formats the value using the given formatter. Read more

impl Default for MplexConfig

fn default() -> MplexConfig

Returns the “default value” for a type. Read more

impl<C> InboundUpgrade<C> for MplexConfig where
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<Self::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. Read more

impl<C> OutboundUpgrade<C> for MplexConfig where
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<Self::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. Read more

impl UpgradeInfo for MplexConfig

type Info = &'static [u8 ]

Opaque type representing a negotiable protocol.

type InfoIter = Once<Self::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.

Auto Trait Implementations

impl RefUnwindSafe for MplexConfig

impl Send for MplexConfig

impl Sync for MplexConfig

impl Unpin for MplexConfig

impl UnwindSafe for MplexConfig

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>,

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V