mirror of
https://github.com/42wim/matterbridge.git
synced 2024-11-25 21:49:43 +01:00
d16645c952
* Update mattermost library * Fix linting |
||
---|---|---|
.. | ||
.gitignore | ||
addr.go | ||
const.go | ||
LICENSE | ||
mux.go | ||
README.md | ||
session.go | ||
spec.md | ||
stream.go | ||
util.go |
Yamux
Yamux (Yet another Multiplexer) is a multiplexing library for Golang. It relies on an underlying connection to provide reliability and ordering, such as TCP or Unix domain sockets, and provides stream-oriented multiplexing. It is inspired by SPDY but is not interoperable with it.
Yamux features include:
- Bi-directional streams
- Streams can be opened by either client or server
- Useful for NAT traversal
- Server-side push support
- Flow control
- Avoid starvation
- Back-pressure to prevent overwhelming a receiver
- Keep Alives
- Enables persistent connections over a load balancer
- Efficient
- Enables thousands of logical streams with low overhead
Documentation
For complete documentation, see the associated Godoc.
Specification
The full specification for Yamux is provided in the
spec.md
file. It can be used as a guide to implementors of
interoperable libraries.
Usage
Using Yamux is remarkably simple:
func client() {
// Get a TCP connection
, err := net.Dial(...)
connif err != nil {
panic(err)
}
// Setup client side of yamux
, err := yamux.Client(conn, nil)
sessionif err != nil {
panic(err)
}
// Open a new stream
, err := session.Open()
streamif err != nil {
panic(err)
}
// Stream implements net.Conn
.Write([]byte("ping"))
stream}
func server() {
// Accept a TCP connection
, err := listener.Accept()
connif err != nil {
panic(err)
}
// Setup server side of yamux
, err := yamux.Server(conn, nil)
sessionif err != nil {
panic(err)
}
// Accept a stream
, err := session.Accept()
streamif err != nil {
panic(err)
}
// Listen for a message
:= make([]byte, 4)
buf .Read(buf)
stream}