rpc

Documentation

Overview

Package rpc implements rpc engine.

Index

• func NopSend(ctx context.Context, msgID int64, seqNo int32, in bin.Encoder) error
• type Clock
• type Config
• type Engine
  • func New(send Send, cfg Config) *Engine
  • func (e *Engine) Do(ctx context.Context, req Request) error
  • func (e *Engine) NotifyAcks(ids []int64)
  • func (e *Engine) NotifyError(msgID int64, rpcErr error)
  • func (e *Engine) NotifyResult(msgID int64, b *bin.Buffer) error
• type Request
• type RetryLimitReachedErr
  • func (r *RetryLimitReachedErr) Error() string
  • func (r *RetryLimitReachedErr) Is(err error) bool
• type Send

Functions

func NopSend

func NopSend(ctx context.Context, msgID int64, seqNo int32, in bin.Encoder) error

NopSend does nothing.

Types

type Clock

type Clock interface {
	After(d time.Duration) <-chan time.Time
}

Clock abstracts temporal effects.

type Config

type Config struct {
	RetryInterval time.Duration
	MaxRetries    int
	Logger        *zap.Logger
	Clock         Clock
}

Config of rpc engine.

type Engine

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

Engine handles RPC requests.

func New

func New(send Send, cfg Config) *Engine

New creates new rpc Engine.

func (*Engine) Do

func (e *Engine) Do(ctx context.Context, req Request) error

Do sends request to server and blocks until response is received, performing multiple retries if needed.

func (*Engine) NotifyAcks

func (e *Engine) NotifyAcks(ids []int64)

NotifyAcks notifies engine about received acknowledgements.

func (*Engine) NotifyError

func (e *Engine) NotifyError(msgID int64, rpcErr error)

NotifyError notifies engine about received RPC error.

func (*Engine) NotifyResult

func (e *Engine) NotifyResult(msgID int64, b *bin.Buffer) error

NotifyResult notifies engine about received RPC response.

type Request

type Request struct {
	ID       int64
	Sequence int32
	Input    bin.Encoder
	Output   bin.Decoder
}

Request represents client RPC request.

type RetryLimitReachedErr

type RetryLimitReachedErr struct {
	Retries int
}

RetryLimitReachedErr means that server does not acknowledge request after multiple retries.

func (*RetryLimitReachedErr) Error

func (r *RetryLimitReachedErr) Error() string

func (*RetryLimitReachedErr) Is

func (r *RetryLimitReachedErr) Is(err error) bool

Is reports whether err is RetryLimitReachedErr.

type Send

type Send func(ctx context.Context, msgID int64, seqNo int32, in bin.Encoder) error

Send is a function that sends requests to the server.