Expand description
This crate implements the Yamux specification.
It multiplexes independent I/O streams over reliable, ordered connections, such as TCP/IP.
The three primary objects, clients of this crate interact with, are:
Connection
, which wraps the underlying I/O resource, e.g. a socket,Stream
, which implementsfutures::io::AsyncRead
andfutures::io::AsyncWrite
, andControl
, to asynchronously control theConnection
.
Structs
- Yamux configuration.
- A Yamux connection object.
- The Yamux
Connection
controller. - Byte data produced by the
futures::stream::Stream
impl ofStream
. - A multiplexed Yamux stream.
- The ID of a stream.
Enums
- The various error cases a connection may encounter.
- Possible errors while decoding a message frame.
- Possible errors while decoding a message frame header.
- How the connection is used.
- Specifies when window update frames are sent.
Functions
- Turn a Yamux
Connection
into afutures::Stream
.