rupicolarpc

type ContextKey ¶

type ContextKey int

ContextKey : Supported keys in context

type Invoker ¶

type Invoker interface {
	Invoke(context.Context, JsonRpcRequest) (interface{}, error)
}

Invoker is interface for method invoked by rpc server

type JsonRPCversion ¶

type JsonRPCversion string

var (
	JsonRPCversion20  JsonRPCversion = "2.0"
	JsonRPCversion20s                = JsonRPCversion20 + "+s"
)

type JsonRpcProcessor ¶

type JsonRpcProcessor interface {
	AddMethod(name string, metype MethodType, action Invoker) *methodDef
	AddMethodNew(name string, metype MethodType, action NewInvoker) *methodDef
	AddMethodFunc(name string, metype MethodType, action methodFunc) *methodDef
	AddMethodFuncNew(name string, metype MethodType, action newMethodFunc) *methodDef
	Process(request RequestDefinition, response io.Writer) error
	ProcessContext(ctx context.Context, request RequestDefinition, response io.Writer) error
	ExecutionTimeout(metype MethodType, timeout time.Duration)
}

func NewJsonRpcProcessor() JsonRpcProcessor

type JsonRpcRequest ¶

type JsonRpcRequest interface {
	Method() string
	Version() JsonRPCversion
	UserData() UserData
	Params() jsonRPCRequestOptions
}

type JsonRpcResponse ¶

type JsonRpcResponse struct {
	Jsonrpc JsonRPCversion `json:"jsonrpc"`
	Error   *_Error        `json:"error,omitempty"`
	Result  interface{}    `json:"result,omitempty"`
	ID      interface{}    `json:"id,omitempty"`
}

func NewError(a error, id interface{}) *JsonRpcResponse

func NewErrorEx(a error, id interface{}, vers JsonRPCversion) *JsonRpcResponse

func NewResult(a interface{}, id interface{}) *JsonRpcResponse

func NewResultEx(a, id interface{}, vers JsonRPCversion) *JsonRpcResponse

type LimitedWriter ¶

type LimitedWriter interface {
	io.Writer
	SetLimit(int64)
}

LimitedWriter returns LimitExceed after reaching limit

func ExceptionalLimitWrite(r io.Writer, n int64) LimitedWriter

type MethodType ¶

type MethodType int

MethodType : Supported or requested method response format

const (
	// RPCMethod : Json RPC 2.0
	RPCMethod MethodType = 1
	// StreamingMethodLegacy : Basic streaming format without header or footer. Can be base64 encoded.
	StreamingMethodLegacy MethodType = 2
	// StreamingMethod : Line JSON encoding with header and footer
	StreamingMethod MethodType = 4
)

type NewInvoker ¶

type NewInvoker interface {
	Invoke(context.Context, JsonRpcRequest, RPCResponser)
}

This have more sense

type RPCResponser ¶

type RPCResponser interface {
	SetResponseResult(interface{}) error
	SetResponseError(error) error
}

RPCResponser handles returning results

type RequestDefinition ¶

type RequestDefinition interface {
	Reader() io.ReadCloser
	OutputMode() MethodType
	UserData() UserData
}

RequestDefinition ...

type StandardErrorType ¶

type StandardErrorType int

StandardErrorType error code *code message meaning *-32700 Parse error Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. *-32600 Invalid Request The JSON sent is not a valid Request object. *-32601 Method not found The method does not exist / is not available. *-32602 Invalid params Invalid method parameter(s). *-32603 Internal error Internal JSON-RPC error. *-32000 to -32099 Server error Reserved for implementation-defined server-errors.

type UserData ¶

type UserData interface{}

UserData is user provided custom data passed to invocation