程序员经验分享-hwhale

MQTT客户端应用编程及接口分析

2023-11-19

MQTT客户端应用编程及接口分析

MQTT协议简介

MQTT是一个基于客户端-服务器的消息发布/订阅传输协议。MQTT协议是轻量、简单、开放和易于实现的，这些特点使它适用范围非常广泛。

客户端服务端安装

1.安装

sudo apt-add-repository ppa:mosquitto-dev/mosquitto-ppasudo 
sudo apt-get install mosquitto mosquitto-clients
  1. 测试
mosquitto_sub -h test.mosquitto.org -t "#" -v

如果发现大量的消息滚动刷屏，说明该客户端链接成功

客户端开发包

SDK包下载地址：
eclipse/paho.mqtt.c

编译及生产lib和头文件
cmake -DMAKE_INSTALL_PREFIX=./output
make && make install
在这里插入图片描述

API接口介绍

接口类型 头文件 备注
Paho MQTT C Client Library MQTTClient.h 非现程安全
Paho Asynchronous MQTT C Client Library MQTTAsync.h 线程安全
数据结构
typedef void* MQTTClient;
typedef void* MQTTAsync;
MQTTClient 库接口
  1. MQTTClient_create() : MQTTClient.h
int MQTTClient_create(MQTTClient *handle,
                      const char *serverURI,
                      const char *clientId,
                      int         persistence_type,
                      void *      persistence_context 
)

此函数创建一个 MQTT 客户端，以便连接到指定的服务器并使用指定的持久性存储（参考 MQTTClient_persistence 函数）。另外，与创建函数对应的是销毁函数 MQTTClient_destroy()。

  1. MQTTClient_connect() : MQTTClient.h
int MQTTClient_connect(MQTTClient handle,
                       MQTTClient_connectOptions *options
)

此函数尝试使用指定的选项将以前创建的客户端（调用 MQTTClient_create() 函数）连接到 MQTT 服务器。如果要启用异步消息和状态通知，调用该函数之前必须先调用 MQTTClient_setCallbacks() 函数。

  1. MQTTClient_destroy() : MQTTClient.h
void MQTTClient_destroy(MQTTClient *handle)

此函数用于释放分配给 MQTT 客户端的内存（调用 MQTTClient_create() 函数）。当不再需要客户端时，应该调用它。

4.MQTTClient_disconnect() : MQTTClient.h

int MQTTClient_disconnect(MQTTClient handle, int timeout)

此函数尝试断开客户端与 MQTT 服务器的连接。为了让客户端有时间完成对调用此函数时正在传递的消息的处理，需要指定一个超时期限。当超时期限过期时，即使仍有未完成的消息确认，客户端也会断开连接。下一次客户端连接到同一服务器时，任何未完成的 QoS 1 或 2 消息将根据前一个连接和新连接的清理设置重试（参考 MQTTClient_connectOptions.cleansession 和 MQTTClient_connect()）。

  1. MQTTClient_free() : MQTTClient.h
void MQTTClient_free(void *ptr)

此函数释放 MQTT C Client 库分配的内存，特别是主题名称。当 client 库和应用程序使用不同版本的 C 编译器编译时，在 Windows 上需要这样做。因此，在释放任何 MQTT C Client 分配的内存时，始终使用此函数是一个很好的策略。

  1. MQTTClient_freeMessage() : MQTTClient.h
void MQTTClient_freeMessage(MQTTClient_message ** msg)

此函数释放分配给 MQTT 消息的内存，包括分配给消息有效负载的附加内存。当完全处理消息时，客户端应用程序调用此函数。重要提示：此函数不释放分配给消息主题字符串的内存。客户端应用程序负责使用 MQTTClient_free() 库函数释放此内存。

  1. MQTTClient_isConnected() : MQTTClient.h
int MQTTClient_isConnected(MQTTClient handle)

此函数允许客户端应用程序测试某个 client 与 MQTT 服务器连接情况，已连接返回 true，否则返回 false。

  1. MQTTClient_publish() : MQTTClient.h
int MQTTClient_publish(MQTTClient                handle,
                       const char *              topicName,
                       int                       payloadlen,
                       const void *              payload,
                       int                       qos,
                       int                       retained,
                       MQTTClient_deliveryToken *dt
)

此函数试图将消息发布到给定主题（另请参见 MQTTClient_publishMessage 函数)。当此函数成功返回时，将发出 MQTTClient_deliveryToken。如果客户端应用程序需要测试 QoS1 和 QoS2 消息的成功传递，可以异步或同步地完成（参考 异步与同步客户端应用程序、 MQTTClient_waitForCompletion 和 MQTTClient_deliveryComplete 函数）。

  1. MQTTClient_publishMessage() : MQTTClient.h
int MQTTClient_publishMessage(MQTTClient                handle,
                              const char *              topicName,
                              MQTTClient_message *      msg,
                              MQTTClient_deliveryToken *dt
)

此函数试图将消息发布到给定主题（另请参见 MQTTClient_publish 函数）。当此函数成功返回时，将发出一个 MQTTClient_deliveryToken 令牌。如果客户端应用程序需要测试 QoS1 和 QoS2 消息的成功传递，可以异步或同步地完成（参考 异步与同步客户端应用程序、 MQTTClient_waitForCompletion 和 MQTTClient_deliveryComplete 函数）。

  1. MQTTClient_receive() : MQTTClient.h
int MQTTClient_receive(MQTTClient            handle,
                       char **               topicName,
                       int *                 topicLen,
                       MQTTClient_message ** message,
                       unsigned long         timeout
)

此函数执行传入消息的同步接收。只有当客户端应用程序没有设置回调方法以支持消息的异步接收时，才应该使用它（请参见 异步与同步客户端应用程序 以及 MQTTClient_setCallbacks 函数）。使用此函数可以编写单线程客户端订阅者应用程序。当调用时，此函数将阻塞，直到下一条消息到达或指定的超时过期为止（另请参见 MQTTClient_yield 函数）。

重要提示：应用程序在处理完成后必须释放分配给主题和消息的内存（请参见 MQTTClient_freeMessage 函数）。

  1. MQTTClient_setCallbacks() : MQTTClient.h
int MQTTClient_setCallbacks(MQTTClient                    handle,
                            void *                        context,
                            MQTTClient_connectionLost *   cl,
                            MQTTClient_messageArrived *   ma,
                            MQTTClient_deliveryComplete * dc
)

此函数设置特定客户端的回调函数。如果客户端应用程序不使用特定的回调，请将相关参数设置为 NULL。调用 MQTTClient_setCallbacks() 将客户端置于多线程模式。任何必要的消息确认和状态通信都在后台处理，不需要客户端应用程序的任何干预。更多信息请参见 异步与同步客户端应用程序。

注意：在调用此函数时，MQTT 客户端必须断开连接。

  1. MQTTClient_setDisconnected() : MQTTClient.h
int MQTTClient_setDisconnected(MQTTClient handle,
                               void *     context,
                               MQTTClient_disconnected *co 
)

设置客户端的 MQTTClient_disconnected() 回调函数。如果从服务器接收到断开连接的数据包，将调用这个函数。该函数只对 MQTT V5 及以上版本有效。

  1. MQTTClient_setPublished() : MQTTClient.h
int MQTTClient_setPublished(MQTTClient             handle,
                            void *                 context,
                            MQTTClient_published * co
)
MQTTAsync 库接口
  • MQTTAsync_connect() : MQTTAsync.h
  • MQTTAsync_create() : MQTTAsync.h
  • MQTTAsync_createWithOptions() : MQTTAsync.h
  • MQTTAsync_destroy() : MQTTAsync.h
  • MQTTAsync_disconnect() : MQTTAsync.h
  • MQTTAsync_free() : MQTTAsync.h
  • MQTTAsync_freeMessage() : MQTTAsync.h
  • MQTTAsync_getPendingTokens() : MQTTAsync.h
  • MQTTAsync_getVersionInfo() : MQTTAsync.h
  • MQTTAsync_global_init() : MQTTAsync.h
  • MQTTAsync_isComplete() : MQTTAsync.h
  • MQTTAsync_isConnected() : MQTTAsync.h
  • MQTTAsync_malloc() : MQTTAsync.h
  • MQTTAsync_reconnect() : MQTTAsync.h
  • MQTTAsync_send() : MQTTAsync.h
  • MQTTAsync_sendMessage() : MQTTAsync.h
  • MQTTAsync_setAfterPersistenceRead() : MQTTAsync.h
  • MQTTAsync_setBeforePersistenceWrite() : MQTTAsync.h
  • MQTTAsync_setCallbacks() : MQTTAsync.h
  • MQTTAsync_setConnected() : MQTTAsync.h
  • MQTTAsync_setConnectionLostCallback() : MQTTAsync.h
  • MQTTAsync_setDeliveryCompleteCallback() : MQTTAsync.h
  • MQTTAsync_setDisconnected() : MQTTAsync.h
  • MQTTAsync_setMessageArrivedCallback() : MQTTAsync.h
  • MQTTAsync_setTraceCallback() : MQTTAsync.h
  • MQTTAsync_setTraceLevel() : MQTTAsync.h
  • MQTTAsync_setUpdateConnectOptions() : MQTTAsync.h
  • MQTTAsync_strerror() : MQTTAsync.h
  • MQTTAsync_subscribe() : MQTTAsync.h
  • MQTTAsync_subscribeMany() : MQTTAsync.h
  • MQTTAsync_unsubscribe() : MQTTAsync.h
  • MQTTAsync_unsubscribeMany() : MQTTAsync.h
  • MQTTAsync_waitForCompletion() : MQTTAsync.h
  • MQTTProperties_add() : MQTTProperties.h
  • MQTTProperties_copy() : MQTTProperties.h
  • MQTTProperties_free() : MQTTProperties.h
  • MQTTProperties_getNumericValue() : MQTTProperties.h
  • MQTTProperties_getNumericValueAt() : MQTTProperties.h
  • MQTTProperties_getProperty() : MQTTProperties.h
  • MQTTProperties_getPropertyAt() : MQTTProperties.h
  • MQTTProperties_hasProperty() : MQTTProperties.h
  • MQTTProperties_len() : MQTTProperties.h
  • MQTTProperties_propertyCount() : MQTTProperties.h
  • MQTTProperties_read() : MQTTProperties.h
  • MQTTProperties_write() : MQTTProperties.h
  • MQTTProperty_getType() : MQTTProperties.h
  • MQTTPropertyName() : MQTTProperties.h
  • MQTTReasonCode_toString() : MQTTReasonCodes.h

###代码使用案例

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "MQTTAsync.h"

#if !defined(_WIN32)
#include <unistd.h>
#else
#include <windows.h>
#endif

#if defined(_WRS_KERNEL)
#include <OsWrapper.h>
#endif

#define ADDRESS     "tcp://mqtt.eclipseprojects.io:1883"
#define CLIENTID    "ExampleClientPub"
#define TOPIC       "MQTT Examples"
#define PAYLOAD     "Hello World!"
#define QOS         1
#define TIMEOUT     10000L

int finished = 0;

void connlost(void *context, char *cause)
{
	MQTTAsync client = (MQTTAsync)context;
	MQTTAsync_connectOptions conn_opts = MQTTAsync_connectOptions_initializer;
	int rc;

	printf("\nConnection lost\n");
	printf("     cause: %s\n", cause);

	printf("Reconnecting\n");
	conn_opts.keepAliveInterval = 20;
	conn_opts.cleansession = 1;
	if ((rc = MQTTAsync_connect(client, &conn_opts)) != MQTTASYNC_SUCCESS)
	{
		printf("Failed to start connect, return code %d\n", rc);
 		finished = 1;
	}
}

void onDisconnectFailure(void* context, MQTTAsync_failureData* response)
{
	printf("Disconnect failed\n");
	finished = 1;
}

void onDisconnect(void* context, MQTTAsync_successData* response)
{
	printf("Successful disconnection\n");
	finished = 1;
}

void onSendFailure(void* context, MQTTAsync_failureData* response)
{
	MQTTAsync client = (MQTTAsync)context;
	MQTTAsync_disconnectOptions opts = MQTTAsync_disconnectOptions_initializer;
	int rc;

	printf("Message send failed token %d error code %d\n", response->token, response->code);
	opts.onSuccess = onDisconnect;
	opts.onFailure = onDisconnectFailure;
	opts.context = client;
	if ((rc = MQTTAsync_disconnect(client, &opts)) != MQTTASYNC_SUCCESS)
	{
		printf("Failed to start disconnect, return code %d\n", rc);
		exit(EXIT_FAILURE);
	}
}

void onSend(void* context, MQTTAsync_successData* response)
{
	MQTTAsync client = (MQTTAsync)context;
	MQTTAsync_disconnectOptions opts = MQTTAsync_disconnectOptions_initializer;
	int rc;

	printf("Message with token value %d delivery confirmed\n", response->token);
	opts.onSuccess = onDisconnect;
	opts.onFailure = onDisconnectFailure;
	opts.context = client;
	if ((rc = MQTTAsync_disconnect(client, &opts)) != MQTTASYNC_SUCCESS)
	{
		printf("Failed to start disconnect, return code %d\n", rc);
		exit(EXIT_FAILURE);
	}
}


void onConnectFailure(void* context, MQTTAsync_failureData* response)
{
	printf("Connect failed, rc %d\n", response ? response->code : 0);
	finished = 1;
}


void onConnect(void* context, MQTTAsync_successData* response)
{
	MQTTAsync client = (MQTTAsync)context;
	MQTTAsync_responseOptions opts = MQTTAsync_responseOptions_initializer;
	MQTTAsync_message pubmsg = MQTTAsync_message_initializer;
	int rc;

	printf("Successful connection\n");
	opts.onSuccess = onSend;
	opts.onFailure = onSendFailure;
	opts.context = client;
	pubmsg.payload = PAYLOAD;
	pubmsg.payloadlen = (int)strlen(PAYLOAD);
	pubmsg.qos = QOS;
	pubmsg.retained = 0;
	if ((rc = MQTTAsync_sendMessage(client, TOPIC, &pubmsg, &opts)) != MQTTASYNC_SUCCESS)
	{
		printf("Failed to start sendMessage, return code %d\n", rc);
		exit(EXIT_FAILURE);
	}
}

int messageArrived(void* context, char* topicName, int topicLen, MQTTAsync_message* m)
{
	/* not expecting any messages */
	return 1;
}

int main(int argc, char* argv[])
{
	MQTTAsync client;
	MQTTAsync_connectOptions conn_opts = MQTTAsync_connectOptions_initializer;
	int rc;

	if ((rc = MQTTAsync_create(&client, ADDRESS, CLIENTID, MQTTCLIENT_PERSISTENCE_NONE, NULL)) != MQTTASYNC_SUCCESS)
	{
		printf("Failed to create client object, return code %d\n", rc);
		exit(EXIT_FAILURE);
	}

	if ((rc = MQTTAsync_setCallbacks(client, NULL, connlost, messageArrived, NULL)) != MQTTASYNC_SUCCESS)
	{
		printf("Failed to set callback, return code %d\n", rc);
		exit(EXIT_FAILURE);
	}

	conn_opts.keepAliveInterval = 20;
	conn_opts.cleansession = 1;
	conn_opts.onSuccess = onConnect;
	conn_opts.onFailure = onConnectFailure;
	conn_opts.context = client;
	if ((rc = MQTTAsync_connect(client, &conn_opts)) != MQTTASYNC_SUCCESS)
	{
		printf("Failed to start connect, return code %d\n", rc);
		exit(EXIT_FAILURE);
	}

	printf("Waiting for publication of %s\n"
         "on topic %s for client with ClientID: %s\n",
         PAYLOAD, TOPIC, CLIENTID);
	while (!finished)
		#if defined(_WIN32)
			Sleep(100);
		#else
			usleep(10000L);
		#endif

	MQTTAsync_destroy(&client);
 	return rc;
}
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

Linux

其他

物联网

MQTT客户端应用编程及接口分析 的相关文章

随机推荐

  • 2023智慧城区统一运营白皮书

    本白皮书讨论的 智慧城区 概念 是围绕多种服务业态 特定区域的智慧统一运营管理服务 我们从管理属性 服务业态 管理面积 智慧化程度4个方面对智慧城区分析 把以企业为主导 政府相关部门 社会组织 城区居民等多方协同治理 通过跨业态 跨空间的智

  • matlab中产生随机点,如何在matlab中制作圆形并在里面生成随机点

    这里的另一种选择 Set parameters R 0 5 radius C 3 4 center x y N 50 number of points inside circle generate circle boundary t lin

  • MATLAB2012a下载、安装及破解方法

    下载地址如下 http yunpan cn cyjGMugpDGsse 提取码 32e8 安装步骤如下 1 解压压缩包 打开文件夹内的setup exe 2 选择 不使用Internet安装 3 接受许可协议条款 点击 是 4 选择 我已有

  • Python，燃气火焰检测主要步骤！

    问题描述 在现有的基础上 燃气火焰的检测主要是基于火焰颜色特征 由于燃气火焰不同于普通火焰 其中蓝色分量较多 一般的检测方法准确度不够 故采取其他方法来检测火焰 下面主要介绍4个步骤的思路和主要的 python 代码 解决方案 1 背景差分

  • Python和Matplotlib电磁一维二维三维模拟

    自由空间中传播的脉冲一维模拟 自由空间的时间相关麦克斯韦旋度方程为 E

  • vue3中的readonly

    接受一个对象 不论是响应式还是普通的 或是一个 ref 返回一个原值的只读代理 只读代理是深层的 对任何嵌套属性的访问都将是只读的 它的 ref 解包行为与 reactive 相同 但解包得到的值是只读的 类型 function reado

  • VS2019版本下载详细介绍~

    一 下载地址 第一种方法 VS官网 Visual Studio 2022 IDE 适用于软件开发人员的编程工具 因为官网现在主推2022版本的VS 所以需要选择老旧版本下载 点击下载按钮 向下滑动 该方法需要登录微软账户 才能选择老旧版本的

  • sort的用法

    sort的用法 详细见cplusplus 1 默认的sort函数是按升序排 对应于1 sort a a n 两个参数分别为待排序数组的首地址和尾地址 2 可以自己写一个cmp函数 按特定意图进行排序 对应于2 例如 sort algorit

  • SOIL在VS2015搭建

    这是SOIL库的主页 http www lonesock net soil html 下载好解压 进project vc9 用Vs打开项目 编译记得用release 如果用的OPengl是64位的就用64位编译 不然生成的lib不能用 运行

  • 积分图像(Integral Image)和积分直方图

    积分图像文章推荐 http blog sina com cn s blog 4cb0b54301017wwo html https blog csdn net u010807846 article details 50354000 参考文献

  • vue-router的routes中name属性作用详解

    我们常用vue js和vue router来创建单页应用 vue router能很方便的管理所有的单页组件 我们在定义每个路由的时候会有一个name的属性 如下面代码 通常我们不定义这个属性发现也没有任何问题 那么这个name到底有什么用呢

  • R语言绘图：实现数据点的线性拟合，进行显著性分析（R-squared、p-value）、添加公式到图像

    最近在做关于数据点线性拟合相关的研究 感觉R语言在这方面很方便 而且生成的图片很漂亮 所以在这里和大家分享一下代码 这是别人所绘制的拟合图像 很漂亮 自己也用iris鸢尾花数据集进行一个线性拟合看看 拟合线性模型最基本的函数就是lm 格式为

  • 进阶java大师之路，泛型在hashmap上的灵活运用

    由于 公司的试用的框架上 存在大量的hashmap的创建 产生大量的I O 以及内存的消耗 所以 抽了点时间 看书 effective java 这本书 同时 也从项目的作者 framework 上学习 吸取 最终写出了 符合生产的方案 存

  • 【FreeRTOS】Arduino开发STM32

    0 开发环境 工具 Vscode platformio arduino STM32F103C8T6 USB TTL 引脚连接 STM32直接设置为烧录模式即可 烧录完成后会自动运行程序 1 点灯加串口输出调试 注意事项 每次上传程序前 需要

  • krpano 获取当前场景名称

    var scene krpano get xml scene copy scene name scene get xml scene name set scene name get scene get xml scene name copy

  • element-ui中$confirm弹出框的确定和取消按钮互换位置

    element ui中 confirm弹出框的确定和取消按钮互换位置 1 定位元素 2 找到元素class 通过flex布局 进行位置更换 3 app vue中 进行全局修改 确认窗 取消确认按钮位置更换 el message box wr

  • 如何创建一个私有的Docker仓库

    目录 一 在docker的官方网站中直接创建 二 搭建自己本地的仓库 2 1 搭建自己的本地仓库 2 2 为本地镜像添加认证 2 2 1 添加证书加密功能 2 2 2 添加用户登录认证 三 部署Harbor仓库 总所周知 Docker的强大

  • 【项目实战】代码分支管理工具

    一 分支命名规范 develop Bleeding edge development used for development feature Temporary branch off develop used for feature de

  • 如果能下载或不能上传试试chmod 755放开读写权限

    如果能下载或不能上传试试chmod 755放开读写权限

  • MQTT客户端应用编程及接口分析

    MQTT客户端应用编程及接口分析 MQTT协议简介 MQTT是一个基于客户端 服务器的消息发布 订阅传输协议 MQTT协议是轻量 简单 开放和易于实现的 这些特点使它适用范围非常广泛 客户端服务端安装 1 安装 sudo apt add r

热门标签