rpcbus

Documentation

Index

• Variables
• type ErrMethodNotExists
  • func (e *ErrMethodNotExists) Error() string
• type RPCBus
  • func New() *RPCBus
  • func (bus *RPCBus) Call(t topics.Topic, req Request, timeOut time.Duration) (interface{}, error)
  • func (bus *RPCBus) Close()
  • func (bus *RPCBus) Deregister(t topics.Topic)
  • func (bus *RPCBus) Register(t topics.Topic, req chan<- Request) error
• type Request
  • func EmptyRequest() Request
  • func NewRequest(p interface{}) Request
• type Response
  • func NewResponse(p interface{}, err error) Response

Variables

var (
	// ErrRequestTimeout is returned when request timeout-ed.
	ErrRequestTimeout = errors.New("timeout-ed request")

	// ErrMethodExists is returned when method is already registered.
	ErrMethodExists = errors.New("method exists already")

	// ErrInvalidRequestChan is returned method is bound to nil chan.
	ErrInvalidRequestChan = errors.New("invalid request channel")

	// DefaultTimeout is used when 0 timeout is set on calling a method.
	DefaultTimeout = 5 * time.Second
)

Types

type ErrMethodNotExists

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

ErrMethodNotExists is returned when calling an unregistered method.

func (*ErrMethodNotExists) Error

func (e *ErrMethodNotExists) Error() string

Error obeys the error interface.

type RPCBus

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

RPCBus is a request–response mechanism for internal communication between node components/subsystems. Under the hood this is long-polling method based on "chan chan" technique.

func New

func New() *RPCBus

New creates an RPCBus instance.

func (*RPCBus) Call

func (bus *RPCBus) Call(t topics.Topic, req Request, timeOut time.Duration) (interface{}, error)

Call runs a long-polling technique to request from the method Consumer to run the corresponding procedure and return a result or timeout.

func (*RPCBus) Close

func (bus *RPCBus) Close()

Close the RPCBus by resetting the registry.

func (*RPCBus) Deregister

func (bus *RPCBus) Deregister(t topics.Topic)

Deregister removes a handler channel from a method.

func (*RPCBus) Register

func (bus *RPCBus) Register(t topics.Topic, req chan<- Request) error

Register registers a method and binds it to a handler channel. methodName must be unique per node instance. If not, returns err.

type Request

type Request struct {
	Params   interface{}
	RespChan chan Response
}

Request is the request object forwarded to the RPC endpoint.

func EmptyRequest

func EmptyRequest() Request

EmptyRequest returns a Request instance with no parameters.

func NewRequest

func NewRequest(p interface{}) Request

NewRequest builds a new request with params. It creates the response channel under the hood.

type Response

type Response struct {
	Resp interface{}
	Err  error
}

Response is the response to the request forwarded to the RPC endpoint.

func NewResponse

func NewResponse(p interface{}, err error) Response

NewResponse builds a new response.