proxy

Documentation

Index

• Variables
• func RegisterDialer(name string, c DialerCreator)
• func RegisterServer(name string, c ServerCreator)
• type Dialer
  • func DialerFromURL(s string, dialer 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, net.Addr, error)
  • func (d *Direct) IFaceIPs() (ips []net.IP)
• type Proxy
• type Server
  • func ServerFromURL(s string, p Proxy) (Server, error)
• type ServerCreator
• type TCPDialer
• type UDPDialer

Variables

var Default = &Direct{dialTimeout: time.Second * 3}

Default dialer

Functions

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

Types

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.

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, net.Addr, 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 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, writeTo net.Addr, 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, p Proxy) (Server, error)

ServerFromURL calls the registered creator to create proxy servers dialer is the default upstream dialer so cannot be nil, we can use Default when calling this function

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, writeTo net.Addr, err error)
}

UDPDialer is used to create udp PacketConn.