3.11 UNSUBACK – 取消订阅确认

服务端发送UNSUBACK报文给客户端用于确认收到UNSUBSCRIBE报文。

3.11.1 UNSUBACK 固定报头 UNSUBACK Fixed Header

图 3-31 – UNSUBACK 报文固定报头 UNSUBACK packet Fixed Header
Bit 7 6 5 4 3 2 1 0
byte 1 MQTT控制报文类型 (11) 保留位
1 0 1 1 0 0 0 0
byte 2 剩余长度

剩余长度字段
表示可变报头的长度,对UNSUBACK报文这个值等于2。

3.11.2 UNSUBACK 可变报头 UNSUBACK Variable Header

UNSUBACK报文可变报头按顺序包含以下字段:所确认的UNSUBSCRIBE报文标识符和属性( Properties)。属性的编码规则如2.2.2节所述。

图 3-32 – UNSUBACK 报文可变报头 UNSUBACK packet Variable Header
Bit 7 6 5 4 3 2 1 0
byte 1 报文标识符 MSB
byte 2 报文标识符 LSB

3.11.2.1 UNSUBACK 属性 UNSUBACK Properties

3.11.2.1.1 属性长度 Property Length

UNSUBACK报文可变报头中的属性的长度被编码为变长字节整数。

3.11.2.1.2 原因字符串 Reason String

31 (0x1F) ,原因字符串(Reason String)标识符。
跟随其后的是UTF-8编码的字符串,表示此次响应相关的原因。此原因字符串(Reason String)是为诊断而设计的可读字符串,不应该被客户端所解析。

服务端使用此值向客户端提供附加信息。如果加上原因字符串之后的UNSUBACK报文长度超出了客户端指定的最大报文长度,则服务端不能发送此原因字符串 [MQTT-3.11.2-1]。包含多个原因字符串将造成协议错误(Protocol Error)。

3.11.2.1.3 用户属性 User Property

38 (0x26) ,用户属性(User Property)标识符。
跟随其后的是UTF-8字符串对。此属性可用于向客户端提供包括诊断信息在内的附加信息。如果加上用户属性之后的UNSUBACK报文长度超出了客户端指定的最大报文长度,则服务端不能发送此属性 [MQTT-3.11.2-2]。用户属性(User Property)允许出现多次,以表示多个名字/值对,且相同的名字可以多次出现。

3.11.3 UNSUBACK 载荷 UNSUBACK Payload

有效载荷包含一个原因码列表。每个原因码对应UNSUBSCRIBE报文中的一个被确认的主题过滤器。UNSUBACK报文中的原因码顺序必须与UNSUBSCRIBE报文中的主题过滤器顺序相匹配 [MQTT-3.11.3-1]。

单字节无符号取消订阅原因码的值如下所示。服务端发送UNSUBACK报文时对于每个收到的主题过滤器,必须使用一个取消订阅原因码 [MQTT-3.11.3-2]。

表 3-9 – UNSUBACK 报文可变报头 UNSUBACK packet Variable Header
16进制 原因码名称 说明
0 0x00 成功 订阅已被删除。
17 0x11 订阅未发现 没有该客户端匹配的主题过滤器被使用。
128 0x80 未指定错误 取消订阅不能被完成且服务端不愿意透露原因或没有其他适用的原因码。
131 0x83 实现指定错误 UNSUBSCRIBE报文有效,但服务端不接受。
135 0x87 未授权 客户端未被授权进行取消订阅。
143 0x8F 主题过滤器无效 主题过滤器格式正确,但不被允许。
145 0x91 报文标识符已占用 指定的报文标识符正在被使用中。

非规范评注

对于UNSUBSCRIBE报文中的每个主题过滤器,总有一个对应的原因码。如果原因码不是针对某个特定的主题过滤器(比如0x91(报文标识符已占用)),则对每个主题过滤器都使用此原因码。

第三章目录 MQTT控制报文

项目主页