rpc

Documentation

Index

• Constants
• type Client
  • func NewClient(addr string) (*Client, error)
• type Code
• type Error
  • func InternalError(msg string) *Error
  • func InvalidParamsError(msg string) *Error
  • func InvalidRequestError(msg string) *Error
  • func MethodNotFoundError(msg string) *Error
  • func NewError(code Code, msg string) *Error
  • func NotAllowedError(msg string) *Error
  • func ParseError(msg string) *Error
• type Server
  • func NewServer(w io.Writer, config *config.Server) *Server
  • func (srv *Server) Close() error
  • func (srv *Server) Prepare(u *url.URL) error
  • func (srv *Server) Register(name string, rcvr interface{}) error
  • func (srv *Server) RegisterRestfulMap(routerMap map[string]http.HandlerFunc)
  • func (srv *Server) Start() error

Constants

const (
	// Pre-defined errors for JSON-RPC 2.0 https://www.jsonrpc.org/specification#error_object
	CodeParseError     = -32700
	CodeInvalidRequest = -32600
	CodeMethodNotFound = -32601
	CodeInvalidParams  = -32602
	CodeInternalError  = -32603

	// -32000 to -32099 Are application level errors (i.e. define your rpc errors in this range)
	CodeNotAllowed = -32001

	CodeNotFound = -32000
)

const (
	// All incoming requests must show this MIME type in the header
	ContentType = "application/json"

	PathJSON = "/jsonrpc"
	PathGOB  = "/rpc/gob"
	Path     = PathJSON
)

The http path used for our rpc handlers

Types

type Client

type Client struct {
	*jsonrpc2.Client
}

func NewClient

func NewClient(addr string) (*Client, error)

type Code

type Code int

type Error

type Error = jsonrpc2.Error

func InternalError

func InternalError(msg string) *Error

func InvalidParamsError

func InvalidParamsError(msg string) *Error

func InvalidRequestError

func InvalidRequestError(msg string) *Error

func MethodNotFoundError

func MethodNotFoundError(msg string) *Error

func NewError

func NewError(code Code, msg string) *Error

func NotAllowedError

func NotAllowedError(msg string) *Error

func ParseError

func ParseError(msg string) *Error

type Server

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

Server holds an RPC server that is served over HTTP

func NewServer

func NewServer(w io.Writer, config *config.Server) *Server

func (*Server) Close

func (srv *Server) Close() error

Close terminates the underlying HTTP server and listener

func (*Server) Prepare

func (srv *Server) Prepare(u *url.URL) error

Prepare injects all the data necessary for serving over the specified URL. It prepares a net.Listener over the specified URL, and registers all methods inside the given receiver. After this method is called, the Start function is ready to be called.

func (*Server) Register

func (srv *Server) Register(name string, rcvr interface{}) error

Register creates a service on the Server with the given name. The criteria of a service method is the same as defined in the net/rpc package: - the method's type is exported. - the method is exported. - the method has two arguments, both exported (or builtin) types. - the method's second argument is a pointer. - the method has return type error.

func (*Server) RegisterRestfulMap

func (srv *Server) RegisterRestfulMap(routerMap map[string]http.HandlerFunc)

RegisterRestfulMap registers all restful API functions in a map on the Server

func (*Server) Start

func (srv *Server) Start() error

Start spawns a new goroutine and listens on the configured address. Prepare should be called before calling this method