client

Documentation

Index

• type BaseVisitor
• type ByProxyStatusResp
  • func (a ByProxyStatusResp) Len() int
  • func (a ByProxyStatusResp) Less(i, j int) bool
  • func (a ByProxyStatusResp) Swap(i, j int)
• type Control
  • func NewControl(runId string, conn frpNet.Conn, session *fmux.Session, ...) *Control
  • func (ctl *Control) Close() error
  • func (ctl *Control) ClosedDoneCh() <-chan struct{}
  • func (ctl *Control) HandleNewProxyResp(inMsg *msg.NewProxyResp)
  • func (ctl *Control) HandleReqWorkConn(inMsg *msg.ReqWorkConn)
  • func (ctl *Control) ReloadConf(pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf) error
  • func (ctl *Control) Run()
• type GeneralResponse
• type ProxyStatusResp
  • func NewProxyStatusResp(status *proxy.ProxyStatus, serverAddr string) ProxyStatusResp
• type Service
  • func NewService(cfg config.ClientCommonConf, pxyCfgs map[string]config.ProxyConf, ...) (svr *Service, err error)
  • func (svr *Service) Close()
  • func (svr *Service) GetController() *Control
  • func (svr *Service) IsClosed() bool
  • func (svr *Service) ReloadConf(pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf) error
  • func (svr *Service) Run(isCmd bool) error
  • func (svr *Service) RunAdminServer(addr string, port int) (err error)
  • func (svr *Service) SetOnCloseListener(listener ServiceClosedListener)
  • func (svr *Service) SetProxyFailedFunc(proxyFailedFunc func(err error))
• type ServiceClosedListener
• type StatusResp
• type StcpVisitor
  • func (sv *StcpVisitor) Close()
  • func (sv *StcpVisitor) Run() (err error)
• type Visitor
  • func NewVisitor(ctl *Control, cfg config.VisitorConf) (visitor Visitor)
• type VisitorManager
  • func NewVisitorManager(ctl *Control) *VisitorManager
  • func (vm *VisitorManager) Close()
  • func (vm *VisitorManager) Reload(cfgs map[string]config.VisitorConf)
  • func (vm *VisitorManager) Run()
• type XtcpVisitor
  • func (sv *XtcpVisitor) Close()
  • func (sv *XtcpVisitor) Run() (err error)

Types

type BaseVisitor

type BaseVisitor struct {
	log.Logger
	// contains filtered or unexported fields
}

type ByProxyStatusResp

type ByProxyStatusResp []ProxyStatusResp

func (ByProxyStatusResp) Len

func (a ByProxyStatusResp) Len() int

func (ByProxyStatusResp) Less

func (a ByProxyStatusResp) Less(i, j int) bool

func (ByProxyStatusResp) Swap

func (a ByProxyStatusResp) Swap(i, j int)

type Control

type Control struct {
	log.Logger
	ProxyFunc func(err error)
	// contains filtered or unexported fields
}

func NewControl

func NewControl(runId string, conn frpNet.Conn, session *fmux.Session, clientCfg config.ClientCommonConf,
	pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf, serverUDPPort int) *Control

func (*Control) Close

func (ctl *Control) Close() error

func (*Control) ClosedDoneCh

func (ctl *Control) ClosedDoneCh() <-chan struct{}

ClosedDoneCh returns a channel which will be closed after all resources are released

func (*Control) HandleNewProxyResp

func (ctl *Control) HandleNewProxyResp(inMsg *msg.NewProxyResp)

func (*Control) HandleReqWorkConn

func (ctl *Control) HandleReqWorkConn(inMsg *msg.ReqWorkConn)

func (*Control) ReloadConf

func (ctl *Control) ReloadConf(pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf) error

func (*Control) Run

func (ctl *Control) Run()

type GeneralResponse

type GeneralResponse struct {
	Code int
	Msg  string
}

type ProxyStatusResp

type ProxyStatusResp struct {
	Name       string `json:"name"`
	Type       string `json:"type"`
	Status     string `json:"status"`
	Err        string `json:"err"`
	LocalAddr  string `json:"local_addr"`
	Plugin     string `json:"plugin"`
	RemoteAddr string `json:"remote_addr"`
}

func NewProxyStatusResp

func NewProxyStatusResp(status *proxy.ProxyStatus, serverAddr string) ProxyStatusResp

type Service

type Service struct {
	ReConnectByCount bool
	// contains filtered or unexported fields
}

Service is a client service.

func NewService

func NewService(cfg config.ClientCommonConf, pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf, cfgFile string) (svr *Service, err error)

NewService creates a new client service with the given configuration.

func (*Service) Close

func (svr *Service) Close()

func (*Service) GetController

func (svr *Service) GetController() *Control

func (*Service) IsClosed

func (svr *Service) IsClosed() bool

func (*Service) ReloadConf

func (svr *Service) ReloadConf(pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf) error

func (*Service) Run

func (svr *Service) Run(isCmd bool) error

func (*Service) RunAdminServer

func (svr *Service) RunAdminServer(addr string, port int) (err error)

func (*Service) SetOnCloseListener

func (svr *Service) SetOnCloseListener(listener ServiceClosedListener)

func (*Service) SetProxyFailedFunc

func (svr *Service) SetProxyFailedFunc(proxyFailedFunc func(err error))

type ServiceClosedListener

type ServiceClosedListener interface {
	OnClosed(msg string)
}

type StatusResp

type StatusResp struct {
	Tcp   []ProxyStatusResp `json:"tcp"`
	Udp   []ProxyStatusResp `json:"udp"`
	Http  []ProxyStatusResp `json:"http"`
	Https []ProxyStatusResp `json:"https"`
	Stcp  []ProxyStatusResp `json:"stcp"`
	Xtcp  []ProxyStatusResp `json:"xtcp"`
}

type StcpVisitor

type StcpVisitor struct {
	*BaseVisitor
	// contains filtered or unexported fields
}

func (*StcpVisitor) Close

func (sv *StcpVisitor) Close()

func (*StcpVisitor) Run

func (sv *StcpVisitor) Run() (err error)

type Visitor

type Visitor interface {
	Run() error
	Close()
	log.Logger
}

Visitor is used for forward traffics from local port tot remote service.

func NewVisitor

func NewVisitor(ctl *Control, cfg config.VisitorConf) (visitor Visitor)

type VisitorManager

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

func NewVisitorManager

func NewVisitorManager(ctl *Control) *VisitorManager

func (*VisitorManager) Close

func (vm *VisitorManager) Close()

func (*VisitorManager) Reload

func (vm *VisitorManager) Reload(cfgs map[string]config.VisitorConf)

func (*VisitorManager) Run

func (vm *VisitorManager) Run()

type XtcpVisitor

type XtcpVisitor struct {
	*BaseVisitor
	// contains filtered or unexported fields
}

func (*XtcpVisitor) Close

func (sv *XtcpVisitor) Close()

func (*XtcpVisitor) Run

func (sv *XtcpVisitor) Run() (err error)