jsonrpc

Documentation

Index

• Constants
• type Error
  • func InternalError(data interface{}) *Error
  • func InvalidParamsError(data interface{}) *Error
  • func InvalidRequestError(data interface{}) *Error
  • func MethodNotFoundError(method string) *Error
  • func NewError(code int, message string, data interface{}) *Error
  • func ParseError(data interface{}) *Error
  • func (e *Error) Error() string
• type Request
  • func (r *Request) IsNotification() bool
• type Response
  • func NewResponse(req *Request, result interface{}, err *Error) *Response

Constants

const (
	ParseErrorCode     = -32700
	InvalidRequestCode = -32600
	MethodNotFoundCode = -32601
	InvalidParamsCode  = -32602
	InternalErrorCode  = -32603
)

Standard error codes

const Version = "2.0"

Version is the JSON-RPC version string

Types

type Error

type Error struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data,omitempty"`
}

Error represents a JSON-RPC error

func InternalError

func InternalError(data interface{}) *Error

InternalError creates an Internal Error

func InvalidParamsError

func InvalidParamsError(data interface{}) *Error

InvalidParamsError creates an Invalid Params error

func InvalidRequestError

func InvalidRequestError(data interface{}) *Error

InvalidRequestError creates an Invalid Request error

func MethodNotFoundError

func MethodNotFoundError(method string) *Error

MethodNotFoundError creates a Method Not Found error

func NewError

func NewError(code int, message string, data interface{}) *Error

NewError creates a new Error with the given code and message

func ParseError

func ParseError(data interface{}) *Error

ParseError creates a Parse Error

func (*Error) Error

func (e *Error) Error() string

Error returns a string representation of the error

type Request

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

Request represents a JSON-RPC request

func (*Request) IsNotification

func (r *Request) IsNotification() bool

IsNotification returns true if the request is a notification (has no ID)

type Response

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

Response represents a JSON-RPC response

func NewResponse

func NewResponse(req *Request, result interface{}, err *Error) *Response

NewResponse creates a new response for the given request