Struct libp2p_yamux::Config

pub struct Config(/* private fields */);

The yamux configuration.

Implementations

impl Config

pub fn client() -> Self

👎Deprecated: Will be removed with the next breaking release.

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

pub fn server() -> Self

👎Deprecated: Will be removed with the next breaking release.

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

👎Deprecated: Will be replaced in the next breaking release with a connection receive window size limit.

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

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

👎Deprecated: Will be removed with the next breaking release.

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

👎Deprecated: WindowUpdate::OnRead is the default. WindowUpdate::OnReceive breaks backpressure, is thus not recommended, and will be removed in the next breaking release. Thus this method becomes obsolete and will be removed with the next breaking release.

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<C> InboundConnectionUpgrade<C> for Config

where C: AsyncRead + AsyncWrite + Send + Unpin + 'static,

type Output = Muxer<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<<Config as InboundConnectionUpgrade<C>>::Output, <Config as InboundConnectionUpgrade<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> OutboundConnectionUpgrade<C> for Config

where C: AsyncRead + AsyncWrite + Send + Unpin + 'static,

type Output = Muxer<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<<Config as OutboundConnectionUpgrade<C>>::Output, <Config as OutboundConnectionUpgrade<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 Config

type Info = &'static str

Opaque type representing a negotiable protocol.

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