jsonrpc

README

JSON-RPC protocol library

Documentation

Index

• Constants
• type CompressionSelector
• type Error
  • func (e Error) Error() string
• type RPC
  • func NewRPC() *RPC
  • func (s *RPC) AddCodec(codec codec.Interface, mime string)
  • func (s *RPC) AddMethod(name string, fn interface{}) error
  • func (s *RPC) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants

const (
	//ErrNotAFunction when passed not a function
	ErrNotAFunction = Error("method must be function")
	//ErrNotEnoughArgs when passed less than three args
	ErrNotEnoughArgs = Error("method needs three args: *http.Request, *args, *reply")
	//ErrNotEnoughOut when method has not output
	ErrNotEnoughOut = Error("method needs one out: error")
	//ErrNotReturnError when method out is not error
	ErrNotReturnError = Error("method needs one out: error")
	//ErrFirstArgRequest when first arg is not *http.Request
	ErrFirstArgRequest = Error("method needs first parameter to be *http.Request")
	//ErrSecondArgError when 2nd arg is not pointer or not exported
	ErrSecondArgError = Error("second argument must be a pointer and must be exported")
	//ErrThirdArgError when 3rd arf is not pointer or not exported
	ErrThirdArgError = Error("third argument must be a pointer and must be exported")
)

Types

type CompressionSelector

type CompressionSelector = codec.CompressionSelector

CompressionSelector alias

type Error

type Error string

Error is constant error

func (Error) Error

func (e Error) Error() string

type RPC

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

RPC server struct

func NewRPC

func NewRPC() *RPC

NewRPC create new server instance

func (*RPC) AddCodec

func (s *RPC) AddCodec(codec codec.Interface, mime string)

AddCodec register codec

func (*RPC) AddMethod

func (s *RPC) AddMethod(name string, fn interface{}) error

AddMethod register method func(r *http.Request, args interface{}, reply *Reply) error

func (*RPC) ServeHTTP

func (s *RPC) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implementation of http.Handler