Expand description
This crate implements the Yamux specification.
It multiplexes independent I/O streams over reliable, ordered connections, such as TCP/IP.
The two primary objects, clients of this crate interact with, are:
Connection
, which wraps the underlying I/O resource, e.g. a socket, and provides methods for opening outbound or accepting inbound streams.Stream
, which implementsfutures::io::AsyncRead
andfutures::io::AsyncWrite
.
Structs§
- Config
- Yamux configuration.
- Connection
- A Yamux connection object.
- Packet
- Byte data produced by the
futures::stream::Stream
impl ofStream
. - Stream
- A multiplexed Yamux stream.
- Stream
Id - The ID of a stream.
Enums§
- Connection
Error - The various error cases a connection may encounter.
- Frame
Decode Error - Possible errors while decoding a message frame.
- Header
Decode Error - Possible errors while decoding a message frame header.
- Mode
- How the connection is used.