cmux

README

Cmux

Cmux is a stream router

License

Licensed under the MIT License. See LICENSE for the full license text.

Documentation

Index

• Variables
• func Unread(reader io.Reader, prefix []byte) io.Reader
• func UnreadConn(conn net.Conn, prefix []byte) net.Conn
• func UnwrapUnread(reader io.Reader) (io.Reader, []byte)
• func UnwrapUnreadConn(conn net.Conn) (net.Conn, []byte)
• type CMux
  • func NewCMux() *CMux
  • func (m *CMux) HandlePrefix(handler Handler, prefixes ...string) error
  • func (m *CMux) Handler(r io.Reader) (handler Handler, prefix []byte, err error)
  • func (m *CMux) NotFound(handler Handler) error
  • func (m *CMux) ServeConn(conn net.Conn)
• type Handler
• type HandlerFunc
  • func (h HandlerFunc) ServeConn(conn net.Conn)
• type MuxListener
  • func NewMuxListener(listener net.Listener) *MuxListener
  • func (m *MuxListener) MatchPrefix(prefixes ...string) (net.Listener, error)
  • func (m *MuxListener) Unmatched() (net.Listener, error)

Variables

var ErrListenerClosed = fmt.Errorf("listener closed")

var (
	ErrNotFound = fmt.Errorf("error not found")
)

Functions

func Unread

func Unread(reader io.Reader, prefix []byte) io.Reader

func UnreadConn

func UnreadConn(conn net.Conn, prefix []byte) net.Conn

func UnwrapUnread

func UnwrapUnread(reader io.Reader) (io.Reader, []byte)

func UnwrapUnreadConn

func UnwrapUnreadConn(conn net.Conn) (net.Conn, []byte)

Types

type CMux

type CMux struct {
	// contains filtered or unexported fields
}

CMux is an Applicative protocol multiplexer It matches the prefix of each incoming reader against a list of registered patterns and calls the handler for the pattern that most closely matches the Handler.

func NewCMux

func NewCMux() *CMux

NewCMux create a new CMux.

func (*CMux) HandlePrefix

func (m *CMux) HandlePrefix(handler Handler, prefixes ...string) error

HandlePrefix handle the handler that matches the prefix

func (*CMux) Handler

func (m *CMux) Handler(r io.Reader) (handler Handler, prefix []byte, err error)

Handler returns most matching handler and prefix bytes data to use for the given reader.

func (*CMux) NotFound

func (m *CMux) NotFound(handler Handler) error

NotFound handle the handler that unmatched

func (*CMux) ServeConn

func (m *CMux) ServeConn(conn net.Conn)

ServeConn dispatches the reader to the handler whose pattern most closely matches the reader.

type Handler

type Handler interface {
	ServeConn(conn net.Conn)
}

type HandlerFunc

type HandlerFunc func(conn net.Conn)

func (HandlerFunc) ServeConn

func (h HandlerFunc) ServeConn(conn net.Conn)

type MuxListener

type MuxListener struct {
	ErrHandler func(err error) bool
	// contains filtered or unexported fields
}

MuxListener is a multiplexer for network connections

func NewMuxListener

func NewMuxListener(listener net.Listener) *MuxListener

NewMuxListener create a new MuxListener.

func (*MuxListener) MatchPrefix

func (m *MuxListener) MatchPrefix(prefixes ...string) (net.Listener, error)

MatchPrefix returns the net.Listener that matches the prefix

func (*MuxListener) Unmatched

func (m *MuxListener) Unmatched() (net.Listener, error)

Unmatched returns the net.Listener that unmatched