杰理之MQTT接口说明【篇】

网络接口初始化

函数

void NewNetwork(Network *n)

描述

网络接口初始化

参数

n：Network结构体指针

返回值

void

客户端初始化

函数

void MQTTClient(Client *c, Network *network, unsigned int command_timeout_ms, unsigned char *buf, size_t buf_size, unsigned char *readbuf, size_t readbuf_size)

描述

客户端初始化

参数

c：Client结构体指针； network：Network结构体指针； command_timeout_ms：命令超时时间，单位：毫秒； buf：写缓存指针，内存由用户分配； buf_size：写缓存大小； readbuf：读缓存指针，内存由用户分配； readbuf_size：读缓存大小；

返回值

void

网络层连接

函数

int ConnectNetwork(Network *n, char *addr, int port)

描述

网络层连接

参数

n：Network结构体指针; addr：MQTT服务器地址; port：MQTT服务器端口;

返回值

0：成功 其他：失败

MQTT协议层连接

函数

int MQTTConnect(Client *c, MQTTPacket_connectData *options)

描述

MQTT协议层连接

参数

c：Client结构体指针; options：连接参数 ;

返回值

0：成功 其他：失败

主题订阅

函数

int MQTTSubscribe(Client *c, const char *topicFilter, enum QoS qos, messageHandler messageHandler)

描述

向MQTT服务器订阅主题

参数

c：Client结构体指针; topicFilter：订阅的主题; qos：订阅的服务质量等级; messageHandler：接收回调，当订阅的主题有信息下发时，在这里接收;

返回值

0：成功 其他：失败

取消订阅的主题

函数

int MQTTUnsubscribe(Client *c, const char *topicFilter);

描述

向MQTT服务器取消订阅的主题

参数

c：Client结构体指针; topicFilter：想要取消的主题;

返回值

0：成功 其他：失败

发布消息

函数

int MQTTPublish(Client *c, const char *topicName, MQTTMessage *message)

描述

发布消息

参数

c：Client结构体指针； topicFilter：消息发布主题； message：需要发布的消息；

返回值

0：成功 其他：失败

断开MQTT协议层连接

函数

int MQTTDisconnect(Client *c)

描述

断开MQTT协议层连接

参数

c：Client结构体指针; （注意：该接口调用后只是断开MQTT协议层的连接）

返回值

0：成功 其他：失败

阻塞等待数据接收

函数

int MQTTYield(Client *c, int timeout_ms)

描述

阻塞等待数据接收

参数

c：Client结构体指针; timeout_ms: 接收阻塞时间;（注意：该接口需要被循环调用）

返回值

0：成功 其他：失败