前言
服务端发送SUBACK报文给客户端,用于确认它已收到并且正在处理SUBSCRIBE报文。
SUBACK – 订阅确认
征询SUBACK报文包含一个返回码清单,它们指定了SUBSCRIBE请求的每个订阅被授予的最大QoS等级。
MQTT5是原因码清单,该清单指定了,用于指定授予的最大QoS等级或SUBSCRIBE报文所请求的每个订阅发生的错误。
SUBACK固定报头
剩余长度字段
可变报头长度加上有效载荷长度,编码为变长字节整数。
SUBACK可变报头
SUBACK报文可变报头按顺序包含以下字段:所确认的SUBSCRIBE报文标识符,属性(Properties)。
MQTT3.1.1没有属性
SUBACK属性(MQTT5)
属性长度
SUBACK可变报头中的属性长度被编码为变长字节整数。
原因字符串
31 (0x1F)Byte,原因字符串(Reason String)标识符。
跟随其后的是UTF-8编码的字符串,表示此次响应相关的原因。此原因字符串(Reason String)是为诊断而设计的可读字符串,不应该被客户端所解析。
服务端使用此值向客户端提供附加信息。如果加上原因字符串之后的SUBACK报文长度超出了客户端指定的最大报文长度,则服务端不能发送此原因字符串。包含多个原因字符串将造成协议错误(Protocol Error)。
用户属性
38 (0x26)Byte,用户属性(User Property)标识符。 跟随其后的是UTF-8字符串对。此属性可用于向客户端提供包括诊断信息在内的附加信息。如果加上用户属性之后的SUBACK报文长度超出了客户端指定的最大报文长度,则服务端不能发送此属性 。用户属性(User Property)允许出现多次,以表示多个名字/值对,且相同的名字可以多次出现。
SUBACK报文可变报头
个人感觉MQTT5此处展示的有问题
有效载荷
有效载荷包含一个返回码【MQTT5为原因码】清单。每个返回码【MQTT5为原因码】对应等待确认的SUBSCRIBE报文中的一个主题过滤器。返回码【MQTT5为原因码】的顺序必须和SUBSCRIBE报文中主题过滤器的顺序相同。
MQTT3.1.1的SUBACK报文有效载荷格式
允许的返回码值:
- 0x00 - 最大QoS 0
- 0x01 - 成功 – 最大QoS 1
- 0x02 - 成功 – 最大 QoS 2
- 0x80 - Failure 失败
0x00, 0x01, 0x02, 0x80之外的SUBACK返回码是保留的,不能使用。
有效载荷非规范示例
Success - Maximum QoS 0 | 0 |
---|---|
Success - Maximum QoS 2 | 2 |
Failure | 128 |
有效载荷字节格式非规范示例
描述 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | |
---|---|---|---|---|---|---|---|---|---|
byte 1 | Success - Maximum QoS 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
byte 2 | Success - Maximum QoS 2 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 |
byte 3 | Failure | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
订阅原因码
服务端发送SUBACK报文时必须对收到的每一个主题过滤器设置一种原因码 。
对于SUBSCRIBE报文中的每个主题过滤器,总有一个对应的原因码。如果原因码不是针对某个特定的主题过滤器(比如0x91(报文标识符已占用)),则对每个主题过滤器都使用此原因码。