aws_mqtt_agent.h

Go to the documentation of this file.

/*
 * FreeRTOS
 * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */


#ifndef _AWS_MQTT_AGENT_H_
#define _AWS_MQTT_AGENT_H_

/* FreeRTOS includes. */
#include "FreeRTOS.h"

/* MQTT lib includes. */
#include "aws_mqtt_lib.h"

/* Library initialization definition include */
#include "aws_lib_init.h"

typedef void * MQTTAgentHandle_t;

typedef enum
{
    eMQTTAgentSuccess,              
    eMQTTAgentFailure,              
    eMQTTAgentTimeout,              
    eMQTTAgentAPICalledFromCallback 
} MQTTAgentReturnCode_t;

typedef enum
{
    eMQTTAgentPublish,   
    eMQTTAgentDisconnect 
} MQTTAgentEvent_t;

typedef struct MQTTAgentCallbackParams
{
    MQTTAgentEvent_t xMQTTEvent; 
    /* This union is here for future support. */
    union
    {
        MQTTPublishData_t xPublishData; 
    } u;
} MQTTAgentCallbackParams_t;

typedef BaseType_t ( * MQTTAgentCallback_t ) ( void * pvUserData,
                                               const MQTTAgentCallbackParams_t * const pxCallbackParams );

#define mqttagentURL_IS_IP_ADDRESS          0x00000001 
#define mqttagentREQUIRE_TLS                0x00000002 
#define mqttagentUSE_AWS_IOT_ALPN_443       0x00000004 
typedef struct MQTTAgentConnectParams
{
    const char * pcURL;             
    BaseType_t xFlags;              
    BaseType_t xURLIsIPAddress;     
    uint16_t usPort;                
    const uint8_t * pucClientId;    
    uint16_t usClientIdLength;      
    BaseType_t xSecuredConnection;  
    void * pvUserData;              
    MQTTAgentCallback_t pxCallback; 
    char * pcCertificate;           
    uint32_t ulCertificateSize;     
} MQTTAgentConnectParams_t;

typedef struct MQTTAgentSubscribeParams
{
    const uint8_t * pucTopic;                    
    uint16_t usTopicLength;                      
    MQTTQoS_t xQoS;                              
    #if( mqttconfigENABLE_SUBSCRIPTION_MANAGEMENT == 1 )
        void * pvPublishCallbackContext;         
        MQTTPublishCallback_t pxPublishCallback; 
    #endif /* mqttconfigENABLE_SUBSCRIPTION_MANAGEMENT */
} MQTTAgentSubscribeParams_t;

typedef struct MQTTAgentUnsubscribeParams
{
    const uint8_t * pucTopic; 
    uint16_t usTopicLength;   
} MQTTAgentUnsubscribeParams_t;

typedef struct MQTTAgentPublishParams
{
    const uint8_t * pucTopic; 
    uint16_t usTopicLength;   
    MQTTQoS_t xQoS;           
    const void * pvData;      
    uint32_t ulDataLength;    
} MQTTAgentPublishParams_t;

lib_initDECLARE_LIB_INIT( MQTT_AGENT_Init );

MQTTAgentReturnCode_t MQTT_AGENT_Create( MQTTAgentHandle_t * const pxMQTTHandle );

MQTTAgentReturnCode_t MQTT_AGENT_Delete( MQTTAgentHandle_t xMQTTHandle );

MQTTAgentReturnCode_t MQTT_AGENT_Connect( MQTTAgentHandle_t xMQTTHandle,
                                          const MQTTAgentConnectParams_t * const pxConnectParams,
                                          TickType_t xTimeoutTicks );

MQTTAgentReturnCode_t MQTT_AGENT_Disconnect( MQTTAgentHandle_t xMQTTHandle,
                                             TickType_t xTimeoutTicks );

MQTTAgentReturnCode_t MQTT_AGENT_Subscribe( MQTTAgentHandle_t xMQTTHandle,
                                            const MQTTAgentSubscribeParams_t * const pxSubscribeParams,
                                            TickType_t xTimeoutTicks );

MQTTAgentReturnCode_t MQTT_AGENT_Unsubscribe( MQTTAgentHandle_t xMQTTHandle,
                                              const MQTTAgentUnsubscribeParams_t * const pxUnsubscribeParams,
                                              TickType_t xTimeoutTicks );

MQTTAgentReturnCode_t MQTT_AGENT_Publish( MQTTAgentHandle_t xMQTTHandle,
                                          const MQTTAgentPublishParams_t * const pxPublishParams,
                                          TickType_t xTimeoutTicks );

MQTTAgentReturnCode_t MQTT_AGENT_ReturnBuffer( MQTTAgentHandle_t xMQTTHandle,
                                               MQTTBufferHandle_t xBufferHandle );

#endif /* _AWS_MQTT_AGENT_H_ */