Golang connection multiplexing library
Go
Latest commit d1caa6c Jul 21, 2016 @slackpad slackpad committed on GitHub Merge pull request #34 from erikdubbelboer/recvrace
Fix race for recvBuf
Permalink
Failed to load latest commit information.
.gitignore Initial commit May 22, 2014
LICENSE Initial commit May 22, 2014
README.md README cleanup May 29, 2014
addr.go
bench_test.go Adding basic benchmarks May 27, 2014
const.go Tests and improvements to #19 KeepAlive is not working Sep 10, 2015
const_test.go Removing compression May 24, 2014
mux.go Generalizes the header write timeout to a broader "safety valve" writ… Aug 19, 2015
session.go Tweaked error messages. May 18, 2016
session_test.go add a test for the problem May 12, 2016
spec.md fixed spelling mistake Jun 9, 2016
stream.go Merge pull request #34 from erikdubbelboer/recvrace Jul 20, 2016
util.go Adding utility methods May 23, 2014
util_test.go Adding utility methods May 23, 2014

README.md

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
    conn, err := net.Dial(...)
    if err != nil {
        panic(err)
    }

    // Setup client side of yamux
    session, err := yamux.Client(conn, nil)
    if err != nil {
        panic(err)
    }

    // Open a new stream
    stream, err := session.Open()
    if err != nil {
        panic(err)
    }

    // Stream implements net.Conn
    stream.Write([]byte("ping"))
}

func server() {
    // Accept a TCP connection
    conn, err := listener.Accept()
    if err != nil {
        panic(err)
    }

    // Setup server side of yamux
    session, err := yamux.Server(conn, nil)
    if err != nil {
        panic(err)
    }

    // Accept a stream
    stream, err := session.Accept()
    if err != nil {
        panic(err)
    }

    // Listen for a message
    buf := make([]byte, 4)
    stream.Read(buf)
}