Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

yamux

package module

Go to main page

Versions in this module

v0

v0.1.6

Jan 3, 2026

v0.1.5

Oct 14, 2024

Changes in this version

type Config

+ func (c *Config) Clone() *Config

v0.1.4

Aug 10, 2024

v0.1.3

Jul 4, 2024

Changes in this version

+ var ErrConnectionReset = fmt.Errorf("connection reset")

+ var ErrConnectionWriteTimeout = fmt.Errorf("connection write timeout")

+ var ErrDuplicateStream = fmt.Errorf("duplicate stream initiated")

+ var ErrInvalidMsgType = fmt.Errorf("invalid msg type")

+ var ErrInvalidVersion = fmt.Errorf("invalid protocol version")

+ var ErrKeepAliveTimeout = fmt.Errorf("keepalive timeout")

+ var ErrRecvWindowExceeded = fmt.Errorf("recv window exceeded")

+ var ErrRemoteGoAway = fmt.Errorf("remote end is not accepting connections")

+ var ErrSessionShutdown = fmt.Errorf("session shutdown")

+ var ErrStreamClosed = fmt.Errorf("stream closed")

+ var ErrStreamsExhausted = fmt.Errorf("streams exhausted")

+ var ErrTimeout = &NetError

+ var ErrUnexpectedFlag = fmt.Errorf("unexpected flag")

+ func VerifyConfig(config *Config) error

+ type Config struct

+ AcceptBacklog int

+ ConnectionWriteTimeout time.Duration

+ EnableKeepAlive bool

+ KeepAliveInterval time.Duration

+ LogOutput io.Writer

+ Logger Logger

+ MaxStreamWindowSize uint32

+ StreamCloseTimeout time.Duration

+ StreamOpenTimeout time.Duration

+ func DefaultConfig() *Config

+ type Logger interface

+ Print func(v ...interface{})

+ Printf func(format string, v ...interface{})

+ Println func(v ...interface{})

+ type NetError struct

+ func (e *NetError) Error() string

+ func (e *NetError) Temporary() bool

+ func (e *NetError) Timeout() bool

+ type Session struct

+ func Client(conn io.ReadWriteCloser, config *Config) (*Session, error)

+ func Server(conn io.ReadWriteCloser, config *Config) (*Session, error)

+ func (s *Session) Accept() (net.Conn, error)

+ func (s *Session) AcceptStream() (*Stream, error)

+ func (s *Session) AcceptStreamWithContext(ctx context.Context) (*Stream, error)

+ func (s *Session) Addr() net.Addr

+ func (s *Session) Close() error

+ func (s *Session) CloseChan() <-chan struct{}

+ func (s *Session) GoAway() error

+ func (s *Session) IsClosed() bool

+ func (s *Session) LocalAddr() net.Addr

+ func (s *Session) NumStreams() int

+ func (s *Session) Open() (net.Conn, error)

+ func (s *Session) OpenStream() (*Stream, error)

+ func (s *Session) Ping() (time.Duration, error)

+ func (s *Session) RemoteAddr() net.Addr

+ type Stream struct

+ func (s *Stream) Close() error

+ func (s *Stream) LocalAddr() net.Addr

+ func (s *Stream) Read(b []byte) (n int, err error)

+ func (s *Stream) RemoteAddr() net.Addr

+ func (s *Stream) Session() *Session

+ func (s *Stream) SetDeadline(t time.Time) error

+ func (s *Stream) SetReadDeadline(t time.Time) error

+ func (s *Stream) SetWriteDeadline(t time.Time) error

+ func (s *Stream) Shrink()

+ func (s *Stream) StreamID() uint32

+ func (s *Stream) Write(b []byte) (n int, err error)