websocket

Documentation

Index

• type Client
  • func Dial(rawUrl string, opt api.ClientOption) (*Client, error)
  • func (c *Client) BatchCallJsonRpc(b []api.BatchElem) error
  • func (c *Client) CallJsonRpc(result interface{}, method string, args interface{}) error
  • func (c *Client) Close() error
  • func (c *Client) ErrFromWS() chan error
  • func (c *Client) GetType() api.ClientType
  • func (c *Client) WriteByWs(msg api.WSMessage) error
• type Context
  • func (ctx *Context) ClientIP() string
• type Server
  • func NewServer(ctx *gin.Context, opts ...WsOption) (*Server, error)
  • func (s *Server) Close()
  • func (s *Server) Run()
• type WsOption
  • func WithRawHandle(handle api.RawWsHandle) WsOption
  • func WithRpcServer(s *jsonrpc.Server) WsOption

Types

type Client

type Client struct {
	api.ClientAdapter
	// contains filtered or unexported fields
}

func Dial

func Dial(rawUrl string, opt api.ClientOption) (*Client, error)

func (*Client) BatchCallJsonRpc

func (c *Client) BatchCallJsonRpc(b []api.BatchElem) error

func (*Client) CallJsonRpc

func (c *Client) CallJsonRpc(result interface{}, method string, args interface{}) error

func (*Client) Close

func (c *Client) Close() error

func (*Client) ErrFromWS

func (c *Client) ErrFromWS() chan error

func (*Client) GetType

func (c *Client) GetType() api.ClientType

func (*Client) WriteByWs

func (c *Client) WriteByWs(msg api.WSMessage) error

type Context

type Context struct {
	ctx.ContextAdapter
	// contains filtered or unexported fields
}

func (*Context) ClientIP

func (ctx *Context) ClientIP() string

type Server

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

func NewServer

func NewServer(ctx *gin.Context, opts ...WsOption) (*Server, error)

func (*Server) Close

func (s *Server) Close()

func (*Server) Run

func (s *Server) Run()

type WsOption

type WsOption func(opt *wsOption)

func WithRawHandle

func WithRawHandle(handle api.RawWsHandle) WsOption

func WithRpcServer

func WithRpcServer(s *jsonrpc.Server) WsOption