proxy

Documentation

Index

• Constants
• type Proxy
  • func NewProxy(view ui.ViewInterface, hostfile hostfile.HostfileInterface) *Proxy
  • func (p *Proxy) AddProxyForward(name string, proxyForward *ProxyForward)
  • func (p *Proxy) Listen() error
  • func (p *Proxy) Stop() error
• type ProxyForward
  • func NewProxyForward(name, hostname, proxyHostname, localPort, forwardPort string) *ProxyForward
  • func (p *ProxyForward) GetHostname() string
  • func (p *ProxyForward) GetProxifiedPorts() string
  • func (p *ProxyForward) GetProxyHostname() string
  • func (p *ProxyForward) SetLocalIP(ip string)
  • func (p *ProxyForward) SetProxyPort(port string)
• type ProxyInterface

Constants

const (
	// ProxyPortStart is the first port that will be allocated by the proxy component.
	// Others will be incremented by 1 each time
	ProxyPortStart = "9400"
)

Types

type Proxy

type Proxy struct {
	ProxyForwards map[string][]*ProxyForward
	// contains filtered or unexported fields
}

Proxy represents the proxy component instance

func NewProxy

func NewProxy(view ui.ViewInterface, hostfile hostfile.HostfileInterface) *Proxy

NewProxy initializes a new proxy component instance

func (*Proxy) AddProxyForward

func (p *Proxy) AddProxyForward(name string, proxyForward *ProxyForward)

AddProxyForward creates a new ProxyForward instance and attributes an IP address and a proxy port to it

func (*Proxy) Listen

func (p *Proxy) Listen() error

Listen opens a TCP proxy for each ProxyForward instance

func (*Proxy) Stop

func (p *Proxy) Stop() error

Stop stops all currently active proxy listeners

type ProxyForward

type ProxyForward struct {
	Name          string
	Hostname      string
	ProxyHostname string
	LocalPort     string
	ForwardPort   string
	LocalIP       string
	ProxyPort     string
}

func NewProxyForward

func NewProxyForward(name, hostname, proxyHostname, localPort, forwardPort string) *ProxyForward

NewProxyForward returns a new proxy port-forward instance

func (*ProxyForward) GetHostname

func (p *ProxyForward) GetHostname() string

GetHostname returns the hostname (if defined) of this proxy forward, elsewhere uses the service name

func (*ProxyForward) GetProxifiedPorts

func (p *ProxyForward) GetProxifiedPorts() string

GetProxifiedPorts returns the couple of proxified ports (proxy attributed port:forward port)

func (*ProxyForward) GetProxyHostname

func (p *ProxyForward) GetProxyHostname() string

GetProxyHostname returns the proxy sender hostname depending on forward type In case of a forward type 'proxy', it will return the specified proxy hostname, elsewhere it will return 127.0.0.1 because other forwards forward traffic locally

func (*ProxyForward) SetLocalIP

func (p *ProxyForward) SetLocalIP(ip string)

SetLocalIP sets local attributed IP to this forward

func (*ProxyForward) SetProxyPort

func (p *ProxyForward) SetProxyPort(port string)

SetProxyPort sets proxy attributed port to this forward

type ProxyInterface

type ProxyInterface interface {
	Listen() error
	Stop() error
	AddProxyForward(name string, proxyForward *ProxyForward)
}