birpc

Documentation

Index

• type Client
  • func NewClient(conf *ClientConfig) (*Client, error)
  • func (cli *Client) Close() error
  • func (cli *Client) Run(handler ClientHandler) error
• type ClientConfig
• type ClientConn
• type ClientHandler
• type Conn
  • func NewConn(conn net.Conn, rdTimeout time.Duration, wrTimeout time.Duration) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) Err() <-chan error
  • func (c *Conn) Go()
  • func (c *Conn) In() <-chan interface{}
  • func (c *Conn) Out() chan<- interface{}
• type Server
  • func NewServer(conf *ServerConfig) (*Server, error)
  • func (s *Server) Clients() <-chan *ClientConn
  • func (s *Server) Close() error
  • func (s *Server) Serve() error
• type ServerConfig
• type ValidateFunc

Types

type Client

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

func NewClient

func NewClient(conf *ClientConfig) (*Client, error)

func (*Client) Close

func (cli *Client) Close() error

func (*Client) Run

func (cli *Client) Run(handler ClientHandler) error

Run starts communicating with server, do reconnecting and requests dispatching logic.

type ClientConfig

type ClientConfig struct {
	ID                string
	Hash              string
	RemoteAddr        string
	HeartbeatInterval time.Duration
	Timeout           util.TimeoutConfig
	Retrier           *retry.Retrier
	TLSConf           *tls.Config
}

type ClientConn

type ClientConn struct {
	*Conn
	ID      string
	Hash    string
	Version string
	Device  string
}

type ClientHandler

type ClientHandler interface {
	HandlePingResponse(req *msgpb.PingResponse)
	HandleNewTunnelRequest(req *msgpb.NewTunnelRequest) *msgpb.NewTunnelResponse
	HandleCloseTunnelRequest(req *msgpb.CloseTunnelRequest) *msgpb.CloseTunnelResponse
	HandleShutdownRequest(req *msgpb.ShutdownRequest) bool
	HandleUnknownMessage(m interface{})
	HandleError(err error)
}

type Conn

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

func NewConn

func NewConn(conn net.Conn, rdTimeout time.Duration, wrTimeout time.Duration) *Conn

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) Err

func (c *Conn) Err() <-chan error

func (*Conn) Go

func (c *Conn) Go()

func (*Conn) In

func (c *Conn) In() <-chan interface{}

func (*Conn) Out

func (c *Conn) Out() chan<- interface{}

type Server

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

func NewServer

func NewServer(conf *ServerConfig) (*Server, error)

func (*Server) Clients

func (s *Server) Clients() <-chan *ClientConn

func (*Server) Close

func (s *Server) Close() error

func (*Server) Serve

func (s *Server) Serve() error

type ServerConfig

type ServerConfig struct {
	ListenAddr   string
	Timeout      util.TimeoutConfig
	TLSConf      *tls.Config
	ValidateFunc ValidateFunc
}

type ValidateFunc

type ValidateFunc func(id, hash, device, version string) msgpb.ErrCode