mux

Documentation

Index

• Variables
• func Get(name string) (string, bool)
• func NewMuxWithConfig(conf *Config) (stream.Handler, error)
• func RegisterRegexp(name string, pattern string)
• func Unread(reader io.Reader, prefix []byte) io.Reader
• func UnreadStream(rwc stream.Stream, prefix []byte) stream.Stream
• func UnwrapUnread(reader io.Reader) (io.Reader, []byte)
• func UnwrapUnreadStream(rwc stream.Stream) (stream.Stream, []byte)
• type Config
• type Mux
  • func NewMux() *Mux
  • func (m *Mux) HandlePrefix(prefix string, handler stream.Handler) error
  • func (m *Mux) HandleRegexp(pattern string, handler stream.Handler) error
  • func (m *Mux) Handler(r io.Reader) (handler stream.Handler, prefix []byte, err error)
  • func (m *Mux) NotFound(handler stream.Handler) error
  • func (m *Mux) ServeStream(ctx context.Context, stm stream.Stream)
• type Route

Variables

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

Functions

func Get

func Get(name string) (string, bool)

func NewMuxWithConfig

func NewMuxWithConfig(conf *Config) (stream.Handler, error)

NewProtoMux create a new Mux with config.

func RegisterRegexp

func RegisterRegexp(name string, pattern string)

func Unread

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

func UnreadStream

func UnreadStream(rwc stream.Stream, prefix []byte) stream.Stream

func UnwrapUnread

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

func UnwrapUnreadStream

func UnwrapUnreadStream(rwc stream.Stream) (stream.Stream, []byte)

Types

type Config

type Config struct {
	Routes   []*Route
	NotFound stream.Handler
}

type Mux

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

Mux 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 NewMux

func NewMux() *Mux

NewProtoMux create a new Mux.

func (*Mux) HandlePrefix

func (m *Mux) HandlePrefix(prefix string, handler stream.Handler) error

func (*Mux) HandleRegexp

func (m *Mux) HandleRegexp(pattern string, handler stream.Handler) error

func (*Mux) Handler

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

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

func (*Mux) NotFound

func (m *Mux) NotFound(handler stream.Handler) error

NotFound replies to the handler with an Handler not found error.

func (*Mux) ServeStream

func (m *Mux) ServeStream(ctx context.Context, stm stream.Stream)

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

type Route

type Route struct {
	Pattern string `json:",omitempty"`
	Regexp  string `json:",omitempty"`
	Prefix  string `json:",omitempty"`
	Handler stream.Handler
}