rpc

Documentation

Overview

Package rpc contains defines for rpc server and client.

Package rpc contains defines for rpc server and client.

Index

• Constants
• Variables
• type JsonErrResponse
• type JsonError
  • func (err *JsonError) Error() string
  • func (err *JsonError) ErrorCode() int
• type JsonNotification
• type JsonRequest
• type JsonSubscription
• type JsonSuccessResponse

Constants

const (
	JsonrpcVersion         = "2.0"
	ServiceMethodSeparator = "_"

	ContentType = "application/json"
)

const (
	RPCPath       = "/rpc"
	WebSocketPath = "/ws"

	SubscribeMethodSuffix    = "_subscribe"
	UnsubscribeMethodSuffix  = "_unsubscribe"
	NotificationMethodSuffix = "_subscription"
)

Variables

var (
	// ErrNotificationsUnsupported is returned when the connection doesn't support notifications
	ErrNotificationsUnsupported = errors.New("notifications not supported")
	// ErrNotificationNotFound is returned when the notification for the given id is not found
	ErrSubscriptionNotFound = errors.New("subscription not found")
)

Types

type JsonErrResponse

type JsonErrResponse struct {
	Version string      `json:"jsonrpc"`
	Id      interface{} `json:"id,omitempty"`
	Error   JsonError   `json:"error"`
}

type JsonError

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

func (*JsonError) Error

func (err *JsonError) Error() string

func (*JsonError) ErrorCode

func (err *JsonError) ErrorCode() int

type JsonNotification

type JsonNotification struct {
	Version string           `json:"jsonrpc"`
	Method  string           `json:"method"`
	Params  JsonSubscription `json:"params"`
}

type JsonRequest

type JsonRequest struct {
	Method  string          `json:"method"`
	Version string          `json:"jsonrpc"`
	Id      json.RawMessage `json:"id,omitempty"`
	Payload json.RawMessage `json:"params,omitempty"`
}

type JsonSubscription

type JsonSubscription struct {
	Subscription string      `json:"subscription"`
	Result       interface{} `json:"result,omitempty"`
}

type JsonSuccessResponse

type JsonSuccessResponse struct {
	Version string      `json:"jsonrpc"`
	Id      interface{} `json:"id,omitempty"`
	Result  interface{} `json:"result"`
}