aws_iot_mqtt_client.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.
 */

// Based on Eclipse Paho.
/*******************************************************************************
 * Copyright (c) 2014 IBM Corp.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompany this distribution.
 *
 * The Eclipse Public License is available at
 *    http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 *   http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *    Ian Craggs - initial API and implementation and/or initial documentation
 *    Xiang Rong - 442039 Add makefile to Embedded C client
 *******************************************************************************/

#ifndef AWS_IOT_SDK_SRC_IOT_MQTT_CLIENT_H
#define AWS_IOT_SDK_SRC_IOT_MQTT_CLIENT_H

#ifdef __cplusplus
extern "C" {
#endif

/* Library Header files */
#include "stdio.h"
#include "stdbool.h"
#include "stdint.h"
#include "stddef.h"

/* AWS Specific header files */
#include "aws_iot_error.h"
#include "aws_iot_config.h"

/* Platform specific implementation header files */
#include "network_interface.h"
#include "timer_interface.h"

#ifdef _ENABLE_THREAD_SUPPORT_
#include "threads_interface.h"
#endif

#define MAX_PACKET_ID 65535

typedef struct _Client AWS_IoT_Client;

typedef enum QoS {
    QOS0 = 0,
    QOS1 = 1
} QoS;

typedef struct {
    QoS qos;        
    uint8_t isRetained; 
    uint8_t isDup;      
    uint16_t id;        
    void *payload;      
    size_t payloadLen;  
} IoT_Publish_Message_Params;

typedef enum {
    MQTT_3_1_1 = 4    
} MQTT_Ver_t;

typedef struct {
    char struct_id[4];      
    char *pTopicName;       
    uint16_t topicNameLen;      
    char *pMessage;         
    uint16_t msgLen;        
    bool isRetained;        
    QoS qos;            
} IoT_MQTT_Will_Options;
extern const IoT_MQTT_Will_Options iotMqttWillOptionsDefault;

#define IoT_MQTT_Will_Options_Initializer { {'M', 'Q', 'T', 'W'}, NULL, 0, NULL, 0, false, QOS0 }

typedef struct {
    char struct_id[4];          
    MQTT_Ver_t MQTTVersion;         
    char *pClientID;                    
    uint16_t clientIDLen;           
    uint16_t keepAliveIntervalInSec;    
    bool isCleanSession;            
    bool isWillMsgPresent;          
    IoT_MQTT_Will_Options will;     
    char *pUsername;            
    uint16_t usernameLen;           
    char *pPassword;            
    uint16_t passwordLen;           
} IoT_Client_Connect_Params;
extern const IoT_Client_Connect_Params iotClientConnectParamsDefault;

#define IoT_Client_Connect_Params_initializer { {'M', 'Q', 'T', 'C'}, MQTT_3_1_1, NULL, 0, 60, true, false, \
        IoT_MQTT_Will_Options_Initializer, NULL, 0, NULL, 0 }

typedef void (*iot_disconnect_handler)(AWS_IoT_Client *, void *);

typedef struct {
    bool enableAutoReconnect;           
    char *pHostURL;                 
    uint16_t port;                  
    char *pRootCALocation;              
    char *pDeviceCertLocation;          
    char *pDevicePrivateKeyLocation;            
    uint32_t mqttPacketTimeout_ms;          
    uint32_t mqttCommandTimeout_ms;         
    uint32_t tlsHandshakeTimeout_ms;        
    bool isSSLHostnameVerify;           
    iot_disconnect_handler disconnectHandler;   
    void *disconnectHandlerData;            
#ifdef _ENABLE_THREAD_SUPPORT_
    bool isBlockOnThreadLockEnabled;        
#endif
} IoT_Client_Init_Params;
extern const IoT_Client_Init_Params iotClientInitParamsDefault;

#ifdef _ENABLE_THREAD_SUPPORT_
#define IoT_Client_Init_Params_initializer { true, NULL, 0, NULL, NULL, NULL, 2000, 20000, 5000, true, NULL, NULL, false }
#else
#define IoT_Client_Init_Params_initializer { true, NULL, 0, NULL, NULL, NULL, 2000, 20000, 5000, true, NULL, NULL }
#endif

typedef enum _ClientState {
    CLIENT_STATE_INVALID = 0,
    CLIENT_STATE_INITIALIZED = 1,
    CLIENT_STATE_CONNECTING = 2,
    CLIENT_STATE_CONNECTED_IDLE = 3,
    CLIENT_STATE_CONNECTED_YIELD_IN_PROGRESS = 4,
    CLIENT_STATE_CONNECTED_PUBLISH_IN_PROGRESS = 5,
    CLIENT_STATE_CONNECTED_SUBSCRIBE_IN_PROGRESS = 6,
    CLIENT_STATE_CONNECTED_UNSUBSCRIBE_IN_PROGRESS = 7,
    CLIENT_STATE_CONNECTED_RESUBSCRIBE_IN_PROGRESS = 8,
    CLIENT_STATE_CONNECTED_WAIT_FOR_CB_RETURN = 9,
    CLIENT_STATE_DISCONNECTING = 10,
    CLIENT_STATE_DISCONNECTED_ERROR = 11,
    CLIENT_STATE_DISCONNECTED_MANUALLY = 12,
    CLIENT_STATE_PENDING_RECONNECT = 13
} ClientState;

typedef void (*pApplicationHandler_t)(AWS_IoT_Client *pClient, char *pTopicName, uint16_t topicNameLen,
                                      IoT_Publish_Message_Params *pParams, void *pClientData);

typedef struct _MessageHandlers {
    const char *topicName; 
    uint16_t topicNameLen; 
    char resubscribed; 
    QoS qos; 
    pApplicationHandler_t pApplicationHandler; 
    void *pApplicationHandlerData; 
} MessageHandlers;   /* Message handlers are indexed by subscription topic */

typedef struct _ClientStatus {
    ClientState clientState; 
    bool isPingOutstanding; 
    bool isAutoReconnectEnabled; 
} ClientStatus;

typedef struct _ClientData {
    uint16_t nextPacketId; 

    uint32_t packetTimeoutMs; 
    uint32_t commandTimeoutMs; 
    uint16_t keepAliveInterval; 
    uint32_t currentReconnectWaitInterval; 
    uint32_t counterNetworkDisconnected; 

    /* The below values are initialized with the
     * lengths of the TX/RX buffers and never modified
     * afterwards */
    size_t writeBufSize; 
    size_t readBufSize; 
    size_t readBufIndex; 
    unsigned char writeBuf[AWS_IOT_MQTT_TX_BUF_LEN]; 
    unsigned char readBuf[AWS_IOT_MQTT_RX_BUF_LEN]; 

#ifdef _ENABLE_THREAD_SUPPORT_
    bool isBlockOnThreadLockEnabled; 
    IoT_Mutex_t state_change_mutex; 
    IoT_Mutex_t tls_read_mutex; 
    IoT_Mutex_t tls_write_mutex; 
#endif

    IoT_Client_Connect_Params options; 

    MessageHandlers messageHandlers[AWS_IOT_MQTT_NUM_SUBSCRIBE_HANDLERS]; 
    iot_disconnect_handler disconnectHandler; 
    void *disconnectHandlerData; 
} ClientData;

struct _Client {
    Timer pingReqTimer;     
    Timer pingRespTimer;    
    Timer reconnectDelayTimer; 

    ClientStatus clientStatus; 
    ClientData clientData; 
    Network networkStack; 
};

uint16_t aws_iot_mqtt_get_next_packet_id(AWS_IoT_Client *pClient);

IoT_Error_t aws_iot_mqtt_set_connect_params(AWS_IoT_Client *pClient, IoT_Client_Connect_Params *pNewConnectParams);

bool aws_iot_mqtt_is_client_connected(AWS_IoT_Client *pClient);

ClientState aws_iot_mqtt_get_client_state(AWS_IoT_Client *pClient);

bool aws_iot_is_autoreconnect_enabled(AWS_IoT_Client *pClient);

IoT_Error_t aws_iot_mqtt_set_disconnect_handler(AWS_IoT_Client *pClient, iot_disconnect_handler pDisconnectHandler,
                                                void *pDisconnectHandlerData);

IoT_Error_t aws_iot_mqtt_autoreconnect_set_status(AWS_IoT_Client *pClient, bool newStatus);

uint32_t aws_iot_mqtt_get_network_disconnected_count(AWS_IoT_Client *pClient);

void aws_iot_mqtt_reset_network_disconnected_count(AWS_IoT_Client *pClient);

#ifdef __cplusplus
}
#endif

#endif