messages

Documentation

Index

• Constants
• Variables
• func IsDecodeError(err error) bool
• type AckGroupMessage
• type AckMessage
• type AckNotify
• type AckRequest
• type Action
  • func (a Action) IsInternal() bool
• type ChatMessage
• type ClientCustom
• type Codec
• type Data
  • func NewData(d interface{}) *Data
  • func (d *Data) Deserialize(i interface{}) error
  • func (d *Data) MarshalJSON() ([]byte, error)
  • func (d *Data) String() string
  • func (d *Data) UnmarshalJSON(bytes []byte) error
• type GlideMessage
  • func NewEmptyMessage() *GlideMessage
  • func NewMessage(seq int64, action Action, data interface{}) *GlideMessage
  • func (g *GlideMessage) GetAction() Action
  • func (g *GlideMessage) GetSeq() int64
  • func (g *GlideMessage) SetSeq(seq int64)
  • func (g *GlideMessage) String() string
• type GlideProtocol
• type Hello
• type ServerHello

Constants

const (
	ActionHello               Action = "hello"
	ActionHeartbeat                  = "heartbeat"
	ActionNotifyUnknownAction        = "notify.unknown.action"

	ActionNotifyError = "notify.error"

	ActionInternalOnline  = "internal.online"
	ActionInternalOffline = "internal.offline"
)

Variables

var DefaultCodec = JsonCodec

var JsonCodec = jsonCodec{}

var ProtoBuffCodec = protobufCodec{}

Functions

func IsDecodeError

func IsDecodeError(err error) bool

Types

type AckGroupMessage

type AckGroupMessage struct {
	CliMid string `json:"cliMid,omitempty"`
	Gid    int64  `json:"gid,omitempty"`
	Mid    int64  `json:"mid,omitempty"`
	Seq    int64  `json:"seq,omitempty"`
}

AckGroupMessage 发送群消息服务器回执

type AckMessage

type AckMessage struct {
	CliMid string `json:"cliMid,omitempty"`
	/// message id to tall the client
	Mid int64 `json:"mid,omitempty"`
	Seq int64 `json:"seq,omitempty"`
}

AckMessage 服务端通知发送者的服务端收到消息

type AckNotify

type AckNotify struct {
	Mid int64 `json:"mid,omitempty"`
}

AckNotify 服务端下发给发送者的消息送达通知

type AckRequest

type AckRequest struct {
	Seq  int64  `json:"seq,omitempty"`
	Mid  int64  `json:"mid,omitempty"`
	From string `json:"from,omitempty"`
}

AckRequest 接收者回复给服务端确认收到消息

type Action

type Action string

Action is the type of action that is being performed.

func (Action) IsInternal

func (a Action) IsInternal() bool

type ChatMessage

type ChatMessage struct {
	/// client message id to identity unique a message.
	/// for identity a message
	/// and wait for the server ack receipt and return `mid` for it.
	CliMid string `json:"cliMid,omitempty"`
	/// server message id in the database.
	// when a client sends a message for the first time or  client retry to send a message that
	// the server does not ack, the 'Mid' is empty.
	/// if this field is not empty that this message is server acked, need not store to database again.
	Mid int64 `json:"mid,omitempty"`
	/// message sequence for a chat, use to check message whether the message lost.
	Seq int64 `json:"seq,omitempty"`
	/// message sender
	From string `json:"from,omitempty"`
	/// message send to
	To string `json:"to,omitempty"`
	/// message type
	Type int32 `json:"type,omitempty"`
	/// message content
	Content string `json:"content,omitempty"`
	/// message send time, server store message time.
	SendAt int64 `json:"sendAt,omitempty"`
}

ChatMessage chat message in single/group chat

type ClientCustom

type ClientCustom struct {
	Type    string      `json:"type,omitempty"`
	Content interface{} `json:"content,omitempty"`
}

ClientCustom client custom message, server does not store to database.

type Codec

type Codec interface {
	Decode(data []byte, i interface{}) error
	Encode(i interface{}) ([]byte, error)
}

type Data

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

Data used to wrap message data. Server received a message, the data type is []byte, it's waiting for deserialize to specified struct. When server push a message to client, the data type is specific struct.

func NewData

func NewData(d interface{}) *Data

func (*Data) Deserialize

func (d *Data) Deserialize(i interface{}) error

func (*Data) MarshalJSON

func (d *Data) MarshalJSON() ([]byte, error)

func (*Data) String

func (d *Data) String() string

func (*Data) UnmarshalJSON

func (d *Data) UnmarshalJSON(bytes []byte) error

type GlideMessage

type GlideMessage struct {
	Ver    int64             `json:"ver,omitempty"`
	Seq    int64             `json:"seq,omitempty"`
	Action string            `json:"action"`
	From   string            `json:"from,omitempty"`
	To     string            `json:"to,omitempty"`
	Data   *Data             `json:"data,omitempty"`
	Extra  map[string]string `json:"extra,omitempty"`
}

GlideMessage common data of all message

func NewEmptyMessage

func NewEmptyMessage() *GlideMessage

func NewMessage

func NewMessage(seq int64, action Action, data interface{}) *GlideMessage

func (*GlideMessage) GetAction

func (g *GlideMessage) GetAction() Action

func (*GlideMessage) GetSeq

func (g *GlideMessage) GetSeq() int64

func (*GlideMessage) SetSeq

func (g *GlideMessage) SetSeq(seq int64)

func (*GlideMessage) String

func (g *GlideMessage) String() string

type GlideProtocol

type GlideProtocol struct {
}

type Hello

type Hello struct {
	ClientVersion string `json:"client_version,omitempty"`
	ClientName    string `json:"client_name,omitempty"`
	ClientType    string `json:"client_type,omitempty"`
}

type ServerHello

type ServerHello struct {
	ServerVersion     string   `json:"server_version,omitempty"`
	TempID            string   `json:"temp_id,omitempty"`
	HeartbeatInterval int      `json:"heartbeat_interval,omitempty"`
	Protocols         []string `json:"protocols,omitempty"`
}