Struct libp2p_yamux::YamuxConfig
source · [−]pub struct YamuxConfig { /* private fields */ }
Expand description
The yamux configuration.
Implementations
sourceimpl YamuxConfig
impl YamuxConfig
sourcepub fn client() -> Self
pub fn client() -> Self
Creates a new YamuxConfig
in client mode, regardless of whether
it will be used for an inbound or outbound upgrade.
sourcepub fn server() -> Self
pub fn server() -> Self
Creates a new YamuxConfig
in server mode, regardless of whether
it will be used for an inbound or outbound upgrade.
sourcepub fn set_receive_window_size(&mut self, num_bytes: u32) -> &mut Self
pub fn set_receive_window_size(&mut self, num_bytes: u32) -> &mut Self
Sets the size (in bytes) of the receive window per substream.
sourcepub fn set_max_buffer_size(&mut self, num_bytes: usize) -> &mut Self
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.
sourcepub fn set_max_num_streams(&mut self, num_streams: usize) -> &mut Self
pub fn set_max_num_streams(&mut self, num_streams: usize) -> &mut Self
Sets the maximum number of concurrent substreams.
sourcepub fn set_window_update_mode(&mut self, mode: WindowUpdateMode) -> &mut Self
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.
sourcepub fn into_local(self) -> YamuxLocalConfig
pub fn into_local(self) -> YamuxLocalConfig
Converts the config into a YamuxLocalConfig
for use with upgrades
of I/O streams that are .
Trait Implementations
sourceimpl Clone for YamuxConfig
impl Clone for YamuxConfig
sourcefn clone(&self) -> YamuxConfig
fn clone(&self) -> YamuxConfig
Returns a copy of the value. Read more
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl Debug for YamuxConfig
impl Debug for YamuxConfig
sourceimpl Default for YamuxConfig
impl Default for YamuxConfig
sourceimpl<C> InboundUpgrade<C> for YamuxConfigwhere
C: AsyncRead + AsyncWrite + Send + Unpin + 'static,
impl<C> InboundUpgrade<C> for YamuxConfigwhere
C: AsyncRead + AsyncWrite + Send + Unpin + 'static,
type Output = Yamux<Incoming<C>>
type Output = Yamux<Incoming<C>>
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.
sourcefn upgrade_inbound(self, io: C, _: Self::Info) -> Self::Future
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. Read more
sourceimpl<C> OutboundUpgrade<C> for YamuxConfigwhere
C: AsyncRead + AsyncWrite + Send + Unpin + 'static,
impl<C> OutboundUpgrade<C> for YamuxConfigwhere
C: AsyncRead + AsyncWrite + Send + Unpin + 'static,
type Output = Yamux<Incoming<C>>
type Output = Yamux<Incoming<C>>
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.
sourcefn upgrade_outbound(self, io: C, _: Self::Info) -> Self::Future
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. Read more
sourceimpl UpgradeInfo for YamuxConfig
impl UpgradeInfo for YamuxConfig
type InfoIter = Once<<YamuxConfig as UpgradeInfo>::Info>
type InfoIter = Once<<YamuxConfig as UpgradeInfo>::Info>
Iterator returned by
protocol_info
.sourcefn protocol_info(&self) -> Self::InfoIter
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 YamuxConfig
impl Send for YamuxConfig
impl Sync for YamuxConfig
impl Unpin for YamuxConfig
impl UnwindSafe for YamuxConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<C, U> InboundUpgradeExt<C> for Uwhere
U: InboundUpgrade<C>,
impl<C, U> InboundUpgradeExt<C> for Uwhere
U: InboundUpgrade<C>,
sourcefn 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
.sourcefn 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
.sourceimpl<C, U> OutboundUpgradeExt<C> for Uwhere
U: OutboundUpgrade<C>,
impl<C, U> OutboundUpgradeExt<C> for Uwhere
U: OutboundUpgrade<C>,
sourcefn 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
.sourcefn 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
.