protocol

Documentation

Index

• Variables
• func WriteMsg(w io.Writer, e msg) error
• type Ack
  • func NewAck(ok bool, msg string) *Ack
  • func (a *Ack) Msg() string
  • func (a *Ack) Ok() bool
  • func (a *Ack) Type() MsgType
• type Handshake
  • func NewHandshake(id string) *Handshake
  • func (h *Handshake) ID() string
  • func (h *Handshake) Type() MsgType
• type Msg
  • func ReadMsg(r io.Reader) (*Msg, error)
  • func (m *Msg) Ack() (*Ack, error)
  • func (m *Msg) Handshake() (*Handshake, error)
  • func (m *Msg) Request() (*Request, error)
  • func (m *Msg) Response() (*Response, error)
  • func (m *Msg) Type() MsgType
• type MsgType
• type Request
  • func NewRequest(d []byte) *Request
  • func (r *Request) Data() []byte
  • func (r *Request) Type() MsgType
• type Response
  • func NewResponse(d []byte, e error) *Response
  • func (r *Response) Data() []byte
  • func (r *Response) Error() error
  • func (r *Response) Type() MsgType

Variables

var (
	ErrUnexpectedMsgSize = errors.New("unexpected message size")
	ErrInvalidMsgType    = errors.New("invalid message type")
)

Functions

func WriteMsg

func WriteMsg(w io.Writer, e msg) error

Types

type Ack

type Ack struct {
	O bool
	M string
}

func NewAck

func NewAck(ok bool, msg string) *Ack

func (*Ack) Msg

func (a *Ack) Msg() string

func (*Ack) Ok

func (a *Ack) Ok() bool

func (*Ack) Type

func (a *Ack) Type() MsgType

type Handshake

type Handshake struct {
	Id string
}

func NewHandshake

func NewHandshake(id string) *Handshake

func (*Handshake) ID

func (h *Handshake) ID() string

func (*Handshake) Type

func (h *Handshake) Type() MsgType

type Msg

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

func ReadMsg

func ReadMsg(r io.Reader) (*Msg, error)

func (*Msg) Ack

func (m *Msg) Ack() (*Ack, error)

func (*Msg) Handshake

func (m *Msg) Handshake() (*Handshake, error)

func (*Msg) Request

func (m *Msg) Request() (*Request, error)

func (*Msg) Response

func (m *Msg) Response() (*Response, error)

func (*Msg) Type

func (m *Msg) Type() MsgType

type MsgType

type MsgType byte

const (
	TypeHandshake MsgType = 1
	TypeAck       MsgType = 2
	TypeRequest   MsgType = 3
	TypeResponse  MsgType = 4
)

type Request

type Request struct {
	D []byte
}

func NewRequest

func NewRequest(d []byte) *Request

func (*Request) Data

func (r *Request) Data() []byte

func (*Request) Type

func (r *Request) Type() MsgType

type Response

type Response struct {
	// Use string type instead of error type since the type is lost
	// after gob encoding/decoding
	E string
	D []byte
}

func NewResponse

func NewResponse(d []byte, e error) *Response

func (*Response) Data

func (r *Response) Data() []byte

func (*Response) Error

func (r *Response) Error() error

func (*Response) Type

func (r *Response) Type() MsgType