MQTT Client源码分析

已于 2024-09-04 10:36:05 修改
阅读量1.1k 收藏 17
点赞数 18
文章标签： C
于 2024-09-04 10:11:04 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/studyingdda/article/details/141885585
版权

MQTT Client源码分析

目录

之前基于杰杰的mqttclient代码和韦东山老师的教程，把MQTTClient程序移植到STM32F103开发板，F103的开发板串口连接ESP8266模组实现终端连接到MQTT服务器的功能，仅仅是对着韦老师的教程移植和使用杰杰的mqttclient代码，简单的将mqttclient\platform\FreeRTOS\platform_net_socket.c文件中的接口绑定到ESP8266的TCP AT命令，使用ESP8266的Socket，对于杰杰的mqttclient代码并没有深入分析和理解。

1. mqttclient架构

如下图：

在这里插入图片描述

1.1 API

mqttclient的API接口：

int mqtt_init(mqtt_client_t* c, client_init_params_t* init);
int mqtt_release(mqtt_client_t* c);
int mqtt_connect(mqtt_client_t* c);
int mqtt_disconnect(mqtt_client_t* c);
int mqtt_subscribe(mqtt_client_t* c, const char* topic_filter, mqtt_qos_t qos, message_handler_t msg_handler);
int mqtt_unsubscribe(mqtt_client_t* c, const char* topic_filter);
int mqtt_publish(mqtt_client_t* c, const char* topic_filter, mqtt_message_t* msg);

int mqtt_keep_alive(mqtt_client_t* c);
int mqtt_yield(mqtt_client_t* c, int timeout_ms);

1.2 mqtt_client_t结构体

typedef struct mqtt_client {
    char                        *mqtt_client_id; //由用户传入，在连接MQTT时（mqtt_connect_with_results）序列化连接报文
    char                        *mqtt_user_name; //由用户传入，在连接MQTT时（mqtt_connect_with_results）序列化连接报文
    char                        *mqtt_password; //由用户传入，在连接MQTT时（mqtt_connect_with_results）序列化连接报文
    char                        *mqtt_host; //由用户传入，在连接MQTT时（mqtt_connect_with_results）序列化连接报文
    char                        *mqtt_port; //由用户传入，在连接MQTT时（mqtt_connect_with_results）序列化连接报文
    char                        *mqtt_ca; //TLS才会用到，暂时不分析
    void                        *mqtt_reconnect_data; //MQTT需要重连服务器时用到
    uint8_t                     *mqtt_read_buf; //读数据缓冲区
    uint8_t                     *mqtt_write_buf; //写数据缓冲区
    uint16_t                    mqtt_keep_alive_interval; //MQTT保活超时时间
    uint16_t                    mqtt_packet_id; //报文标识符
    uint32_t                    mqtt_will_flag          : 1; //遗嘱标志
    uint32_t                    mqtt_clean_session      : 1; //清理会话标志
    uint32_t                    mqtt_ping_outstanding   : 2; //PINGREQ后是否正在等待PINGRESP标志
    uint32_t                    mqtt_version            : 4; //MQTT协议版本
    uint32_t                    mqtt_ack_handler_number : 24; //用于QOS1和QOS2中ACK记录
    uint32_t                    mqtt_cmd_timeout; //命令超时时间（主要是读写阻塞时间、等待响应的时间、重连等待时间）
    uint32_t                    mqtt_read_buf_size; //读数据缓冲区大小
    uint32_t                    mqtt_write_buf_size; //写数据缓冲区大小
    uint32_t                    mqtt_reconnect_try_duration; //客户端在尝试重新连接到MQTT服务器时所允许的最大尝试时间
    size_t                      mqtt_client_id_len; //clientID最大长度
    size_t                      mqtt_user_name_len; //userName最大长度
    size_t                      mqtt_password_len; //password最大长度
    mqtt_will_options_t         *mqtt_will_options; //遗嘱消息配置
    client_state_t              mqtt_client_state; //客户端状态（INVALID、INITIALIZED、CONNECTED、DISCONNECTED、CLEAN_SESSION）
    platform_mutex_t            mqtt_write_lock; //写数据锁
    platform_mutex_t            mqtt_global_lock; //全局锁，比如转换客户端状态时需要先锁
    mqtt_list_t                 mqtt_msg_handler_list; //所有来自服务器的publish报文都会被处理（前提是订阅了对应的消息），mqtt协议必须实现的内容
    mqtt_list_t                 mqtt_ack_handler_list; //所有等待响应的报文都会被挂载到这个链表上，异步实现的核心
    network_t                   *mqtt_network; //网卡接口，保存网络相关信息（host、port、socket）
    platform_thread_t           *mqtt_thread; //内部线程mqtt_yield_thread，所有来自服务器的mqtt包都会在这里被处理
    platform_timer_t            mqtt_reconnect_timer; //掉线重连定时器
    platform_timer_t            mqtt_last_sent; //用于保活定时器
    platform_timer_t            mqtt_last_received; //保活定时器
    reconnect_handler_t         mqtt_reconnect_handler; //mqtt重连处理
    interceptor_handler_t       mqtt_interceptor_handler; //publish数据时调用，个人理解是要发送的数据与client绑定
} mqtt_client_t;

1.3 mqtt_yield_thread内部线程

mqtt_yield_thread线程中主要执行mqtt_yield(c, c->mqtt_cmd_timeout)函数

在这里插入图片描述

mqtt_yield中主要执行mqtt_packet_handle(c, &timer)处理MQTT接收到的消息

在这里插入图片描述

static int mqtt_packet_handle(mqtt_client_t* c, platform_timer_t* timer)
{
    int rc = MQTT_SUCCESS_ERROR;
    int packet_type = 0;
    
    rc = mqtt_read_packet(c, &packet_type, timer);

	//printf("read packet rc = %d, packet_type = %d, g_remain_len = %d\r\n", rc, packet_type, g_remain_len);
    switch (packet_type) {
        case 0: /* timed out reading packet */
            break;

        case CONNACK: /* has been processed */
            goto exit;

        case PUBACK:
        case PUBCOMP:
            rc = mqtt_puback_and_pubcomp_packet_handle(c, timer);
            break;

        case SUBACK:
            rc = mqtt_suback_packet_handle(c, timer);
            break;
            
        case UNSUBACK:
            rc = mqtt_unsuback_packet_handle(c, timer);
            break;

        case PUBLISH:
            rc = mqtt_publish_packet_handle(c, timer);
            break;

        case PUBREC:
        case PUBREL:
            rc = mqtt_pubrec_and_pubrel_packet_handle(c, timer);
            break;

        case PINGRESP:
            c->mqtt_ping_outstanding = 0;    /* keep alive ping success */
            break;

        default:
            goto exit;
    }

    rc = mqtt_keep_alive(c);	/* Keep the treatment alive */

exit:
    if (rc == MQTT_SUCCESS_ERROR)
        rc = packet_type;

    RETURN_ERROR(rc);
}

1.4 keepalive

当第一次发生超时时，会在mqtt_keep_alive中序列还一个心跳包发送给服务器，并将mqtt_ping_outstanding加1，当第二次超时时会设置client状态为CLIENT_STATE_DISCONNECTED尝试重连，若重连成功后需要重新订阅

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

1.5 ack链表

需要等待服务器应答消息时会加入ack链表（参考2.2中SUBACK），每次接收到服务器消息时，会对ack链表进行扫描，超时后会销毁链表节点，如果是PUBACK、PUBREC、PUBREL、PUBCOMP则需要重发

在这里插入图片描述

在这里插入图片描述

2. mqttclient流程

2.1 MQTT CONNECT

  • 用户初始化mqtt_client_t参数后，调用int mqtt_connect(mqtt_client_t* c);连接MQTT服务器

在这里插入图片描述

  • 调用到底层rc = network_connect(c->mqtt_network);连接MQTT服务器

在这里插入图片描述

  • 最终调用到平台层的n->socket = platform_net_socket_connect(n->host, n->port, PLATFORM_NET_PROTO_TCP);发送连接请求，其中实现了与ESP8266 TCP AT SOCKET绑定

在这里插入图片描述

  • 之后使用MQTTSerialize_connect(c->mqtt_write_buf, c->mqtt_write_buf_size, &connect_data)序列化mqtt的CONNECT报文，并使用mqtt_send_packet(c, len, &connect_timer)发送出去

在这里插入图片描述

  • mqtt_send_packet也是调用网络接口network_write(c->mqtt_network, &c->mqtt_write_buf[sent], length, platform_timer_remain(timer)最终调用平台接口platform_net_socket_write_timeout(n->socket, write_buf, len, timeout)

在这里插入图片描述

在这里插入图片描述

  • 发送完毕后在mqtt_wait_packet(c, CONNACK, &connect_timer) == CONNACK)等待服务器回复的CONNACK报文

在这里插入图片描述

  • 连接服务器成功后创建一个MQTT内部线程platform_thread_init("mqtt_yield_thread", mqtt_yield_thread, c, MQTT_THREAD_STACK_SIZE, MQTT_THREAD_PRIO, MQTT_THREAD_TICK)并启动，所有来自服务器的mqtt包都会在这里被处理

在这里插入图片描述

  • 当需要进行重连时，不需要重新创建MQTT内部线程，只需要改变MQTT Client的状态即可

在这里插入图片描述

在这里插入图片描述

2.2 MQTT SUBSCRIBE

  • 连接MQTT服务器后，用户可以直接调用mqtt_subscribe(client, "home", QOS0, smarthome_msg_handler);订阅主题

在这里插入图片描述

  • mqtt_subscribe会调用MQTTSerialize_subscribe(c->mqtt_write_buf, c->mqtt_write_buf_size, 0, packet_id, 1, &topic, (int*)&qos)序列化订阅报文，并调用mqtt_send_packet(c, len, &timer)发送订阅消息

在这里插入图片描述

  • 然后使用mqtt_msg_handler_create(topic_filter, qos, handler)创建对应的消息处理节点，这个消息节点在收到服务器的SUBACK订阅应答报文后会挂在到消息处理列表msg_handler上

在这里插入图片描述

  • 在mqtt_ack_list_record(c, SUBACK, packet_id, len, msg_handler)中记录等待服务器响应的SUBACK

在这里插入图片描述

  • 收到服务器响应的SUBACK回复后，在mqtt_suback_packet_handle(c, timer)中会取消ack_list里的SUBACK记录，并安装到msg_handler_list

在这里插入图片描述

在这里插入图片描述

MQTT UNSUBSCRIBE的流程与MQTT SUBSCRIBE的流程差不多。

2.3 MQTT PUBLISH

  • 连接服务器后，用户可以直接调用mqtt_publish(client, "home", &msg)向某主题发布消息

在这里插入图片描述

  • 与订阅流程类似，先使用MQTTSerialize_publish(c->mqtt_write_buf, c->mqtt_write_buf_size, 0, msg->qos, msg->retained, msg->id, topic, (uint8_t*)msg->payload, msg->payloadlen)序列化发布报文，在使用mqtt_send_packet(c, len, &timer)并发布到服务器

在这里插入图片描述

  • 对于QOS1或QOS2需要将PUBACK或PUBREC加入到ack_list中，与SUBACK类似，并提前设置了DUP重发标志位

在这里插入图片描述

在这里插入图片描述

2.4 接收服务器PUBLISH消息

  • 服务器发送的PUBLISH消息会在client的内部线程mqtt_yield_thread中的mqtt_packet_handle中处理

在这里插入图片描述

  • 先对收到的消息进行反序列化，QOS1和QOS2类型需要回复ACK，让后处理收到的消息，注意QOS还需要先等待服务器的PUBREL ACK后再处理接收的消息

在这里插入图片描述

  • 在mqtt_get_msg_handler(c, topic_name)中获取当前主题的处理函数，并将接收的数据在数据处理函数msg_handler中处理，该处理函数在订阅主题时定义

在这里插入图片描述

在这里插入图片描述

以上是杰杰mqttclient代码分析，后期如果能够有更深的认识再继续补充，欢迎各位大佬补充和指正！

studyingdda
关注
  • 18
    点赞
  • 踩
  • 17
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
linux 使用paho C库实现mqtt客户端
健忘16的博客
09-27 5601
一、下载 github 下载paho mqtt c库源码，编译安装库文件。 地址：https://github.com/eclipse/paho.mqtt.c 关键API：Paho Asynchronous MQTT C Client Library: MQTTAsync.h File Reference 说明：paho客户端库是纯c库，支持两种操作模式：同步模式和异步模式。异步方式调用MQTTClient_setCallbacks接口设置回调函数。 同步模式 客户端应用程序在单个线程上运行，主要
Linux下学习用C语言实现MQTT(三）（异步函数）
qq_1711318490的博客
03-13 6087
客户端库支持两种操作模式，称为同步模式和异步模式。如果你的应用程序调用了MQTTClient_setCallbacks()，则客户端将会进入异步模式，否则会以同步模式运行。 同步模式下，客户端应用程序运行在单个线程上。信息的发布使用MQTTClient_publish()和MQTTClient_publishMessage()函数。为了确定Qos1和Qos2（详见Quality of servic...
Asynchronous vs synchronous client applications（MQTT）
Homejim的博客
12-27 1453
想查看英文原文的请点击原文网址。在上两篇翻译中，Homejim我给大家分别翻译了同步客户端应用程序和异步客户端应用程序。本人对这两个的区别也有困惑，因此将paho下的这个比较也看了一下。还是那句话，水平有限，如有翻译不当之处，欢迎指正。 异步客户端应用程序 VS 同步客户端应用程序   客户端库支持两种操作模式，称为同步模式和异步模式。如果你的应用程序调用了MQTTClient_setCallb
MQTT源码分析
最新发布
2301_78772787的博客
05-20 1316
那么该函数的执行过程如下：有一个线程 该线程主要执行一个死循环 死循环中调用读消息相关函数去读网络数据 如果读到的网络数据是一个主题的消息（Publish发过来的消息） 那么就会去分辨主题Topic 再调用对应函数。该函数会做如下事情：1、读数据（Read Packet）并处理数据 2、若一直没读取到数据，则会时不时发送Ping给服务器，保持心跳 3、处理各种错误。这里用Publsh数据类型处理数据做演示。
跨平台MQTT Client 源码和demo by 漠北
11-15
【源码分析】 "跨平台MQTT Client 源码和demo by 漠北" 提供的源码很可能是用Delphi语言编写的，实现了MQTT客户端的功能。源码可能包含以下关键部分： 1. **连接管理**：实现与MQTT服务器的TCP连接建立、保持和...
mqttClient最新的源码
06-01
**源码分析** `paho.mqtt.m2mqtt-master`源码中，`MqttClient`类是核心，它实现了连接、发布、订阅、断开等基本操作。`MqttConnectOptions`类用于配置连接参数，如用户名、密码、超时时间等。`MqttMessage`类代表...
MQTT-Client-master.rar_MQTT 服务器_MQTT client_MQTT-master_mqtt 客户
07-15
通过分析和学习这个源码，开发者可以更好地理解MQTT协议的工作原理，也可以为自己的物联网项目创建自定义的MQTT客户端。此外，对于MQTT服务器的测试，这样的客户端工具非常实用，可以模拟各种客户端行为，验证服务器...
实现AT命令解析器，提供mqttclient库socket接口，实现mqttclient收发。
08-18
工程源码是基于STM32F407ZGT6芯片，使用FreeRTOS系统，实现了ESP8266AT命令收发解析器模块，并根据AT命令解析器实现了ESP8266的socket数据收发接口，从而给mqttclient库提供底层的数据收发接口。最终可以实现设备...
C# Mqtt源码,参考学习,包含库文件.net4.5
06-07
2. **连接到MQTT broker**：C#源码中会包含建立到MQTT broker的连接的代码，通常使用`MqttClient`类，设置服务器地址、端口、用户名和密码等参数。 3. **订阅与发布**：`Subscribe`方法用于订阅主题，`Publish`方法...
Unity 【Content Size Fitter】- 聊天气泡自动适配Text文本框大小
当代野生程序猿
02-25 5744
通常在展示人物对话的时候文本的长度是不定的，因此会需要动态的调整对话内容文本框的背景图片的大小，这里以如下这种气泡框的对话为例： 实现该需求涉及到的内容包括Content Size Fitter组件的使用、2D Sprite工具包的使用。 Content Size Fitter组件用于Text文本框，如图所示，我们将Horzontal Fit设为Preferred Size，当我们调整Text文本框中的内容时，其大小会自动进行调整。 注意Rect Transform中Pivot轴心点的设置
新唐NUC972 Linux（一）：USB烧写linux出厂镜像
小破孩的博客
02-20 3363
USB烧写出厂镜像 文章目录USB烧写出厂镜像前言一、硬件连接二、安装驱动三、烧写linux程序四、运行程序 前言 今天开始进军linux，学了那么久单片机，也摸得七七八八，至少点个灯还是会的。本人之所以买酷客的linux开发板主要是便宜，资料也算齐全，虽然没有原子那么好，不过也够了，找那么多借口，其实就是qiong。今天先从USB烧录官方提供的linux相关程序到芯片开始吧。 一、硬件连接 1、连接电源线 2、RS232转USB，需要安装CH340驱动，用于在电脑串口超级终端中查看调试信息。 3、U
WeChall CTF Writeup（一）
weixin_43211186的博客
02-25 1474
以下题目标题组成： [Score] [Title] [Author] 文章目录0x01 1 Training: Get Sourced by Gizmore0x02 1 Training: Stegano I by Gizmore0x03 1 Training: Crypto - Caesar I by Gizmore0x04 1 Training: WWW-Robots by Gizmore0x05 1 Training: ASCII by Gizmore 0x01 1 Training: Get Sou
C语言每日一练——第126天：佩奇借书问题
热门推荐
Edison's 小宇宙
02-25 2万+
史上最强借书方案问题讲解（代码详解+思路分析+动图演示+特性总结）
CS5261与CS5265功能应用|CS5261替代RTD2171|CS5265替代RTD2172
qq1659747718的博客
02-25 1269
CS5261可以完全替代兼容停产RTD2171,CS5265可以完全替代兼容RTD2172，芯片单价低，整体方案设计简单，整体BOM成本较RTD2171、RTD2172低。
Hello Kafka（八）——Confluent Kafka简介
天山老妖
02-24 8858
一、Confluent Kafka简介 1、Confluent Kafka简介 2014年，Kafka的创始人Jay Kreps、NahaNarkhede和饶军离开LinkedIn创立Confluent公司，专注于提供基于Kafka的企业级流处理解决方案，并发布了Confluent Kafka。Confluent Kafka分为开源版和企业版，企业版收费。 2、Confluent Kafka特性 Confluent Kafka开源版特性如下： （1）Confluent Kafka Connecto
基于System Verilog的同步FIFO实现(一)
qq_40268672的博客
02-22 3065
FIFO，全称First In First Out，它是数字电路设计中一个重要的基本单元，它分为同步FIFO和异步FIFO，所谓同步FIFO，是指读写都是在同一个时钟的驱动下进行的，而异步FIFO读写操作的时钟是分离的，本文主要讲述同步FIFO的实现。 如图，是同步FIFO的一个示意图，它由clk,rst,wr_en,rd_en,full,empty,rdata,wdata等信号构成，其中，full,empty用于指示fifo的状态(空或满)，wr_en,rd_en分别为写使能和读使能信号，在FIFO的设
【钉钉-场景化能力包】CRM系统促进广告平台高效获客
钉钉开发者社区
02-24 1856
服务型企业，公司内部往往存在获客成本高，投资回报率下降，营销难操作，跟进不及时，客户流失严重等问题，这些问题的存在直接关乎到客户体验感及企业的发展，这就需要一套基于CDP客户数据平台与CRM解决方案，可对接主流广告投放平台，完成客户全生命周期的跟进和管理。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

studyingdda

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值