Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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
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

mux

package module

Go to main page

Versions in this module

v0

v0.2.0

Mar 9, 2024

Changes in this version

+ const InitialStreamQuota

+ var ErrKeepaliveTimedOut = errors.New("keepalive ping timed out")

+ var ErrPayloadOverflowed = errors.New("payload size is to large")

+ var ErrSessionClosed = errors.New("session closed")

+ var ErrSessionEoL = errors.New("session end of life")

+ var ErrStreamQuotaLimit = errors.New("stream quota limit")

+ var ErrTooManyStreams = errors.New("too many streams")

type Opts

+ KeepaliveInterval time.Duration

+ KeepaliveTimeout time.Duration

+ MaxConcurrentStreams int32

+ OnClose func(session *Session, err error)

+ ReadBufferSize int

+ WriteBufferSize int

+ WriteTimeout time.Duration

type Session

+ func (s *Session) CloseWithErr(err error)

+ func (s *Session) Context() context.Context

+ func (s *Session) Ping(ctx context.Context) error

+ func (s *Session) ReserveStreamN(n int32) (reserved int32)

+ func (s *Session) Status() SessionStatus

+ type SessionStatus struct

+ ActiveStreams int

+ Closed bool

+ LocalStreamQuota int32

+ OpenedSid int32

+ PeerStreamQuota int32

+ Reserved int32

type Stream

+ func (s *Stream) CloseWithErr(err error)

+ func (s *Stream) Context() context.Context

v0.1.3

Oct 8, 2023

v0.1.2

Oct 8, 2023

v0.1.1

Sep 16, 2023

Changes in this version

+ var ErrIdleTimedOut = errors.New("idle timed out")

+ var ErrPingTimedOut = errors.New("ping timed out")

v0.1.0

Aug 18, 2023

Changes in this version

+ const MaxStreamNum

+ const MaxWindow

+ const MinWindow

+ var ErrAcceptNotAllowed = errors.New("accept is not allowed")

+ var ErrClosedSession = errors.New("closed session")

+ var ErrClosedStream = errors.New("closed stream")

+ var ErrFlowWindowOverflow = errors.New("flow control window overflowed")

+ var ErrIdleTimeout = errors.New("idle timed out")

+ var ErrInvalidSID = errors.New("invalid stream id")

+ var ErrInvalidSynFrame = errors.New("invalid syn frame")

+ var ErrPingTimeout = errors.New("ping timed out")

+ var ErrStreamIdOverFlowed = errors.New("stream id is overflowed")

+ type Opts struct

+ AllowAccept bool

+ IdleTimeout time.Duration

+ PingInterval time.Duration

+ PingTimeout time.Duration

+ StreamReceiveWindow uint32

+ type Session struct

+ func NewSession(c io.ReadWriteCloser, opts Opts) *Session

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

+ func (s *Session) Close() error

+ func (s *Session) CloseErr() error

+ func (s *Session) Closed() bool

+ func (s *Session) OngoingStreams() int

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

+ func (s *Session) ReserveStream() bool

+ func (s *Session) SubConn() io.ReadWriteCloser

+ type Stream struct

+ func (s *Stream) Close() error

+ func (s *Stream) ID() int32

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

+ func (s *Stream) ReadBufferSize() int

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

+ func (s *Stream) SetRxWindowSize(n uint32)

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

+ func (s *Stream) WriteTo(w io.Writer) (int64, error)