net

Documentation

Index

• func RegisterDialerFactory(scheme []string, ...) error
• type ContextDialer
  • func CreateDialer(u *url.URL, dialer ContextDialer) (ContextDialer, error)
• type DialContextFunc
  • func (f DialContextFunc) Dial(network, address string) (net.Conn, error)
  • func (f DialContextFunc) DialContext(ctx context.Context, network, address string) (net.Conn, error)
• type DialFunc
  • func (f DialFunc) Dial(network, address string) (net.Conn, error)
  • func (f DialFunc) DialContext(ctx context.Context, network, address string) (net.Conn, error)
• type Dialer
• type Forwarder
• type ForwarderFunc
  • func (f ForwarderFunc) Forward(ctx context.Context, c net.Conn) error
• type Listener
• type OverrideAddr
  • func (a *OverrideAddr) Network() string
  • func (a *OverrideAddr) String() string
• type OverrideConn
  • func (c *OverrideConn) LocalAddr() net.Addr
  • func (c *OverrideConn) RemoteAddr() net.Addr
• type OverrideListener
  • func (l *OverrideListener) Accept() (c net.Conn, e error)
• type PipeListener
  • func ListenPipe() *PipeListener
  • func (l *PipeListener) Accept() (c net.Conn, e error)
  • func (l *PipeListener) Addr() net.Addr
  • func (l *PipeListener) Close() (e error)
  • func (l *PipeListener) Dial(network, addr string) (net.Conn, error)
  • func (l *PipeListener) DialContext(ctx context.Context, network, addr string) (conn net.Conn, e error)
  • func (l *PipeListener) Forward(ctx context.Context, conn net.Conn) (e error)
• type PrefixConn
  • func (b *PrefixConn) Read(p []byte) (n int, err error)
  • func (b *PrefixConn) ReadFrom(r io.Reader) (n int64, err error)
  • func (b *PrefixConn) WriteTo(w io.Writer) (n int64, err error)
• type ServeMux
  • func (r *ServeMux) Forward(ctx context.Context, c net.Conn) error
  • func (r *ServeMux) HandlePrefix(prefix []byte, forwarder Forwarder)
  • func (r *ServeMux) HandleTLSProto(proto string, forwarder Forwarder)

Functions

func RegisterDialerFactory

func RegisterDialerFactory(scheme []string, factory func(u *url.URL, dialer ContextDialer) (ContextDialer, error)) error

Types

type ContextDialer

type ContextDialer interface {
	// Returns connection if successful, or an error.
	// The context is used to cancel the dial. It will return a non-nil error if the context is done.
	// ctx should be ignored after connection is established.
	DialContext(ctx context.Context, network, address string) (net.Conn, error)
}

A ContextDialer dials using a context.

func CreateDialer

func CreateDialer(u *url.URL, dialer ContextDialer) (ContextDialer, error)

type DialContextFunc

type DialContextFunc func(ctx context.Context, network, address string) (net.Conn, error)

func (DialContextFunc) Dial

func (f DialContextFunc) Dial(network, address string) (net.Conn, error)

func (DialContextFunc) DialContext

func (f DialContextFunc) DialContext(ctx context.Context, network, address string) (net.Conn, error)

type DialFunc

type DialFunc func(network, address string) (net.Conn, error)

func (DialFunc) Dial

func (f DialFunc) Dial(network, address string) (net.Conn, error)

func (DialFunc) DialContext

func (f DialFunc) DialContext(ctx context.Context, network, address string) (net.Conn, error)

type Dialer

type Dialer interface {
	// Dial connects to the given address
	Dial(network, addr string) (c net.Conn, err error)
}

A Dialer is a means to establish a connection. Custom dialers should also implement ContextDialer.

type Forwarder

type Forwarder interface {
	// Forward() a conn and someone may Accept() it from Listener
	// Returns nil if the connection is accepted.
	// ctx should be ignored after connection is accepted.
	Forward(ctx context.Context, c net.Conn) error
}

type ForwarderFunc

type ForwarderFunc func(ctx context.Context, c net.Conn) error

func (ForwarderFunc) Forward

func (f ForwarderFunc) Forward(ctx context.Context, c net.Conn) error

type Listener

type Listener net.Listener

type OverrideAddr

type OverrideAddr struct {
	OverrideNetwork string
	OverrideAddress string
}

func (*OverrideAddr) Network

func (a *OverrideAddr) Network() string

func (*OverrideAddr) String

func (a *OverrideAddr) String() string

type OverrideConn

type OverrideConn struct {
	net.Conn
	OverrideLocalAddr  net.Addr
	OverrideRemoteAddr net.Addr
}

func (*OverrideConn) LocalAddr

func (c *OverrideConn) LocalAddr() net.Addr

func (*OverrideConn) RemoteAddr

func (c *OverrideConn) RemoteAddr() net.Addr

type OverrideListener

type OverrideListener struct {
	net.Listener
	OverrideLocalAddr  bool
	OverrideRemoteAddr bool
}

func (*OverrideListener) Accept

func (l *OverrideListener) Accept() (c net.Conn, e error)

type PipeListener

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

func ListenPipe

func ListenPipe() *PipeListener

ListenPipe creates a pipeListener that implement net.Listener and Dialer.

The returned Listener and Dialer operate on the same in-memory channel. Calling Dial on the Dialer will return a Conn that can be used to communicate with a Conn accepted from the Listener.

func (*PipeListener) Accept

func (l *PipeListener) Accept() (c net.Conn, e error)

Accept waits for and returns the next connection to the listener.

func (*PipeListener) Addr

func (l *PipeListener) Addr() net.Addr

Addr returns the listener's network address.

func (*PipeListener) Close

func (l *PipeListener) Close() (e error)

Close closes the listener. Any blocked Accept operations will be unblocked and return errors.

func (*PipeListener) Dial

func (l *PipeListener) Dial(network, addr string) (net.Conn, error)

func (*PipeListener) DialContext

func (l *PipeListener) DialContext(ctx context.Context, network, addr string) (conn net.Conn, e error)

func (*PipeListener) Forward

func (l *PipeListener) Forward(ctx context.Context, conn net.Conn) (e error)

type PrefixConn

type PrefixConn struct {
	net.Conn
	Prefix io.Reader
}

PrefixConn will first read Prefix until EOF, and then read the content from Conn.

func (*PrefixConn) Read

func (b *PrefixConn) Read(p []byte) (n int, err error)

func (*PrefixConn) ReadFrom

func (b *PrefixConn) ReadFrom(r io.Reader) (n int64, err error)

func (*PrefixConn) WriteTo

func (b *PrefixConn) WriteTo(w io.Writer) (n int64, err error)

type ServeMux

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

ServeMux will forward the connection (Conn) to different Forwarders based on the rules.

func (*ServeMux) Forward

func (r *ServeMux) Forward(ctx context.Context, c net.Conn) error

func (*ServeMux) HandlePrefix

func (r *ServeMux) HandlePrefix(prefix []byte, forwarder Forwarder)

func (*ServeMux) HandleTLSProto

func (r *ServeMux) HandleTLSProto(proto string, forwarder Forwarder)