protocol

Documentation

Index

• type MessageKey
• type Packet
• type Protocol
  • func NewDefaultProtocol() Protocol

Types

type MessageKey

type MessageKey = uint16

const (
	MessageKeyHeartbeat   MessageKey = 0xffff // MessageKeyHeartbeat heartbeat message
	MessageKeyEmit        MessageKey = iota   // MessageKeyEmit Emit request, no response
	MessageKeyAckRequest                      // MessageKeyAckRequest Emit request, wait for response (ack)
	MessageKeyAckResponse                     // MessageKeyAckResponse ack response
)

type Packet

type Packet interface {
	Key() uint16
	Id() uint64
	Event() string
	Body() []byte
	NewReplyPacket(data []byte) Packet
}

type Protocol

type Protocol interface {
	NewPacket(key MessageKey, id uint64, event string, data []byte) Packet
	WritePacket(p Packet, w io.Writer) (int, error)
	ReadPacket(r io.Reader) (Packet, error)
}

func NewDefaultProtocol

func NewDefaultProtocol() Protocol