client

Documentation

Index

• type BaseVisitor
• type ConnectionManager
  • func NewConnectionManager(ctx context.Context, cfg *config.ClientCommonConf) *ConnectionManager
  • func (cm *ConnectionManager) Close() error
  • func (cm *ConnectionManager) Connect() (net.Conn, error)
  • func (cm *ConnectionManager) OpenConnection() error
• type Control
  • func NewControl(ctx context.Context, runID string, conn net.Conn, cm *ConnectionManager, ...) *Control
  • func (ctl *Control) Close() error
  • func (ctl *Control) ClosedDoneCh() <-chan struct{}
  • func (ctl *Control) GracefulClose(d time.Duration) error
  • 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.WorkingStatus, serverAddr string) ProxyStatusResp
• type STCPVisitor
  • func (sv *STCPVisitor) Close()
  • func (sv *STCPVisitor) Run() (err error)
• type SUDPVisitor
  • func (sv *SUDPVisitor) Close()
  • func (sv *SUDPVisitor) Run() (err error)
• 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) GracefulClose(d time.Duration)
  • func (svr *Service) ReloadConf(pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf) error
  • func (svr *Service) Run() error
  • func (svr *Service) RunAdminServer(address string) (err error)
• type StatusResp
• type Visitor
  • func NewVisitor(ctx context.Context, ctl *Control, cfg config.VisitorConf) (visitor Visitor)
• type VisitorManager
  • func NewVisitorManager(ctx context.Context, 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 {
	// contains filtered or unexported fields
}

type ConnectionManager

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

func NewConnectionManager

func NewConnectionManager(ctx context.Context, cfg *config.ClientCommonConf) *ConnectionManager

func (*ConnectionManager) Close

func (cm *ConnectionManager) Close() error

func (*ConnectionManager) Connect

func (cm *ConnectionManager) Connect() (net.Conn, error)

func (*ConnectionManager) OpenConnection

func (cm *ConnectionManager) OpenConnection() error

type Control

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

func NewControl

func NewControl(
	ctx context.Context, runID string, conn net.Conn, cm *ConnectionManager,
	clientCfg config.ClientCommonConf,
	pxyCfgs map[string]config.ProxyConf,
	visitorCfgs map[string]config.VisitorConf,
	serverUDPPort int,
	authSetter auth.Setter,
) *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) GracefulClose

func (ctl *Control) GracefulClose(d time.Duration) error

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.WorkingStatus, serverAddr string) ProxyStatusResp

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 SUDPVisitor

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

func (*SUDPVisitor) Close

func (sv *SUDPVisitor) Close()

func (*SUDPVisitor) Run

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

SUDP Run start listen a udp port

type Service

type Service struct {
	// 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)

func (*Service) Close

func (svr *Service) Close()

func (*Service) GetController

func (svr *Service) GetController() *Control

func (*Service) GracefulClose

func (svr *Service) GracefulClose(d time.Duration)

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

func (*Service) RunAdminServer

func (svr *Service) RunAdminServer(address string) (err error)

type StatusResp

type StatusResp map[string][]ProxyStatusResp

type Visitor

type Visitor interface {
	Run() error
	Close()
}

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

func NewVisitor

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

type VisitorManager

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

func NewVisitorManager

func NewVisitorManager(ctx context.Context, 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)