Struct libp2p::yamux::YamuxConfig [−][src]
pub struct YamuxConfig { /* fields omitted */ }
Expand description
The yamux configuration.
Implementations
Creates a new YamuxConfig
in client mode, regardless of whether
it will be used for an inbound or outbound upgrade.
Creates a new YamuxConfig
in server mode, regardless of whether
it will be used for an inbound or outbound upgrade.
Sets the size (in bytes) of the receive window per substream.
Sets the maximum size (in bytes) of the receive buffer per substream.
Sets the maximum number of concurrent substreams.
Sets the window update mode that determines when the remote is given new credit for sending more data.
Converts the config into a YamuxLocalConfig
for use with upgrades
of I/O streams that are .
Trait Implementations
Returns the “default value” for a type. Read more
impl<C> InboundUpgrade<C> for YamuxConfig where
C: 'static + AsyncRead + AsyncWrite + Send + Unpin,
impl<C> InboundUpgrade<C> for YamuxConfig where
C: 'static + AsyncRead + AsyncWrite + Send + Unpin,
Output after the upgrade has been successfully negotiated and the handshake performed.
type Future = Ready<Result<<YamuxConfig as InboundUpgrade<C>>::Output, <YamuxConfig as InboundUpgrade<C>>::Error>>
type Future = Ready<Result<<YamuxConfig as InboundUpgrade<C>>::Output, <YamuxConfig as InboundUpgrade<C>>::Error>>
Future that performs the handshake with the remote.
pub fn upgrade_inbound(
self,
io: C,
<YamuxConfig as UpgradeInfo>::Info
) -> <YamuxConfig as InboundUpgrade<C>>::Future
pub fn upgrade_inbound(
self,
io: C,
<YamuxConfig as UpgradeInfo>::Info
) -> <YamuxConfig as InboundUpgrade<C>>::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 YamuxConfig where
C: 'static + AsyncRead + AsyncWrite + Send + Unpin,
impl<C> OutboundUpgrade<C> for YamuxConfig where
C: 'static + AsyncRead + AsyncWrite + Send + Unpin,
Output after the upgrade has been successfully negotiated and the handshake performed.
type Future = Ready<Result<<YamuxConfig as OutboundUpgrade<C>>::Output, <YamuxConfig as OutboundUpgrade<C>>::Error>>
type Future = Ready<Result<<YamuxConfig as OutboundUpgrade<C>>::Output, <YamuxConfig as OutboundUpgrade<C>>::Error>>
Future that performs the handshake with the remote.
pub fn upgrade_outbound(
self,
io: C,
<YamuxConfig as UpgradeInfo>::Info
) -> <YamuxConfig as OutboundUpgrade<C>>::Future
pub fn upgrade_outbound(
self,
io: C,
<YamuxConfig as UpgradeInfo>::Info
) -> <YamuxConfig as OutboundUpgrade<C>>::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
type Info = &'static [u8]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
type InfoIter = Once<<YamuxConfig as UpgradeInfo>::Info>
type InfoIter = Once<<YamuxConfig as UpgradeInfo>::Info>
Iterator returned by protocol_info
.
Returns the list of protocols that are supported. Used during the negotiation process.
Auto Trait Implementations
impl RefUnwindSafe for YamuxConfig
impl Send for YamuxConfig
impl Sync for YamuxConfig
impl Unpin for YamuxConfig
impl UnwindSafe for YamuxConfig
Blanket Implementations
Mutably borrows from an owned value. Read more
fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
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,
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
.
fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
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,
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
.