CONNECT
客户端和服务端建立连接之后,发送的第一个报文必须是CONNECT。客户端只能发送一次CONNECT报文,如果服务端收到了第二个CONNECT报文,必须将其视为错误,并且断开连接。
协议格式
固定报头
可变报头
可变报头分为四个部分,分别是协议名称(Protocol Name),协议级别(Protocol Level),连接标志(Connect Flags),保持连接(Keep Alive)。
协议名称
-
协议名是MQTT的UTF-8编码的字符串。MQTT规范的后续版本不会改变这个字符串的偏移和长度。
-
如果协议不正确服务端断开连接。(MQTT 3.1.1)其他规范中可以有其他规范。
-
数据包检测工具,可以使用协议名来识别MQTT流量。
协议级别
-
使用8位来表示协议的修订版本级别。MQTT3.1.1的协议级别为4。这个也是MQTT5的由来,MQTT5的协议级别为5,故称为MQTT5。
-
服务端收到一个自己不支持的协议级别的时候,必须返回一个returnCode为0x01的CONNACK的报文给客户端,随后服务端断开相应的连接。
连接标志
-
服务端必须校验连接标志中的预留字段是否为0,如果不为0,必须断开该连接。
-
清理会话标志
A. 清理会话标志的表现
a.清理会话标志为0(false)
i.如果已存在相同ClientId的会话,则必须恢复相应的会话。
ii.不存在相同ClientId的会话,则重新创建一个新的会话。
iii.客户端和服务端断开连接后,服务端必须保存相应的会话信息。
iv.连接断开后,服务端必须保留该Session所有的订阅Topic的Qos1和Qos2的消息。服务端也可以保留Qos0的消息,此为可选项。
b.清理会话标志1(true) 客户端和服务端都必须丢弃之前的会话并且重新创建一个会话。会话信息是和连接绑定的,该会话相关的数据,不能被后续的会话使用
B. 状态信息
a. 客户端
i.Qos和Qos2已经发送到服务端,但是还没有完全结束的消息。
ii.Qos2已经收到的消息,但是还没有最终完成的消息。
b. 服务端
i.会话存在的信息,即时会话的其他内容都是空的。
ii.客户端的订阅信息。
iii.Qos1和Qos2已经发送到客户端但是没有完全结束的消息。
iv.Qos2已经收到的,但是还没有最终结束的消息。
v.等待发送给客户端的Qos1和Qos2消息。
vi.可选的等待发送给客户端的Qos0的消息。
C. 注意事项
a. 保留消息不是服务端会话状态的一部分,会话中止时不能删除。
b. 清理会话设置为1时,客户端和服务端的状态删除不需要是原子操作。
c. 如果希望保证在异常时的状态一致性,可以通过清理会话标志始终设置为1直到成功连接上服务。
- 遗嘱标志 遗嘱标志设置了(1或者true)之后,连接建立成功之后,遗嘱消息会被存储在服务端并且和这个网络连接绑定,当该网络连接异常关闭时,服务端必须发布这个遗嘱消息,除非客户端发送了DISCONNECT消息后,服务端删除了该消息。
A. 遗嘱消息发布的条件,包括但不限于
a. 服务端检测到IO错误或者网络故障。
b. 客户端在保持连接的时间内未能通讯。
c. 客户端没有先发送DISCONNECT报文而直接关闭了连接。
d. 由于协议错误服务端关闭了网络连接。
a. 遗嘱标志设置后,Will Qos和Will Retain会被用到,有效载荷必需包含Will Topic和Will Message。
b. 被发布或收到客户端的DISCONNECT报文之后,遗嘱消息必须从存储中删除。
c. 遗嘱标志设置为0时,Will Qos和Will Retain字段必须设置为0,并且有效载荷中不能包含Will Topic和Will Message.
d. 服务端应该迅速发布遗嘱消息。在关机或者故障的情况下,服务端可以推迟发布消息到服务恢复。
-
遗嘱消息Qos 遗嘱消息的QOS。
-
遗嘱预留消息 遗嘱消息的保留标志。
-
用户名标志 表示是否又用户名在有效载荷中。
-
密码标志 表示是否又密码在有效载荷中,如果用户名标志为0,该字段也必须为0。
保持连接
-
保持连接单位为秒(s),两个Byte 16位表示,所以最长的keepAlive的时间为18小时12分15秒。
-
表示的是客户端从发送完一个报文到发送下一个报文,两者之间允许的最大时间间隔。客户端负责保证控制报文发送的时间间隔不超过保持连接的值,如果没有其他的报文可以发送,客户端必须发送PINGREQ报文。
-
客户端可以随时发送PINGREQ报文,并且根绝PINGRESP的报文判断和服务端的活动状态。
-
如果服务端在1.5倍的保持连接(非0)时间内没有收到任何的报文,服务端必须断开相应的连接。
-
客户端发送PINGREQ之后,在规定的时间没有收到服务端的PINGRESP报文的回应,客户端应该断开该连接。
-
保持连接设置为0表示关闭保持连接的功能。服务端不需要因为客户端的不活跃而断开连接。
-
服务端主要认为客户端是不活跃或者无响应的,都可以断开客户端连接。
有效载荷
有效载荷中的字段包含一个或者多个是根据可变报头中的标志来决定有无的。如果存在的话,必须按照如下的顺序,ClientId, Will Topic, Will Message, User Name, Password。
-
ClientId
A. 每个客户端连接服务端必须有一个唯一的ClientId标志。该标志是客户端和服务端用来区分会话的唯一标志。
B. 必须提供并且必须是CONNECT报文有效负载的第一个字段。
C. 必须[1-23]的UTF-8编码,包含的内容必须是[0-9][a-z][A-Z]。服务端也可以支持更长的以及其他的UTF-8字符。
D. 如果ClientId是0字节的,服务端必须为其赋予一个唯一的标志,然后进行后续的处理。ClientId为0字节时有如下的限制,
a. 清理会话标志必须设置为1,否则服务端返回returnCode=0x02的CONNACK,并且关闭该网络连接。
E. 服务端如果拒绝该ClientId,服务端必须返回returnCode=0x02的CONNACK,并且关闭该网络连接。
-
Will Topic 遗嘱消息的topic,必须是UTF-8编码的字符串。
-
Will Message 遗嘱消息的内容。
-
User Name 用户名,必须是UTF-8的字符串。
-
Passowrd
由两个Byte表示的二进制数据标识。最长可以为65535Bytes的二进制。
响应
检验
-
网络建立后,服务端在指定时间内没有收到客户端的CONNECT消息,服务端应该关闭连接。
-
服务端必须按照以上规范来验证CONNECT报文,如果不符合规范,服务端必须关闭连接,而且不需要发送CONNACK。
-
服务端可以检查CONNECT的内容,如果任何一个检查没有通过,应该返回一个指定的CONNACK的报文,并且必须关闭该连接。
服务端检验通过后的处理
-
如果又相同ClientId的连接,服务端必须关闭已有的连接。
-
服务端需要处理和清理会话相关的内容。
-
返回客户端CONNACK。
-
开始消息投递和保活监控。 备注:客户端可以不等待CONNACK的返回,直接发送其他的控制报文,如果服务端拒绝了相应的连接,服务端必须不处理CONNECT报文之后的任何协议。
CONNACK
服务端返回给客户端的第一个协议必须是CONNACK报文。协议格式
固定报头
固定报头中只有报文类型为2。
可变报头
可变报头包含连接确认标志和连接返回码。
连接确认标志
-
保留位必须为0
-
当前会话SP
A. 服务端如果没有之前的会话时,该值为0。
B. 如果returnCode=0(连接被接收),服务端存在之前的会话,该值为1。
C. 该标志能够是客户端和服务端是否又已存在会话保持一致,如果两者不一致,客户端可以选择断开连接或者继续连接。客户端可以通过断开连接,清理会话设置为1,再次连接,然后再次断开连接的方式来丢弃客户端和服务端的会话状态。
D. 如果返回码非0,会话状态必须为0。
连接返回码
有效载荷
CONNACK报文没有有效载荷字段。
2
总结
-
连接报文是MQTT连接建立之后的第一个报文,如果不是将会断开连接,并且连接报文也只能发送一次。
-
清理会话的设置也是通过连接报文进行设置,可以通过重新连接,设置清理会话的标志来保持客户端和服务端的会话信息。
-
遗言是跟连接绑定的,在用户非正常DISCONNECT的情况下将触发遗言的发布。
-
保持连接是检测客户端发送到服务端的消息的间隔时间,协议固定在1.5倍的保持连接的时间,会断开连接。现在使用的EMQ的保持连接的机制,KeepAlive * backoff = CheckTime,从客户端建立连接开始进行循环检测,连续两次没有检测到Socket报文的话,则认为超时,故真实的超时时间为CheckTime * 2 < RealTimeout < CheckTime * 3。
原文链接
https://mp.weixin.qq.com/s/ZaBkqlmWboOT7SEpQOln_Q