jsonrpc

Documentation

Index

• Constants
• type Error
• type Handler
• type Request
  • func (req *Request) DecodeParams(params any) error
  • func (req *Request) Error(err error) *Response
  • func (req *Request) InvalidMethod() *Response
  • func (req *Request) InvalidParams(msg string) *Response
  • func (req *Request) ReadFrom(r io.Reader) (int64, error)
  • func (req *Request) Result(result any) *Response
  • func (req *Request) String() string
• type Response
  • func (res *Response) DecodeResult(result any) error
  • func (res *Response) ReadFrom(r io.Reader) (int64, error)
  • func (res *Response) String() string

Constants

const (
	CodeParseError     = -32700
	CodeInvalidRequest = -32600
	CodeMethodNotFound = -32601
	CodeInvalidParams  = -32602
	CodeInternalError  = -32603
	// -32000 to -32599	Server error, Reserved for implementation-defined server-errors.
	CodeServerError = -32000
)

refer to JSON-RPC 2.0. https://www.jsonrpc.org/specification

const (
	MIMEApplicationJSON            = "application/json"
	MIMEApplicationJSONCharsetUTF8 = "application/json; charset=utf-8"
)

Types

type Error

type Error = erring.Error

Error is a JSON-RPC error.

type Handler

type Handler interface {
	// ServeRPC handles a JSON-RPC request.
	ServeRPC(context.Context, *Request) *Response
}

type Request

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

Request represents a JSON-RPC 2.0 request.

func (*Request) DecodeParams

func (req *Request) DecodeParams(params any) error

DecodeParams decodes the request parameters into the given value.

func (*Request) Error

func (req *Request) Error(err error) *Response

Error returns a response from the request with the given error.

func (*Request) InvalidMethod

func (req *Request) InvalidMethod() *Response

InvalidMethod returns a invalid method response from the request.

func (*Request) InvalidParams

func (req *Request) InvalidParams(msg string) *Response

InvalidParams returns a invalid params response from the request with the given message.

func (*Request) ReadFrom

func (req *Request) ReadFrom(r io.Reader) (int64, error)

ReadFrom decodes the request from the given reader. ReadFrom implements io.ReaderFrom interface.

func (*Request) Result

func (req *Request) Result(result any) *Response

Result returns a response from the request with the given result.

func (*Request) String

func (req *Request) String() string

String returns the string representation of the request.

type Response

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

Response represents a JSON-RPC response.

func (*Response) DecodeResult

func (res *Response) DecodeResult(result any) error

DecodeResult decodes the result into the given value.

func (*Response) ReadFrom

func (res *Response) ReadFrom(r io.Reader) (int64, error)

ReadFrom decodes the JSON-RPC response from the given reader. ReadFrom implements io.ReaderFrom interface.

func (*Response) String

func (res *Response) String() string

String returns the string representation of the response.