aiot_mqtt_api.h

浏览该文件的文档.

#ifndef _AIOT_MQTT_API_H_
#define _AIOT_MQTT_API_H_

#if defined(__cplusplus)
extern "C" {
#endif

#include <stdint.h>

typedef enum {
    AIOT_MQTTRECV_PUB,

    AIOT_MQTTRECV_HEARTBEAT_RESPONSE,

    AIOT_MQTTRECV_SUB_ACK,

    AIOT_MQTTRECV_UNSUB_ACK,

    AIOT_MQTTRECV_PUB_ACK,

    AIOT_MQTTRECV_CON_ACK,

    AIOT_MQTTRECV_DISCONNECT,
} aiot_mqtt_recv_type_t;


typedef enum {
    AIOT_MQTT_VERSION_3_1,
    AIOT_MQTT_VERSION_5_0
} aiot_mqtt_protocol_version;

typedef struct {
    uint16_t len;
    uint8_t  *value;
} len_value_t;

typedef struct {
    len_value_t key;
    len_value_t value;
} user_property_t;

/* MQTT服务端支持的最大的用户属性的数目. */
#define USER_PROPERTY_MAX    (20)

typedef struct {
    uint8_t max_qos;
    uint16_t topic_alias_max;
    uint8_t *assigned_clientid;
    uint32_t max_packet_size;
    uint16_t server_receive_max;
    uint8_t wildcard_subscription_available;
    uint8_t subscription_identifier_available;
    uint8_t shared_subscription_available;
    user_property_t *user_property[USER_PROPERTY_MAX];
} connack_property_t;

typedef struct {
    uint32_t message_expire_interval;
    uint16_t topic_alias;
    len_value_t response_topic;
    len_value_t correlation_data;
    uint32_t subscription_identifier;
    user_property_t *user_property[USER_PROPERTY_MAX];
} pub_property_t;

typedef struct {
    uint16_t topic_alias_max;                               /* topic 别名最大数量 */
    uint16_t client_receive_max;
    user_property_t *user_property[USER_PROPERTY_MAX];      /* 用户属性 */
} conn_property_t;

typedef struct {
    len_value_t *reason_string;
    user_property_t *user_property[USER_PROPERTY_MAX];      /* 用户属性 */
} disconn_property_t;

typedef struct {
    user_property_t *user_property[USER_PROPERTY_MAX];
} sub_property_t;

typedef struct {
    user_property_t *user_property[USER_PROPERTY_MAX];
} unsub_property_t;


typedef struct {
    aiot_mqtt_recv_type_t type;
    union {
        struct {
            uint8_t qos;
            char *topic;
            uint16_t topic_len;
            uint8_t *payload;
            uint32_t payload_len;
            pub_property_t *pub_prop;  /* pub报文中的属性. MQTT 5.0 特性*/
        } pub;
        struct {
            int32_t res;
            uint8_t max_qos;
            uint16_t packet_id;
        } sub_ack;
        struct {
            uint16_t packet_id;
        } unsub_ack;
        struct {
            uint16_t packet_id;
        } pub_ack;

        struct {
            uint8_t reason_code;
            connack_property_t prop;   /* 建连回复报文中的属性. MQTT 5.0 特性 */
        } con_ack;

        struct {
            uint8_t reason_code;
        } server_disconnect;

    } data;
} aiot_mqtt_recv_t;

typedef void (*aiot_mqtt_recv_handler_t)(void *handle, const aiot_mqtt_recv_t *packet, void *userdata);

typedef enum {
    AIOT_MQTTEVT_CONNECT,
    AIOT_MQTTEVT_RECONNECT,
    AIOT_MQTTEVT_DISCONNECT
} aiot_mqtt_event_type_t;

typedef enum {
    AIOT_MQTTDISCONNEVT_NETWORK_DISCONNECT,
    AIOT_MQTTDISCONNEVT_HEARTBEAT_DISCONNECT
} aiot_mqtt_disconnect_event_type_t;

typedef struct {
    aiot_mqtt_event_type_t type;
    union {
        aiot_mqtt_disconnect_event_type_t disconnect;
    } data;
} aiot_mqtt_event_t;

typedef void (*aiot_mqtt_event_handler_t)(void *handle, const aiot_mqtt_event_t *event, void *userdata);

typedef struct {
    char *topic;
    aiot_mqtt_recv_handler_t handler;
    void *userdata;
} aiot_mqtt_topic_map_t;

typedef enum {
    AIOT_MQTTOPT_HOST,

    AIOT_MQTTOPT_PORT,

    AIOT_MQTTOPT_PRODUCT_KEY,

    AIOT_MQTTOPT_DEVICE_NAME,

    AIOT_MQTTOPT_DEVICE_SECRET,

    AIOT_MQTTOPT_EXTEND_CLIENTID,

    AIOT_MQTTOPT_SECURITY_MODE,

    AIOT_MQTTOPT_USERNAME,

    AIOT_MQTTOPT_PASSWORD,

    AIOT_MQTTOPT_CLIENTID,

    AIOT_MQTTOPT_KEEPALIVE_SEC,

    AIOT_MQTTOPT_CLEAN_SESSION,

    AIOT_MQTTOPT_NETWORK_CRED,

    AIOT_MQTTOPT_CONNECT_TIMEOUT_MS,

    AIOT_MQTTOPT_HEARTBEAT_INTERVAL_MS,

    AIOT_MQTTOPT_HEARTBEAT_MAX_LOST,

    AIOT_MQTTOPT_RECONN_ENABLED,

    AIOT_MQTTOPT_RECONN_INTERVAL_MS,

    AIOT_MQTTOPT_SEND_TIMEOUT_MS,

    AIOT_MQTTOPT_RECV_TIMEOUT_MS,

    AIOT_MQTTOPT_REPUB_TIMEOUT_MS,

    AIOT_MQTTOPT_DEINIT_TIMEOUT_MS,

    AIOT_MQTTOPT_RECV_HANDLER,

    AIOT_MQTTOPT_EVENT_HANDLER,

    AIOT_MQTTOPT_APPEND_TOPIC_MAP,

    AIOT_MQTTOPT_REMOVE_TOPIC_MAP,

    AIOT_MQTTOPT_APPEND_REQUESTID,

    AIOT_MQTTOPT_USERDATA,

    AIOT_MQTTOPT_VERSION,

    AIOT_MQTTOPT_ASSIGNED_CLIENTID,

    AIOT_MQTTOPT_FLOW_CONTROL_ENABLED,

    AIOT_MQTTOPT_MAX
} aiot_mqtt_option_t;

void   *aiot_mqtt_init(void);

int32_t aiot_mqtt_setopt(void *handle, aiot_mqtt_option_t option, void *data);

int32_t aiot_mqtt_deinit(void **handle);

int32_t aiot_mqtt_connect(void *handle);

int32_t aiot_mqtt_disconnect(void *handle);

int32_t aiot_mqtt_heartbeat(void *handle);

int32_t aiot_mqtt_process(void *handle);

int32_t aiot_mqtt_pub(void *handle, char *topic, uint8_t *payload, uint32_t payload_len, uint8_t qos);

int32_t aiot_mqtt_sub(void *handle, char *topic, aiot_mqtt_recv_handler_t handler, uint8_t qos, void *userdata);

int32_t aiot_mqtt_unsub(void *handle, char *topic);

int32_t aiot_mqtt_recv(void *handle);

int32_t aiot_mqtt_connect_with_prop(void *handle, conn_property_t *conn_prop);

int32_t aiot_mqtt_pub_with_prop(void *handle, char *topic, uint8_t *payload, uint32_t payload_len, uint8_t qos,
                                pub_property_t *pub_prop);

int32_t aiot_mqtt_disconnect_with_prop(void *handle, uint8_t reason_code, disconn_property_t *disconn_property);

int32_t aiot_mqtt_sub_with_prop(void *handle, char *topic, aiot_mqtt_recv_handler_t handler, uint8_t qos,
                                void *userdata, sub_property_t *sub_prop);

int32_t aiot_mqtt_unsub_with_prop(void *handle, char *topic, unsub_property_t *unsub_prop);

#if defined(__cplusplus)
}
#endif

#endif