po

Documentation

Index

• type Event
• type Message
• type MessagePk
• type Session
• type Subscription

Types

type Event

type Event common.Event

type Message

type Message struct {
	ClientId        string   `bson:"client_id"` // 客户端id
	MsgId           string   `bson:"msg_id"`
	Mtypeflags      uint8    `bson:"mtypeflags"`
	Topic           string   `bson:"topic"`
	Qos             uint8    `bson:"qos"`
	Payload         string   `bson:"payload"`
	PackageId       uint16   `bson:"pk_id"`
	PfInd           uint8    `bson:"pf_ind"`           // 载荷格式指示，默认0 ， 服务端必须把接收到的应用消息中的载荷格式指示原封不动的发给所有的订阅者
	MsgExpiry       uint32   `bson:"msg_expiry"`       // 消息过期间隔，没有过期间隔，则应用消息不会过期 如果消息过期间隔已过期，服务端还没开始向匹配的订阅者交付该消息，则服务端必须删除该订阅者的消息副本
	TopicAlias      uint16   `bson:"topic_alias"`      // 主题别名，可以没有传，传了就不能为0，并且不能发超过connack中主题别名最大值
	ResponseTopic   string   `bson:"response_topic"`   // 响应主题
	CorrelationData []uint8  `bson:"correlation_data"` // 对比数据，字节类型
	UserProperty    []string `bson:"user_property"`    // 用户属性 , 保证顺序
	SubId           uint32   `bson:"sub_id"`           // 一个变长字节整数表示的订阅标识符 从1到268,435,455。订阅标识符的值为0将造成协议错误
	ContentType     string   `bson:"content_type"`     // 内容类型 UTF-8编码
}

Message 代表 pub、retain、will

type MessagePk

type MessagePk struct {
	ClientId string `bson:"client_id"`
	PkId     uint16 `bson:"pk_id"`
	OpTime   int64  `bson:"op_time"`
}

type Session

type Session struct {
	ClientId string            `bson:"_id"`
	Status   sessionsv5.Status `bson:"status"`

	ExpiryInterval     uint32   `bson:"expiry_interval"`      // session 过期时间
	ReceiveMaximum     uint16   `bson:"receive_maximum"`      // 接收最大值
	MaxPacketSize      uint32   `bson:"max_packet_size"`      // 最大报文长度是 MQTT 控制报文的总长度
	TopicAliasMax      uint16   `bson:"topic_alias_max"`      // 主题别名最大值（Topic Alias Maximum）
	RequestRespInfo    byte     `bson:"request_resp_info"`    // 一个字节表示的 0 或 1, 请求响应信息
	RequestProblemInfo byte     `bson:"request_problem_info"` // 一个字节表示的 0 或 1 , 请求问题信息
	UserProperty       []string `bson:"user_property"`        // 用户属性，可变报头的

	//responseTopic          []byte   // 响应主题
	//correlationData        []byte   // 对比数据
	OfflineTime int64 `bson:"offline_time"`
}

Session 会话

type Subscription

type Subscription struct {
	ClientId        string `bson:"client_id,index"`
	Qos             uint8  `bson:"qos"`
	Topic           string `bson:"topic,index"`
	SubId           uint32 `bson:"sub_id"` // 订阅标识符
	Local           bool   `bson:"local"`
	RetainAsPublish bool   `bson:"retain_as_publish"`
	RetainHandling  uint8  `bson:"retain_handling"`
}