common

Documentation

Index

• Constants
• type Msg
  • func FailMsg(topic string, errorInfo string) *Msg
  • func NewMsg(Header MsgHeader, Body MsgBody) *Msg
  • func ReadMsg(reader io.Reader) (*Msg, error)
  • func ResponseMsg(topic string, payload []byte) *Msg
  • func SuccessMsg(topic string) *Msg
  • func (m *Msg) ByteSize() uint32
  • func (msg *Msg) Bytes() []byte
  • func (msg *Msg) Copy() *Msg
  • func (msg *Msg) InitLength()
  • func (msg *Msg) IsHeartbeat() bool
  • func (msg *Msg) String() string
  • func (m *Msg) WriteTo(w io.Writer) (int64, error)
• type MsgBody
• type MsgHeader
• type MsgType
  • func (mt MsgType) IsPost() bool
  • func (mt MsgType) IsQuery() bool
  • func (mt MsgType) IsQueryStream() bool
  • func (mt MsgType) NeedReplyToClient() bool
  • func (msgType MsgType) String() string

Constants

const (
	EMPTY     = "EMPTY"     //无数据
	HEARTBEAT = "HEARTBEAT" //心跳
)

const (
	Version = 1
)

Types

type Msg

type Msg struct {
	Header MsgHeader
	Body   MsgBody
}

func FailMsg

func FailMsg(topic string, errorInfo string) *Msg

func NewMsg

func NewMsg(Header MsgHeader,
	Body MsgBody) *Msg

func ReadMsg

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

func ResponseMsg

func ResponseMsg(topic string, payload []byte) *Msg

func SuccessMsg

func SuccessMsg(topic string) *Msg

func (*Msg) ByteSize

func (m *Msg) ByteSize() uint32

func (*Msg) Bytes

func (msg *Msg) Bytes() []byte

func (*Msg) Copy

func (msg *Msg) Copy() *Msg

func (*Msg) InitLength

func (msg *Msg) InitLength()

func (*Msg) IsHeartbeat

func (msg *Msg) IsHeartbeat() bool

func (*Msg) String

func (msg *Msg) String() string

func (*Msg) WriteTo

func (m *Msg) WriteTo(w io.Writer) (int64, error)

WriteTo 将消息写入writer

type MsgBody

type MsgBody struct {
	TopicLen   uint32
	PayloadLen uint32 // Payload长度
	Topic      []byte

	Payload []byte // 消息内容
}

type MsgHeader

type MsgHeader struct {
	Version        uint32
	Type           MsgType
	BodyLen        uint32 // 消息体长度
	ExpireAfterNow uint32 // 相对有效期，单位ms，真实的有效截至时间=消息接收方的now() + ExpireAfterNow, 0表示永久有效
	ClientId       uint32 // 客户端标识
}

type MsgType

type MsgType int32

const (
	POST_WAIT_RESPONSE MsgType = iota // 请求，并等待服务器响应（客户端推送消息后需要等待并接收服务端的处理结果）
	POST_NO_RESPONSE                  // 请求，不需要服务器响应（客户端推送消息后不需要等待服务端的处理结果，防止网络I/O阻塞）
	RESPONSE                          // 服务器响应
	QUERY                             // 查询消息队列
	QUERY_POP                         // 查询消息队列，并删除消息
	QUERY_STREAM                      // 查询消息队列，返回消息流，每个消息只会被一个消费者消费
	QUERY_STREAM_GROUP                // 查询消息队列，返回消息流，每个消息可以被多个消费者消费
)

func (MsgType) IsPost

func (mt MsgType) IsPost() bool

IsPost 是否是post类型的消息

func (MsgType) IsQuery

func (mt MsgType) IsQuery() bool

IsQuery 是否是query类型的消息

func (MsgType) IsQueryStream

func (mt MsgType) IsQueryStream() bool

IsQueryStream 是否是query stream类型的消息

func (MsgType) NeedReplyToClient

func (mt MsgType) NeedReplyToClient() bool

NeedReplyToClient 是否需要向客户端响应

func (MsgType) String

func (msgType MsgType) String() string