proxy

Documentation

Index

• Variables
• func AddUsage(name, usage string)
• func Copy(dst io.Writer, src io.Reader) (written int64, err error)
• func CopyBuffer(dst io.Writer, src io.Reader) (written int64, err error)
• func CopyN(dst io.Writer, src io.Reader, n int64) (written int64, err error)
• func CopyUDP(dst net.PacketConn, writeTo net.Addr, src net.PacketConn, ...) error
• func DialerSchemes() string
• func RegisterDialer(name string, c DialerCreator)
• func RegisterServer(name string, c ServerCreator)
• func Relay(left, right net.Conn) error
• func ServerSchemes() string
• func Usage(name string) string
• type Conn
  • func NewConn(c net.Conn) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) Peek(n int) ([]byte, error)
  • func (c *Conn) Read(p []byte) (int, error)
  • func (c *Conn) Reader() *bufio.Reader
  • func (c *Conn) WriteTo(w io.Writer) (n int64, err error)
• type Dialer
  • func DialerFromURL(s string, dialer Dialer) (Dialer, error)
  • func NewDirectDialer(s string, d Dialer) (Dialer, error)
• type DialerCreator
• type Direct
  • func NewDirect(intface string, dialTimeout, relayTimeout time.Duration) (*Direct, error)
  • func (d *Direct) Addr() string
  • func (d *Direct) Dial(network, addr string) (c net.Conn, err error)
  • func (d *Direct) DialUDP(network, addr string) (net.PacketConn, error)
  • func (d *Direct) IFaceIPs() (ips []net.IP)
• type PacketServer
• type Proxy
• type Server
  • func ServerFromURL(s string, proxy Proxy) (Server, error)
• type ServerCreator
• type TCPDialer
• type UDPDialer

Variables

var (
	// TCPBufSize is the size of tcp buffer.
	TCPBufSize = 32 << 10

	// UDPBufSize is the size of udp buffer.
	UDPBufSize = 2 << 10
)

var (
	// ErrNotSupported indicates that the operation is not supported
	ErrNotSupported = errors.New("not supported")
)

Functions

func AddUsage

func AddUsage(name, usage string)

AddUsage adds help message for the named proxy.

func Copy

func Copy(dst io.Writer, src io.Reader) (written int64, err error)

Copy copies from src to dst.

func CopyBuffer

func CopyBuffer(dst io.Writer, src io.Reader) (written int64, err error)

CopyBuffer copies from src to dst with a userspace buffer.

func CopyN

func CopyN(dst io.Writer, src io.Reader, n int64) (written int64, err error)

CopyN copies n bytes (or until an error) from src to dst.

func CopyUDP

func CopyUDP(dst net.PacketConn, writeTo net.Addr, src net.PacketConn, timeout time.Duration, step time.Duration) error

CopyUDP copys from src to dst at target with read timeout. if step sets to non-zero value, the read timeout will be increased from 0 to timeout by step in every read operation.

func DialerSchemes

func DialerSchemes() string

DialerSchemes returns the registered dialer schemes.

func RegisterDialer

func RegisterDialer(name string, c DialerCreator)

RegisterDialer is used to register a dialer.

func RegisterServer

func RegisterServer(name string, c ServerCreator)

RegisterServer is used to register a proxy server.

func Relay

func Relay(left, right net.Conn) error

Relay relays between left and right.

func ServerSchemes

func ServerSchemes() string

ServerSchemes returns the registered server schemes.

func Usage

func Usage(name string) string

Usage returns help message of the named proxy.

Types

type Conn

type Conn struct {
	net.Conn
	// contains filtered or unexported fields
}

Conn is a connection with buffered reader.

func NewConn

func NewConn(c net.Conn) *Conn

NewConn returns a new conn.

func (*Conn) Close

func (c *Conn) Close() error

Close closes the Conn.

func (*Conn) Peek

func (c *Conn) Peek(n int) ([]byte, error)

Peek returns the next n bytes without advancing the reader.

func (*Conn) Read

func (c *Conn) Read(p []byte) (int, error)

func (*Conn) Reader

func (c *Conn) Reader() *bufio.Reader

Reader returns the internal bufio.Reader.

func (*Conn) WriteTo

func (c *Conn) WriteTo(w io.Writer) (n int64, err error)

WriteTo implements io.WriterTo.

type Dialer

type Dialer interface {
	TCPDialer
	UDPDialer
}

Dialer is used to create connection.

func DialerFromURL

func DialerFromURL(s string, dialer Dialer) (Dialer, error)

DialerFromURL calls the registered creator to create dialers. dialer is the default upstream dialer so cannot be nil, we can use Default when calling this function.

func NewDirectDialer

func NewDirectDialer(s string, d Dialer) (Dialer, error)

NewDirectDialer returns a direct dialer.

type DialerCreator

type DialerCreator func(s string, dialer Dialer) (Dialer, error)

DialerCreator is a function to create dialers.

type Direct

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

Direct proxy.

func NewDirect

func NewDirect(intface string, dialTimeout, relayTimeout time.Duration) (*Direct, error)

NewDirect returns a Direct dialer.

func (*Direct) Addr

func (d *Direct) Addr() string

Addr returns forwarder's address.

func (*Direct) Dial

func (d *Direct) Dial(network, addr string) (c net.Conn, err error)

Dial connects to the address addr on the network net

func (*Direct) DialUDP

func (d *Direct) DialUDP(network, addr string) (net.PacketConn, error)

DialUDP connects to the given address.

func (*Direct) IFaceIPs

func (d *Direct) IFaceIPs() (ips []net.IP)

IFaceIPs returns ip addresses according to the specified interface.

type PacketServer

type PacketServer interface {
	ServePacket(pc net.PacketConn)
}

PacketServer interface.

type Proxy

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

	// DialUDP connects to the given address via the proxy.
	DialUDP(network, addr string) (pc net.PacketConn, dialer UDPDialer, err error)

	// Get the dialer by dstAddr.
	NextDialer(dstAddr string) Dialer

	// Record records result while using the dialer from proxy.
	Record(dialer Dialer, success bool)
}

Proxy is a dialer manager.

type Server

type Server interface {
	// ListenAndServe sets up a listener and serve on it
	ListenAndServe()

	// Serve serves a connection
	Serve(c net.Conn)
}

Server interface.

func ServerFromURL

func ServerFromURL(s string, proxy Proxy) (Server, error)

ServerFromURL calls the registered creator to create proxy servers. proxy can not be nil.

type ServerCreator

type ServerCreator func(s string, proxy Proxy) (Server, error)

ServerCreator is a function to create proxy servers.

type TCPDialer

type TCPDialer interface {
	// Addr is the dialer's addr
	Addr() string

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

TCPDialer is used to create tcp connection.

type UDPDialer

type UDPDialer interface {
	// Addr is the dialer's addr
	Addr() string

	// DialUDP connects to the given address
	DialUDP(network, addr string) (pc net.PacketConn, err error)
}

UDPDialer is used to create udp PacketConn.