jsonrpc

package

v0.4.2 Latest Latest Go to latest Published: Mar 5, 2020 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/xiaomingloveqinger/elastos.ela

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Call(url string, reqData Request, rpcUser string, rpcPassword string) (interface{}, error)
func CallArray(url, method string, params ...interface{}) (interface{}, error)
func CallParams(url, method string, params htp.Params) (interface{}, error)
type Config
type Handler
type Request
type Response
type Server
- func NewServer(cfg *Config) *Server

Constants ¶

View Source

const (
	// JSON-RPC protocol version.
	Version = "2.0"
	// JSON-RPC protocol error codes.
	ParseError     = -32700
	InvalidRequest = -32600
	MethodNotFound = -32601
	InvalidParams  = -32602
	InternalError  = -32603
)

Variables ¶

This section is empty.

Functions ¶

func Call ¶

func Call(url string, reqData Request, rpcUser string, rpcPassword string) (interface{}, error)

Call is a util method to send a JSON-RPC request to server.

func CallArray ¶

func CallArray(url, method string, params ...interface{}) (interface{}, error)

CallArray is a util method to send a JSON-RPC request to server.

func CallParams ¶

func CallParams(url, method string, params htp.Params) (interface{}, error)

Types ¶

type Config ¶

type Config struct {
	Path      string
	ServePort uint16
	User      string
	Pass      string
	WhiteList []string
	NetListen func(port uint16) (net.Listener, error)
}

Config is the configuration of the JSON-RPC server.

type Handler ¶

type Handler func(htp.Params) (interface{}, error)

Handler is the registered method to handle a http request.

type Request ¶

type Request struct {
	Id      interface{} `json:"id"`
	Version string      `json:"jsonrpc"`
	Method  string      `json:"method"`
	Params  interface{} `json:"params"`
}

Request represent the standard JSON-RPC request data structure.

type Response ¶

type Response struct {
	Id      interface{} `json:"id"`
	Version string      `json:"jsonrpc"`
	Result  interface{} `json:"result"`
	Error   *htp.Error  `json:"error"`
}

Response represent the standard JSON-RPC Response data structure.

type Server ¶

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

Server is the JSON-RPC server instance class.

func NewServer ¶

func NewServer(cfg *Config) *Server

NewServer creates and return a JSON-RPC server instance.

func (*Server) RegisterAction ¶

func (s *Server) RegisterAction(name string, handler Handler, params ...string)

RegisterAction register a service handler method by it's name and parameters. When a JSON-RPC client's request method matches the registered handler name, it will be invoked. This method is safe for concurrency access.

func (*Server) ServeHTTP ¶

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

func (*Server) Start ¶

func (s *Server) Start() error

func (*Server) Stop ¶

func (s *Server) Stop() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL