rpc

Documentation

Index

• func MessageFromJson(data []byte, m *Message) error
• func NextId() uint64
• type Connection
  • func Dial(ctx context.Context, url string) (*Connection, error)
  • func NewConnection(ctx context.Context, socket *websocket.Conn) *Connection
  • func (c *Connection) Close()
  • func (c *Connection) Done() <-chan struct{}
  • func (c *Connection) Id() string
  • func (c *Connection) Read() []byte
  • func (c *Connection) ReadJSON(v interface{}) error
  • func (c *Connection) Write(data []byte)
  • func (c *Connection) WriteJSON(v interface{}) error
• type Hub
  • func NewHub(ctx context.Context) *Hub
  • func (h *Hub) Broadcast(data []byte)
  • func (h *Hub) BroadcastJSON(v interface{}) error
  • func (h *Hub) Requests() <-chan *Request
  • func (h *Hub) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Message
  • func MakeCall(method string, id uint64, params map[string]any) Message
  • func MakeError(code int, msg string) Message
  • func MakeNotify(method string, params map[string]any) Message
  • func MakeResult(id uint64, result any) Message
• type MessageHandler
• type Request
  • func (r Request) AsData() []byte
  • func (r Request) AsJSON(v interface{}) error
  • func (r Request) Broadcast(data []byte)
  • func (r Request) BroadcastJSON(v interface{}) error
  • func (r Request) Error() error
  • func (r Request) Reply(data []byte)
  • func (r Request) ReplyJSON(data interface{}) error
• type RequestHandler
• type RpcError

Functions

func MessageFromJson

func MessageFromJson(data []byte, m *Message) error

func NextId

func NextId() uint64

Types

type Connection

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

Connection represents a cancelable websocket connection.

func Dial

func Dial(ctx context.Context, url string) (*Connection, error)

Dial creates a new client connection. It tries repeatedly to connect to the server until successful or context is done.

func NewConnection

func NewConnection(ctx context.Context, socket *websocket.Conn) *Connection

NewConnection handles a new websocket

func (*Connection) Close

func (c *Connection) Close()

Close closes the connection and the underlying socket.

func (*Connection) Done

func (c *Connection) Done() <-chan struct{}

Done returns a channel that is closed when the connection is closed.

func (*Connection) Id

func (c *Connection) Id() string

Id returns the connection id.

func (*Connection) Read

func (c *Connection) Read() []byte

func (*Connection) ReadJSON

func (c *Connection) ReadJSON(v interface{}) error

func (*Connection) Write

func (c *Connection) Write(data []byte)

func (*Connection) WriteJSON

func (c *Connection) WriteJSON(v interface{}) error

type Hub

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

func NewHub

func NewHub(ctx context.Context) *Hub

func (*Hub) Broadcast

func (h *Hub) Broadcast(data []byte)

Broadcast sends data to all connections

func (*Hub) BroadcastJSON

func (h *Hub) BroadcastJSON(v interface{}) error

BroadcastJSON encodes v as JSON and broadcasts it to all connections.

func (*Hub) Requests

func (h *Hub) Requests() <-chan *Request

func (*Hub) ServeHTTP

func (h *Hub) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Message

type Message struct {
	Version string         `json:"version"`
	Method  string         `json:"method"`
	Id      uint64         `json:"id"`
	Params  map[string]any `json:"params"`
	Result  any            `json:"result"`
	Error   RpcError       `json:"error,omitempty"`
}

func MakeCall

func MakeCall(method string, id uint64, params map[string]any) Message

func MakeError

func MakeError(code int, msg string) Message

func MakeNotify

func MakeNotify(method string, params map[string]any) Message

func MakeResult

func MakeResult(id uint64, result any) Message

type MessageHandler

type MessageHandler interface {
	HandleMessage(m Message) error
}

type Request

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

Request represents a request from a client.

func (Request) AsData

func (r Request) AsData() []byte

AsData returns the request data as a string.

func (Request) AsJSON

func (r Request) AsJSON(v interface{}) error

AsJSON decodes the request data as JSON.

func (Request) Broadcast

func (r Request) Broadcast(data []byte)

Broadcast sends data to all connections

func (Request) BroadcastJSON

func (r Request) BroadcastJSON(v interface{}) error

BroadcastJSON encodes v as JSON and broadcasts it to all connections.

func (Request) Error

func (r Request) Error() error

Error returns the error that occurred while processing the request.

func (Request) Reply

func (r Request) Reply(data []byte)

Reply writes a response to the client.

func (Request) ReplyJSON

func (r Request) ReplyJSON(data interface{}) error

ReplyJSON writes a JSON response to the client.

type RequestHandler

type RequestHandler interface {
	HandleRequest(m Request) error
}

type RpcError

type RpcError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}