schema

Documentation

Index

• Constants
• type EchoReq
• type EchoRsp
• type Header
• type HeaderRsp
• type HeartbeatReq
• type HeartbeatRsp
• type STConnectionConfig
• type STServerStatus
• type SignInReq
• type SignInRsp
• type UDPHeader
• type UDPHelloReq
• type UDPHelloRsp

Constants

const (
	ErrCodeOK       = uint32(0) //正确
	ErrCodeFail     = uint32(1) //总之失败
	ErrCodeUnknown  = uint32(2) //未知错误
	ErrCodeInvalid  = uint32(3) //无效
	ErrCodeNotExist = uint32(4) //不存在
	ErrCodeTimeout  = uint32(5) //超时
)

内部错误码范围 [0 - 255] 约定一些常见的错误性质

const (
	ProtoIDHeartbeatReq = uint32(1)
	ProtoIDHeartbeatRsp = uint32(2)
	ProtoIDEchoReq      = uint32(3)
	ProtoIDEchoRsp      = uint32(4)
	ProtoIDSignInReq    = uint32(5)
	ProtoIDSignInRsp    = uint32(6)

	ProtoIDUDPHelloReq = uint32(225)
	ProtoIDUDPHelloRsp = uint32(226)
)

内部协议号范围 [0 - 255]

Types

type EchoReq

type EchoReq struct {
	Text string `json:"text,omitempty"`
}

消息: 回声

type EchoRsp

type EchoRsp struct {
	Text string `json:"text,omitempty"`
}

type Header

type Header struct {
	Seq      uint64 `json:"s,omitempty"`
	Tms      uint64 `json:"t,omitempty"`
	CheckSum string `json:"cs,omitempty"`
	ProtoID  uint32 `json:"p,omitempty"`

	Rsp *HeaderRsp `json:"rsp,omitempty"`
}

消息头(header)

type HeaderRsp

type HeaderRsp struct {
	RequestSeq uint64 `json:"rs,omitempty"`
	RequestTms uint64 `json:"rt,omitempty"`
	ErrCode    uint32 `json:"ec,omitempty"`
	ErrMessage string `json:"em,omitempty"`
}

type HeartbeatReq

type HeartbeatReq struct {
}

消息: 心跳

type HeartbeatRsp

type HeartbeatRsp struct {
	//心跳的response被设计为投递模式, 所以需要显式的时间回执
	BackTms uint64 `json:"backTms,omitempty"`
}

type STConnectionConfig

type STConnectionConfig struct {
	ConfoundCode []byte `json:"confoundCode,omitempty"`
}

type STServerStatus

type STServerStatus struct {
	ServerVersion string `json:"serverVersion,omitempty"`
}

type SignInReq

type SignInReq struct {
}

消息: 服务配置

type SignInRsp

type SignInRsp struct {
	ServerStatus *STServerStatus `json:"serverStatus,omitempty"`

	ConnID     uint64              `json:"connID,omitempty"`
	ConnConfig *STConnectionConfig `json:"connConfig,omitempty"`
}

type UDPHeader

type UDPHeader struct {
	Index uint64 `json:"i,omitempty"`
}

UDP的额外头部

type UDPHelloReq

type UDPHelloReq struct {
	SignCode string `json:"signCode,omitempty"`
}

应为一个UDP客户端发送的第一个消息

type UDPHelloRsp

type UDPHelloRsp struct {
	Index uint64 `json:"index,omitempty"`
}

应为一个UDP客户端接收的第一个消息