Struct libp2p_yamux::Config

pub struct Config(_);

The yamux configuration.

Methods

impl Config

pub fn new(cfg: Config) -> Self

pub fn local(self) -> LocalConfig

Turn this into a LocalConfig for use with upgrades of resources.

Methods from Deref<Target = Config>

pub fn set_receive_window(&mut self, n: u32) -> &mut Config

Set the receive window (must be >= 256 KiB).

Panics

If the given receive window is < 256 KiB.

pub fn set_max_buffer_size(&mut self, n: usize) -> &mut Config

Set the max. buffer size per stream.

pub fn set_max_num_streams(&mut self, n: usize) -> &mut Config

Set the max. number of streams.

pub fn set_window_update_mode(&mut self, m: WindowUpdateMode) -> &mut Config

Set the window update mode to use.

pub fn set_read_after_close(&mut self, b: bool) -> &mut Config

Allow or disallow streams to read from buffered data after the connection has been closed.

pub fn set_lazy_open(&mut self, b: bool) -> &mut Config

Enable or disable the sending of an initial window update frame when opening outbound streams.

When enabled, opening a new outbound stream will not result in an immediate send of a frame, instead the first outbound data frame will be marked as opening a stream.

When disabled (the current default), opening a new outbound stream will result in a window update frame being sent immediately to the remote. This allows opening a stream with a custom receive window size (cf. [Config::set_receive_window]) which the remote can directly make use of.

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 Default for Config

fn default() -> Self

Returns the "default value" for a type.

impl Deref for Config

type Target = Config

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Config

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<C> InboundUpgrade<C> for Config where
    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<Self::Output, Self::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 Config where
    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<Self::Output, Self::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 [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.