server

Documentation

Index

• type BaseOutConf
• type Control
  • func NewControl(ctx context.Context, rc *controller.ResourceController, ...) (*Control, error)
  • func (ctl *Control) Close() error
  • func (ctl *Control) CloseProxy(closeMsg *msg.CloseProxy) (err error)
  • func (ctl *Control) GetWorkConn() (workConn net.Conn, err error)
  • func (ctl *Control) RegisterProxy(pxyMsg *msg.NewProxy) (remoteAddr string, err error)
  • func (ctl *Control) RegisterWorkConn(conn net.Conn) error
  • func (ctl *Control) Replaced(newCtl *Control)
  • func (ctl *Control) Start()
  • func (ctl *Control) WaitClosed()
• type ControlManager
  • func NewControlManager() *ControlManager
  • func (cm *ControlManager) Add(runID string, ctl *Control) (old *Control)
  • func (cm *ControlManager) Close() error
  • func (cm *ControlManager) Del(runID string, ctl *Control)
  • func (cm *ControlManager) GetByID(runID string) (ctl *Control, ok bool)
• type GeneralResponse
• type GetProxyInfoResp
• type GetProxyStatsResp
• type GetProxyTrafficResp
• type HTTPOutConf
• type HTTPSOutConf
• type ProxyStatsInfo
• type STCPOutConf
• type Service
  • func NewService(cfg *v1.ServerConfig) (*Service, error)
  • func (svr *Service) Close() error
  • func (svr *Service) HandleListener(l net.Listener, internal bool)
  • func (svr *Service) HandleQUICListener(l *quic.Listener)
  • func (svr *Service) RegisterControl(ctlConn net.Conn, loginMsg *msg.Login, internal bool) error
  • func (svr *Service) RegisterVisitorConn(visitorConn net.Conn, newMsg *msg.NewVisitorConn) error
  • func (svr *Service) RegisterWorkConn(workConn net.Conn, newMsg *msg.NewWorkConn) error
  • func (svr *Service) Run(ctx context.Context)
• type TCPMuxOutConf
• type TCPOutConf
• type UDPOutConf
• type XTCPOutConf

Types

type BaseOutConf

type BaseOutConf struct {
	v1.ProxyBaseConfig
}

type Control

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

func NewControl

func NewControl(
	ctx context.Context,
	rc *controller.ResourceController,
	pxyManager *proxy.Manager,
	pluginManager *plugin.Manager,
	authVerifier auth.Verifier,
	ctlConn net.Conn,
	ctlConnEncrypted bool,
	loginMsg *msg.Login,
	serverCfg *v1.ServerConfig,
) (*Control, error)

TODO(fatedier): Referencing the implementation of frpc, encapsulate the input parameters as SessionContext.

func (*Control) Close

func (ctl *Control) Close() error

func (*Control) CloseProxy

func (ctl *Control) CloseProxy(closeMsg *msg.CloseProxy) (err error)

func (*Control) GetWorkConn

func (ctl *Control) GetWorkConn() (workConn net.Conn, err error)

When frps get one user connection, we get one work connection from the pool and return it. If no workConn available in the pool, send message to frpc to get one or more and wait until it is available. return an error if wait timeout

func (*Control) RegisterProxy

func (ctl *Control) RegisterProxy(pxyMsg *msg.NewProxy) (remoteAddr string, err error)

func (*Control) RegisterWorkConn

func (ctl *Control) RegisterWorkConn(conn net.Conn) error

func (*Control) Replaced

func (ctl *Control) Replaced(newCtl *Control)

func (*Control) Start

func (ctl *Control) Start()

Start send a login success message to client and start working.

func (*Control) WaitClosed

func (ctl *Control) WaitClosed()

block until Control closed

type ControlManager

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

func NewControlManager

func NewControlManager() *ControlManager

func (*ControlManager) Add

func (cm *ControlManager) Add(runID string, ctl *Control) (old *Control)

func (*ControlManager) Close

func (cm *ControlManager) Close() error

func (*ControlManager) Del

func (cm *ControlManager) Del(runID string, ctl *Control)

we should make sure if it's the same control to prevent delete a new one

func (*ControlManager) GetByID

func (cm *ControlManager) GetByID(runID string) (ctl *Control, ok bool)

type GeneralResponse

type GeneralResponse struct {
	Code int
	Msg  string
}

type GetProxyInfoResp

type GetProxyInfoResp struct {
	Proxies []*ProxyStatsInfo `json:"proxies"`
}

type GetProxyStatsResp

type GetProxyStatsResp struct {
	Name            string      `json:"name"`
	Conf            interface{} `json:"conf"`
	TodayTrafficIn  int64       `json:"todayTrafficIn"`
	TodayTrafficOut int64       `json:"todayTrafficOut"`
	CurConns        int64       `json:"curConns"`
	LastStartTime   string      `json:"lastStartTime"`
	LastCloseTime   string      `json:"lastCloseTime"`
	Status          string      `json:"status"`
}

Get proxy info by name.

type GetProxyTrafficResp

type GetProxyTrafficResp struct {
	Name       string  `json:"name"`
	TrafficIn  []int64 `json:"trafficIn"`
	TrafficOut []int64 `json:"trafficOut"`
}

/api/traffic/:name

type HTTPOutConf

type HTTPOutConf struct {
	BaseOutConf
	v1.DomainConfig
	Locations         []string `json:"locations"`
	HostHeaderRewrite string   `json:"hostHeaderRewrite"`
}

type HTTPSOutConf

type HTTPSOutConf struct {
	BaseOutConf
	v1.DomainConfig
}

type ProxyStatsInfo

type ProxyStatsInfo struct {
	Name            string      `json:"name"`
	Conf            interface{} `json:"conf"`
	ClientVersion   string      `json:"clientVersion,omitempty"`
	TodayTrafficIn  int64       `json:"todayTrafficIn"`
	TodayTrafficOut int64       `json:"todayTrafficOut"`
	CurConns        int64       `json:"curConns"`
	LastStartTime   string      `json:"lastStartTime"`
	LastCloseTime   string      `json:"lastCloseTime"`
	Status          string      `json:"status"`
}

Get proxy info.

type STCPOutConf

type STCPOutConf struct {
	BaseOutConf
}

type Service

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

Server service

func NewService

func NewService(cfg *v1.ServerConfig) (*Service, error)

func (*Service) Close

func (svr *Service) Close() error

func (*Service) HandleListener

func (svr *Service) HandleListener(l net.Listener, internal bool)

HandleListener accepts connections from client and call handleConnection to handle them. If internal is true, it means that this listener is used for internal communication like ssh tunnel gateway. TODO(fatedier): Pass some parameters of listener/connection through context to avoid passing too many parameters.

func (*Service) HandleQUICListener

func (svr *Service) HandleQUICListener(l *quic.Listener)

func (*Service) RegisterControl

func (svr *Service) RegisterControl(ctlConn net.Conn, loginMsg *msg.Login, internal bool) error

func (*Service) RegisterVisitorConn

func (svr *Service) RegisterVisitorConn(visitorConn net.Conn, newMsg *msg.NewVisitorConn) error

func (*Service) RegisterWorkConn

func (svr *Service) RegisterWorkConn(workConn net.Conn, newMsg *msg.NewWorkConn) error

RegisterWorkConn register a new work connection to control and proxies need it.

func (*Service) Run

func (svr *Service) Run(ctx context.Context)

type TCPMuxOutConf

type TCPMuxOutConf struct {
	BaseOutConf
	v1.DomainConfig
	Multiplexer     string `json:"multiplexer"`
	RouteByHTTPUser string `json:"routeByHTTPUser"`
}

type TCPOutConf

type TCPOutConf struct {
	BaseOutConf
	RemotePort int `json:"remotePort"`
}

type UDPOutConf

type UDPOutConf struct {
	BaseOutConf
	RemotePort int `json:"remotePort"`
}

type XTCPOutConf

type XTCPOutConf struct {
	BaseOutConf
}