openws

README

OpenWS-go

Golang implementation of the OpenWS protocol.

Documentation

Index

• Constants
• func BroadcastEvent(ctx context.Context, eventName string, data any, conns ...*websocket.Conn) (<-chan SendResult, error)
• func EmitEvent(ctx context.Context, eventName string, data any, conn *websocket.Conn) error
• func Register[Params any, Result any](s *Server, method string, fn func(context.Context, *Params) (Result, error))
• type Error
  • func (e *Error) Error() string
• type Event
• type Request
• type Response
• type SendResult
• type Server
  • func NewServer() *Server
  • func (s Server) ServeConn(ctx context.Context, conn *websocket.Conn) error

Constants

const (
	CodeParseError         = -32700
	CodeInvalidRequest     = -32600
	CodeMethodNotFound     = -32601
	CodeInvalidParams      = -32602
	CodeInternalError      = -32603
	CodeUnimplementedError = -32604
)

const JSONRPCVer = "2.0"

Functions

func BroadcastEvent

func BroadcastEvent(
	ctx context.Context,
	eventName string,
	data any,
	conns ...*websocket.Conn,
) (<-chan SendResult, error)

func EmitEvent

func EmitEvent(
	ctx context.Context,
	eventName string,
	data any,
	conn *websocket.Conn,
) error

func Register

func Register[Params any, Result any](s *Server, method string, fn func(context.Context, *Params) (Result, error))

Types

type Error

type Error struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
	Details any    `json:"details,omitempty"`
}

func (*Error) Error

func (e *Error) Error() string

type Event

type Event struct {
	Event string `json:"event"`
	Data  any    `json:"data,omitempty"`
}

type Request

type Request struct {
	JSONRPC string          `json:"jsonrpc"`
	ID      json.RawMessage `json:"id,omitempty"`
	Method  string          `json:"method"`
	Params  json.RawMessage `json:"params,omitempty"`
}

type Response

type Response struct {
	JSONRPC string          `json:"jsonrpc"`
	ID      json.RawMessage `json:"id"`
	Result  any             `json:"result,omitempty"`
	Error   *Error          `json:"error,omitempty"`
}

type SendResult

type SendResult struct {
	Conn *websocket.Conn
	Err  error
}

type Server

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

func NewServer

func NewServer() *Server

func (Server) ServeConn

func (s Server) ServeConn(ctx context.Context, conn *websocket.Conn) error