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) (*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)
  • func (d *Direct) NextDialer(dstAddr string) Dialer
• type Forwarder
  • func ForwarderFromURL(s, intface string) (f *Forwarder, err error)
  • func (f *Forwarder) AddHandler(h StatusHandler)
  • func (f *Forwarder) Addr() string
  • func (f *Forwarder) Dial(network, addr string) (c net.Conn, err error)
  • func (f *Forwarder) Disable()
  • func (f *Forwarder) Enable()
  • func (f *Forwarder) Enabled() bool
  • func (f *Forwarder) Failures() uint32
  • func (f *Forwarder) IncFailures()
  • func (f *Forwarder) Latency() int64
  • func (f *Forwarder) MaxFailures() uint32
  • func (f *Forwarder) Priority() uint32
  • func (f *Forwarder) SetLatency(l int64)
  • func (f *Forwarder) SetMaxFailures(l uint32)
  • func (f *Forwarder) SetPriority(l uint32)
• type Server
  • func ServerFromURL(s string, dialer Dialer) (Server, error)
• type ServerCreator
• type StatusHandler

Variables

var Default = &Direct{}

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 {
	// Addr()
	Addr() string

	// Dial connects to the given address via the proxy.
	Dial(network, addr string) (c net.Conn, 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
}

Dialer means to establish a connection and relay it.

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) (*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

func (*Direct) NextDialer

func (d *Direct) NextDialer(dstAddr string) Dialer

NextDialer returns the next dialer

type Forwarder

type Forwarder struct {
	Dialer
	// contains filtered or unexported fields
}

Forwarder is a forwarder

func ForwarderFromURL

func ForwarderFromURL(s, intface string) (f *Forwarder, err error)

ForwarderFromURL parses `forward=` command value and returns a new forwarder

func (*Forwarder) AddHandler

func (f *Forwarder) AddHandler(h StatusHandler)

AddHandler adds a custom handler to handle the status change event

func (*Forwarder) Addr

func (f *Forwarder) Addr() string

Addr .

func (*Forwarder) Dial

func (f *Forwarder) Dial(network, addr string) (c net.Conn, err error)

Dial .

func (*Forwarder) Disable

func (f *Forwarder) Disable()

Disable the forwarder

func (*Forwarder) Enable

func (f *Forwarder) Enable()

Enable the forwarder

func (*Forwarder) Enabled

func (f *Forwarder) Enabled() bool

Enabled returns the status of forwarder

func (*Forwarder) Failures

func (f *Forwarder) Failures() uint32

Failures returns the failuer count of forwarder

func (*Forwarder) IncFailures

func (f *Forwarder) IncFailures()

IncFailures increase the failuer count by 1

func (*Forwarder) Latency

func (f *Forwarder) Latency() int64

Latency returns the latency of forwarder

func (*Forwarder) MaxFailures

func (f *Forwarder) MaxFailures() uint32

MaxFailures returns the maxFailures of forwarder

func (*Forwarder) Priority

func (f *Forwarder) Priority() uint32

Priority returns the priority of forwarder

func (*Forwarder) SetLatency

func (f *Forwarder) SetLatency(l int64)

SetLatency sets the latency of forwarder

func (*Forwarder) SetMaxFailures

func (f *Forwarder) SetMaxFailures(l uint32)

SetMaxFailures sets the maxFailures of forwarder

func (*Forwarder) SetPriority

func (f *Forwarder) SetPriority(l uint32)

SetPriority sets the priority of forwarder

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, dialer Dialer) (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, dialer Dialer) (Server, error)

ServerCreator is a function to create proxy servers

type StatusHandler

type StatusHandler func(*Forwarder)

StatusHandler function will be called when the forwarder's status changed