smux

Documentation

Index

• Variables
• func Listen(opts *ListenOpts) net.Listener
• func NewSmuxProtocol(config *smux.Config) *smuxProtocol
• type DialFN
  • func Dialer(opts *DialerOpts) DialFN
• type DialerOpts
• type ErrorMapperFn
• type ListenOpts
• type Protocol
• type Session

Variables

var (
	ErrClosed = errors.New("listener closed")
)

var (
	ErrTimeout = &timeoutError{}
)

Functions

func Listen

func Listen(opts *ListenOpts) net.Listener

Listen creates a net.Listener that multiplexes connections over a connection obtained from the underlying opts.Listener.

func NewSmuxProtocol

func NewSmuxProtocol(config *smux.Config) *smuxProtocol

NewSmuxProtocol creates a new smux based Protocol using the smux configuration givien. If config is nil, the default smux configuration is used.

Types

type DialFN

type DialFN func(ctx context.Context, network, addr string) (net.Conn, error)

DialFN is a function that dials like net.DialContext.

func Dialer

func Dialer(opts *DialerOpts) DialFN

Dialer creates a DialFN that returns connections that multiplex themselves over a single connection obtained from the underlying opts.Dial function. It will continue to use that single connection until and unless it encounters an error creating a new multiplexed stream, at which point it will dial again.

type DialerOpts

type DialerOpts struct {
	Dial     DialFN
	PoolSize int
	Protocol Protocol
}

type ErrorMapperFn

type ErrorMapperFn func(error) error

type ListenOpts

type ListenOpts struct {
	Listener net.Listener
	Protocol Protocol
}

type Protocol

type Protocol interface {
	Client(net.Conn) (Session, error)
	Server(net.Conn) (Session, error)
	TranslateError(error) error
}

type Session

type Session interface {
	OpenStream() (net.Conn, error)
	AcceptStream() (net.Conn, error)
	Close() error
	NumStreams() int
}