Update mqtt_wrapper.h

para -> opt
This commit is contained in:
David Lin
2020-04-18 20:27:25 +08:00
committed by GitHub
parent 0aabf39f9a
commit b8d1539df9

View File

@@ -1,5 +1,5 @@
#ifndef _MQTT_WRAPPER_H_
#define _MQTT_WRAPPER_H_
#define _MQTT_WRAPPER_H_
#include <stdio.h>
#include <string.h>
@@ -11,8 +11,8 @@
* @brief connection option
*/
typedef struct mqtt_connect_option_st {
unsigned short keep_alive_interval; /**< keep alive */
unsigned char cleansession; /**< clean session flag */
unsigned short keep_alive_interval; /**< keep alive */
unsigned char cleansession; /**< clean session flag */
char *client_id; /**< client id */
char *username; /**< username */
char *password; /**< password */
@@ -27,7 +27,7 @@ typedef struct mqtt_publish_option_st {
unsigned char dup; /**< DUP flag */
unsigned short id; /**< message id */
char *topic; /**< mqtt topic */
char *topic; /**< mqtt topic */
unsigned char *payload; /**< mqtt payload */
int payload_len; /**< mqtt payload length */
@@ -41,7 +41,7 @@ typedef struct mqtt_subscribe_option_st {
int count; /**< number of members in the topicFilters and reqQos arrays */
unsigned char dup; /**< DUP flag */
unsigned short id; /**< message id */
char *topic; /**< mqtt topic */
char *topic; /**< mqtt topic */
} mqtt_sub_opt_t;
/**
@@ -49,7 +49,7 @@ typedef struct mqtt_subscribe_option_st {
*
* @param[in] host mqtt server(domain name and ip address both are fine).
* @param[in] port mqtt port.
* @param[in] param mqtt connect parameter.
* @param[in] opt mqtt connect parameter.
*
* @return socket id or error if -1.
*/
@@ -59,7 +59,7 @@ int tos_mqtt_connect(char *host, const char *port, mqtt_con_opt_t *opt);
* @brief Publish a message.
*
* @param[in] sock socket id returned by a tos_mqtt_connect.
* @param[in] param mqtt publish parameter.
* @param[in] opt mqtt publish parameter.
*
* @return successful if 0, or error if -1.
*/
@@ -69,7 +69,7 @@ int tos_mqtt_publish(int sock, mqtt_pub_opt_t *opt);
* @brief Subscribe a topic.
*
* @param[in] sock socket id returned by a tos_mqtt_connect.
* @param[in] param mqtt subscribe parameter.
* @param[in] opt mqtt subscribe parameter.
*
* @return successful if 0, or error if -1.
*/