drpc

README

package drpc

import "storj.io/drpc"

drpc is a light replacement for gprc.

Usage

var (
	Error         = errs.Class("drpc")
	InternalError = errs.Class("internal error")
	ProtocolError = errs.Class("protocol error")
)

type Conn

type Conn interface {
	Close() error
	Transport() Transport

	Invoke(ctx context.Context, rpc string, in, out Message) error
	NewStream(ctx context.Context, rpc string) (Stream, error)
}

type Description

type Description interface {
	NumMethods() int
	Method(n int) (rpc string, handler Handler, method interface{}, ok bool)
}

type Handler

type Handler = func(srv interface{}, ctx context.Context, in1, in2 interface{}) (out Message, err error)

type Message

type Message interface {
	Reset()
	String() string
	ProtoMessage()
}

type Server

type Server interface {
	Register(srv interface{}, desc Description)
}

type Stream

type Stream interface {
	Context() context.Context

	MsgSend(msg Message) error
	MsgRecv(msg Message) error

	CloseSend() error
	Close() error
}

type Transport

type Transport interface {
	io.Reader
	io.Writer
	io.Closer
}

Documentation

Overview

drpc is a light replacement for gprc.

Index

• Variables
• type Conn
• type Description
• type Handler
• type Message
• type Server
• type Stream
• type Transport

Variables

var (
	Error         = errs.Class("drpc")
	InternalError = errs.Class("internal error")
	ProtocolError = errs.Class("protocol error")
)

Types

type Conn

type Conn interface {
	Close() error
	Transport() Transport

	Invoke(ctx context.Context, rpc string, in, out Message) error
	NewStream(ctx context.Context, rpc string) (Stream, error)
}

type Description

type Description interface {
	NumMethods() int
	Method(n int) (rpc string, handler Handler, method interface{}, ok bool)
}

type Handler

type Handler = func(srv interface{}, ctx context.Context, in1, in2 interface{}) (out Message, err error)

type Message

type Message interface {
	Reset()
	String() string
	ProtoMessage()
}

type Server

type Server interface {
	Register(srv interface{}, desc Description)
}

type Stream

type Stream interface {
	Context() context.Context

	MsgSend(msg Message) error
	MsgRecv(msg Message) error

	CloseSend() error
	Close() error
}

type Transport

type Transport interface {
	io.Reader
	io.Writer
	io.Closer
}