Struct libp2p_yamux::YamuxConfig

pub struct YamuxConfig { /* private fields */ }

The yamux configuration.

Implementations

impl YamuxConfig

pub fn client() -> Self

Creates a new YamuxConfig in client mode, regardless of whether it will be used for an inbound or outbound upgrade.

pub fn server() -> Self

Creates a new YamuxConfig in server mode, regardless of whether it will be used for an inbound or outbound upgrade.

pub fn set_receive_window_size(&mut self, num_bytes: u32) -> &mut Self

Sets the size (in bytes) of the receive window per substream.

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

Sets the maximum size (in bytes) of the receive buffer per substream.

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

Sets the maximum number of concurrent substreams.

pub fn set_window_update_mode(&mut self, mode: WindowUpdateMode) -> &mut Self

Sets the window update mode that determines when the remote is given new credit for sending more data.

pub fn into_local(self) -> YamuxLocalConfig

Converts the config into a YamuxLocalConfig for use with upgrades of I/O streams that are ![Send].

Trait Implementations

impl Clone for YamuxConfig

fn clone(&self) -> YamuxConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for YamuxConfig

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

Formats the value using the given formatter.

impl Default for YamuxConfig

fn default() -> Self

Returns the “default value” for a type.

impl<C> InboundUpgrade<C> for YamuxConfigwhere C: AsyncRead + AsyncWrite + Send + Unpin + 'static,

type Output = Yamux<Incoming<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<<YamuxConfig as InboundUpgrade<C>>::Output, <YamuxConfig as InboundUpgrade<C>>::Error>>

Future that performs the handshake with the remote.

fn upgrade_inbound(self, io: 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 YamuxConfigwhere C: AsyncRead + AsyncWrite + Send + Unpin + 'static,

type Output = Yamux<Incoming<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<<YamuxConfig as OutboundUpgrade<C>>::Output, <YamuxConfig as OutboundUpgrade<C>>::Error>>

Future that performs the handshake with the remote.

fn upgrade_outbound(self, io: 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 YamuxConfig

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

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