mosquitto.h 学习

(转自mosquitto.h)

目录

库版本、初始化、清理：

客户端创建、销毁和初始化 

 用户名和密码设置

连接、重连、断连

发布、订阅、取消订阅

回调函数

---

库版本、初始化、清理：

mosquitto_lib_version	可用于获取 mosquitto 库的版本信息。
mosquitto_lib_init	必须在任何其他 mosquitto 函数之前调用。
mosquitto_lib_cleanup	调用与库关联的免费资源。

客户端创建、销毁和初始化 

mosquitto_new	创建一个新的 mosquitto 客户端实例。
mosquitto_destroy	用于释放与 mosquitto 客户端实例关联的内存。
mosquitto_reinitialise	此函数允许重用现有的 mosquitto 客户端。

 用户名和密码设置

mosquitto_username_pw_set

为 mosquitto 实例配置用户名和密码。

连接、重连、断连

mosquitto_connect	连接到 MQTT 代理。
mosquitto_connect_bind	连接到 MQTT 代理。
mosquitto_connect_bind_v5	连接到 MQTT 代理。
mosquitto_connect_async	连接到 MQTT 代理。
mosquitto_connect_bind_async	连接到 MQTT 代理。
mosquitto_connect_srv	连接到 MQTT 代理。
mosquitto_reconnect	重新连接到代理。
mosquitto_reconnect_async	重新连接到代理。
mosquitto_disconnect	断开与代理的连接。
mosquitto_disconnect_v5	断开与代理的连接，并附加了 MQTT 属性。

发布、订阅、取消订阅

mosquitto_publish	发布有关给定主题的消息。
mosquitto_publish_v5	发布有关给定主题的消息，并附加 MQTT 属性。
mosquitto_subscribe	订阅主题。
mosquitto_subscribe_v5	订阅具有附加 MQTT 属性的主题。
mosquitto_subscribe_multiple	订阅多个主题。
mosquitto_unsubscribe	取消订阅主题。
mosquitto_unsubscribe_v5	取消订阅具有附加 MQTT 属性的主题。
mosquitto_unsubscribe_multiple	取消订阅多个主题。

回调函数

mosquitto_connect_callback_set	设置连接回调。
mosquitto_connect_with_flags_callback_set	设置连接回调。
mosquitto_connect_v5_callback_set	设置连接回调。
mosquitto_disconnect_callback_set	设置断开连接回调。
mosquitto_disconnect_v5_callback_set	设置断开连接回调。
mosquitto_publish_callback_set	设置发布回调。
mosquitto_publish_v5_callback_set	设置发布回调。
mosquitto_message_callback_set	设置消息回调。
mosquitto_message_v5_callback_set	设置消息回调。
mosquitto_subscribe_callback_set	设置订阅回调。
mosquitto_subscribe_v5_callback_set	设置订阅回调。
mosquitto_unsubscribe_callback_set	设置退订回调。
mosquitto_unsubscribe_v5_callback_set	设置退订回调。
mosquitto_log_callback_set	设置日志记录回调。

网络环路 

mosquitto_loop_forever	此函数在无限阻塞循环中为您调用 loop（）。
mosquitto_loop_start	这是线程化客户端接口的一部分。
mosquitto_loop_stop	这是线程化客户端接口的一部分。
mosquitto_loop	客户端的主网络环路。

网络循环 

mosquitto_socket	返回 mosquitto 实例的套接字句柄。
mosquitto_want_write	如果有数据准备写入套接字，则返回 true。
mosquitto_threaded_set	用于告诉库应用程序正在使用线程，但不使用mosquitto_loop_start。

TLS支持 

mosquitto_tls_set	配置客户端以获得基于证书的 SSL/TLS 支持。
mosquitto_tls_insecure_set	在服务器证书中配置服务器主机名的验证。
mosquitto_tls_opts_set	设置高级 SSL/TLS 选项。
mosquitto_tls_psk_set	配置客户端以获得基于预共享密钥的 TLS 支持。
mosquitto_ssl_get	检索指向此客户端中用于 TLS 连接的 SSL 结构的指针。

实用程序函数 

mosquitto_strerror	调用以获取 mosquitto 错误号的 const 字符串描述。
mosquitto_connack_string	调用以获取 MQTT 连接结果的 const 字符串描述。
mosquitto_reason_string	调用以获取 MQTT 原因码的 const 字符串描述。
mosquitto_string_to_command	获取表示 MQTT 命令的字符串输入，并将其转换为 libmosquitto 整数表示形式。
mosquitto_sub_topic_tokenise	将主题或订阅字符串标记化为表示主题层次结构的字符串数组。
mosquitto_sub_topic_tokens_free	mosquitto_sub_topic_tokenise中分配的可用内存。
mosquitto_topic_matches_sub	检查主题是否与订阅匹配。
mosquitto_topic_matches_sub2	检查主题是否与订阅匹配。
mosquitto_pub_topic_check	检查用于发布的主题是否有效。
mosquitto_pub_topic_check2	检查用于发布的主题是否有效。
mosquitto_sub_topic_check	检查用于订阅的主题是否有效。
mosquitto_sub_topic_check2	检查用于订阅的主题是否有效。
mosquitto_validate_utf8	帮助程序函数，用于根据 UTF-8 规范和 MQTT 添加的添加项验证 UTF-8 字符串是否有效。