jsonrpc

Documentation

Index

• Variables
• func Cors(settings *services.CorsSettings, defaultRoute bool) http.Handler
• func CorsFromEverywhere(settings *services.CorsSettings) http.Handler
• func ExtractJSONRequest(c *http.Context)
• type Client
  • func MakeClient(endpoint string) *Client
  • func (c *Client) Call(request *Request) (*Response, error)
• type Context
  • func (c *Context) Acknowledge() services.Response
  • func (c *Context) Error(code int, message string, data interface{}) services.Response
  • func (c *Context) InternalError() services.Response
  • func (c *Context) InvalidParams(err error) services.Response
  • func (c *Context) MethodNotFound() services.Response
  • func (c *Context) Nil() services.Response
  • func (c *Context) NotFound() services.Response
  • func (c *Context) Params() map[string]interface{}
  • func (c *Context) Result(data interface{}) services.Response
• type Error
• type Handler
  • func MethodsHandler(methods map[string]*Method) (Handler, error)
• type JSONRPCServer
  • func MakeJSONRPCServer(settings *services.JSONRPCServerSettings, handler Handler, ...) (*JSONRPCServer, error)
  • func (s *JSONRPCServer) JSONRPC(handler Handler) http.Handler
  • func (s *JSONRPCServer) Start() error
  • func (s *JSONRPCServer) Stop() error
• type Method
• type Request
  • func MakeRequest(method, id string, params map[string]interface{}) *Request
• type Response
  • func (r *Response) AsJSON() string

Variables

var JSONRPCRequestForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "jsonrpc",
			Validators: []forms.Validator{
				forms.IsString{},
				forms.IsIn{

					Choices: []interface{}{"2.0"},
				},
			},
		},
		{
			Name: "method",
			Validators: []forms.Validator{
				forms.IsString{
					MinLength: 1,
					MaxLength: 100,
				},
			},
		},
		{
			Name: "params",
			Validators: []forms.Validator{

				forms.IsStringMap{},
			},
		},
		{
			Name: "id",
			Validators: []forms.Validator{

				forms.IsOptional{},

				forms.Or{
					Options: [][]forms.Validator{
						{

							forms.IsString{
								MinLength: 1,
								MaxLength: 100,
							},
						},
						{

							forms.IsInteger{
								HasMin: true,
								HasMax: true,
								Min:    -2147483648,
								Max:    2147483647,
							},
						},
					},
				},
			},
		},
	},
}

Functions

func Cors

func Cors(settings *services.CorsSettings, defaultRoute bool) http.Handler

func CorsFromEverywhere

func CorsFromEverywhere(settings *services.CorsSettings) http.Handler

func ExtractJSONRequest

func ExtractJSONRequest(c *http.Context)

extracts the request data from known limitations: very large numerical ID values will be truncated due to the fact that Golang converts JSON numbers to float64 values...

Types

type Client

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

func MakeClient

func MakeClient(endpoint string) *Client

func (*Client) Call

func (c *Client) Call(request *Request) (*Response, error)

type Context

type Context struct {
	Request *Request
}

func (*Context) Acknowledge

func (c *Context) Acknowledge() services.Response

func (*Context) Error

func (c *Context) Error(code int, message string, data interface{}) services.Response

func (*Context) InternalError

func (c *Context) InternalError() services.Response

func (*Context) InvalidParams

func (c *Context) InvalidParams(err error) services.Response

func (*Context) MethodNotFound

func (c *Context) MethodNotFound() services.Response

func (*Context) Nil

func (c *Context) Nil() services.Response

func (*Context) NotFound

func (c *Context) NotFound() services.Response

func (*Context) Params

func (c *Context) Params() map[string]interface{}

func (*Context) Result

func (c *Context) Result(data interface{}) services.Response

type Error

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

type Handler

type Handler func(*Context) *Response

func MethodsHandler

func MethodsHandler(methods map[string]*Method) (Handler, error)

type JSONRPCServer

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

func MakeJSONRPCServer

func MakeJSONRPCServer(settings *services.JSONRPCServerSettings, handler Handler, metricsPrefix string, httpServer *http.HTTPServer) (*JSONRPCServer, error)

func (*JSONRPCServer) JSONRPC

func (s *JSONRPCServer) JSONRPC(handler Handler) http.Handler

func (*JSONRPCServer) Start

func (s *JSONRPCServer) Start() error

func (*JSONRPCServer) Stop

func (s *JSONRPCServer) Stop() error

type Method

type Method struct {
	Form    *forms.Form
	Handler interface{}
}

type Request

type Request struct {
	JSONRPC string                 `json:"jsonrpc"`
	Method  string                 `json:"method"`
	Params  map[string]interface{} `json:"params"`
	ID      string                 `json:"id"`
}

func MakeRequest

func MakeRequest(method, id string, params map[string]interface{}) *Request

type Response

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

func (*Response) AsJSON

func (r *Response) AsJSON() string