aws_iot_mqtt_interface.h

Go to the documentation of this file.

/*
 * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef AWS_IOT_SDK_SRC_IOT_MQTT_INTERFACE_H_
#define AWS_IOT_SDK_SRC_IOT_MQTT_INTERFACE_H_

#include "stddef.h"
#include "stdbool.h"
#include "stdint.h"
#include "aws_iot_error.h"

typedef enum {
    MQTT_3_1 = 3,   
    MQTT_3_1_1 = 4  
} MQTT_Ver_t;

typedef enum {
    QOS_0,  
    QOS_1,  
    QOS_2   
} QoSLevel;

typedef struct {
    const char *pTopicName; 
    const char *pMessage;   
    bool isRetained;        
    QoSLevel qos;           
} MQTTwillOptions;
extern const MQTTwillOptions MQTTwillOptionsDefault;

typedef void (*iot_disconnect_handler)(void);

typedef struct {
    uint8_t enableAutoReconnect;        
    char *pHostURL;                     
    uint16_t port;                      
    char *pRootCALocation;              
    char *pDeviceCertLocation;          
    char *pDevicePrivateKeyLocation;    
    char *pClientID;                    
    char *pUserName;                    
    char *pPassword;                    
    MQTT_Ver_t MQTTVersion;             
    uint16_t KeepAliveInterval_sec;     
    bool isCleansession;                
    bool isWillMsgPresent;              
    MQTTwillOptions will;               
    uint32_t mqttCommandTimeout_ms;     
    uint32_t tlsHandshakeTimeout_ms;    
    bool isSSLHostnameVerify;           
    iot_disconnect_handler disconnectHandler;   
} MQTTConnectParams;
extern const MQTTConnectParams MQTTConnectParamsDefault;

typedef struct {
    QoSLevel qos;           
    bool isRetained;        
    bool isDuplicate;       
    uint16_t id;            
    void *pPayload;         
    uint32_t PayloadLen;    
} MQTTMessageParams;
extern const MQTTMessageParams MQTTMessageParamsDefault;
typedef struct {
    char *pTopicName;                   
    uint16_t TopicNameLen;              
    MQTTMessageParams MessageParams;    
} MQTTCallbackParams;
extern const MQTTCallbackParams MQTTCallbackParamsDefault;

typedef int32_t (*iot_message_handler)(MQTTCallbackParams params);

typedef struct {
    char *pTopic;                   
    QoSLevel qos;                   
    iot_message_handler mHandler;   
} MQTTSubscribeParams;
extern const MQTTSubscribeParams MQTTSubscribeParamsDefault;

typedef struct {
    char *pTopic;                       
    MQTTMessageParams MessageParams;    
} MQTTPublishParams;
extern const MQTTPublishParams MQTTPublishParamsDefault;

IoT_Error_t aws_iot_mqtt_connect(MQTTConnectParams *pParams);

IoT_Error_t aws_iot_mqtt_publish(MQTTPublishParams *pParams);

IoT_Error_t aws_iot_mqtt_subscribe(MQTTSubscribeParams *pParams);

IoT_Error_t aws_iot_mqtt_unsubscribe(char *pTopic);

IoT_Error_t aws_iot_mqtt_attempt_reconnect(void);

IoT_Error_t aws_iot_mqtt_disconnect(void);

IoT_Error_t aws_iot_mqtt_yield(int timeout);

bool aws_iot_is_mqtt_connected(void);

bool aws_iot_is_autoreconnect_enabled(void);

IoT_Error_t aws_iot_mqtt_autoreconnect_set_status(bool value);

typedef IoT_Error_t (*pConnectFunc_t)(MQTTConnectParams *pParams);
typedef IoT_Error_t (*pPublishFunc_t)(MQTTPublishParams *pParams);
typedef IoT_Error_t (*pSubscribeFunc_t)(MQTTSubscribeParams *pParams);
typedef IoT_Error_t (*pUnsubscribeFunc_t)(char *pTopic);
typedef IoT_Error_t (*pDisconnectFunc_t)(void);
typedef IoT_Error_t (*pYieldFunc_t)(int timeout);
typedef bool (*pIsConnectedFunc_t)(void);
typedef bool (*pIsAutoReconnectEnabledFunc_t)(void);
typedef IoT_Error_t (*pReconnectFunc_t)();
typedef IoT_Error_t (*pSetAutoReconnectStatusFunc_t)(bool);
typedef struct{
    pConnectFunc_t connect;             
    pPublishFunc_t publish;             
    pSubscribeFunc_t subscribe;         
    pUnsubscribeFunc_t unsubscribe;     
    pDisconnectFunc_t disconnect;       
    pYieldFunc_t yield;                 
    pIsConnectedFunc_t isConnected;     
    pReconnectFunc_t reconnect;         
    pIsAutoReconnectEnabledFunc_t isAutoReconnectEnabled;   
    pSetAutoReconnectStatusFunc_t setAutoReconnectStatus;   
}MQTTClient_t;


void aws_iot_mqtt_init(MQTTClient_t *pClient);


#endif /* AWS_IOT_SDK_SRC_IOT_MQTT_INTERFACE_H_ */