aiot_mqtt_api.h

浏览该文件的文档.

#ifndef _AIOT_MQTT_API_H_
#define _AIOT_MQTT_API_H_

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

#include <stdint.h>
#include "aiot_mqtt_props_api.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;

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

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;
            mqtt_properties_t *props;
        } pub;
        struct {
            int32_t res;
            uint8_t max_qos;
            uint16_t packet_id;
            mqtt_properties_t *props;
        } sub_ack;
        struct {
            uint16_t packet_id;
            mqtt_properties_t *props;
        } unsub_ack;
        struct {
            uint16_t packet_id;
            mqtt_properties_t *props;
        } pub_ack;

        struct {
            uint8_t reason_code;
            mqtt_properties_t *props;
        } con_ack;

        struct {
            uint8_t reason_code;
            mqtt_properties_t *props;
        } 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_MAX_REPUB_NUM,

    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);

typedef struct {
    char *topic;
    uint8_t *payload;
    uint32_t payload_len;
    uint8_t qos;
    uint8_t retain;
    mqtt_properties_t *props;
} will_message_t;

int32_t aiot_mqtt_connect_v5(void *handle, will_message_t *will_message, mqtt_properties_t *conn_prop);

int32_t aiot_mqtt_pub_v5(void *handle, char *topic, uint8_t *payload, uint32_t payload_len, uint8_t qos,
                                uint8_t retain, mqtt_properties_t *pub_prop);

int32_t aiot_mqtt_disconnect_v5(void *handle, uint8_t reason_code, mqtt_properties_t *disconn_property);

typedef struct {
    uint8_t retain_handling;
    uint8_t retain_as_publish;
    uint8_t no_local;
    uint8_t qos;
} sub_options_t;

int32_t aiot_mqtt_sub_v5(void *handle, char *topic, sub_options_t *opts, aiot_mqtt_recv_handler_t handler,
                                void *userdata, mqtt_properties_t *sub_prop);

int32_t aiot_mqtt_unsub_v5(void *handle, char *topic, mqtt_properties_t *unsub_prop);

#if defined(__cplusplus)
}
#endif

#endif