azure_iot_mqtt.h

Go to the documentation of this file.

/* Copyright (c) Microsoft Corporation.
 * Licensed under the MIT License. */
 
#ifndef AZURE_IOT_MQTT_H
#define AZURE_IOT_MQTT_H
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
 
#include "azure_iot_mqtt_port.h"
#include "azure_iot_transport_interface.h"
 
 
#define azureiotmqttPACKET_TYPE_CONNECT        ( ( uint8_t ) 0x10U )    
#define azureiotmqttPACKET_TYPE_CONNACK        ( ( uint8_t ) 0x20U )    
#define azureiotmqttPACKET_TYPE_PUBLISH        ( ( uint8_t ) 0x30U )    
#define azureiotmqttPACKET_TYPE_PUBACK         ( ( uint8_t ) 0x40U )    
#define azureiotmqttPACKET_TYPE_PUBREC         ( ( uint8_t ) 0x50U )    
#define azureiotmqttPACKET_TYPE_PUBREL         ( ( uint8_t ) 0x62U )    
#define azureiotmqttPACKET_TYPE_PUBCOMP        ( ( uint8_t ) 0x70U )    
#define azureiotmqttPACKET_TYPE_SUBSCRIBE      ( ( uint8_t ) 0x82U )    
#define azureiotmqttPACKET_TYPE_SUBACK         ( ( uint8_t ) 0x90U )    
#define azureiotmqttPACKET_TYPE_UNSUBSCRIBE    ( ( uint8_t ) 0xA2U )    
#define azureiotmqttPACKET_TYPE_UNSUBACK       ( ( uint8_t ) 0xB0U )    
#define azureiotmqttPACKET_TYPE_PINGREQ        ( ( uint8_t ) 0xC0U )    
#define azureiotmqttPACKET_TYPE_PINGRESP       ( ( uint8_t ) 0xD0U )    
#define azureiotmqttPACKET_TYPE_DISCONNECT     ( ( uint8_t ) 0xE0U )    
#define azureiotmqttGET_PACKET_TYPE( ucType )    ( ( ucType ) & 0xF0U ) 
typedef enum AzureIoTMQTTQoS
{
    eAzureIoTMQTTQoS0 = 0, 
    eAzureIoTMQTTQoS1 = 1, 
    eAzureIoTMQTTQoS2 = 2  
} AzureIoTMQTTQoS_t;
 
typedef enum AzureIoTMQTTSubAckStatus
{
    eMQTTSubAckSuccessQos0 = 0x00, 
    eMQTTSubAckSuccessQos1 = 0x01, 
    eMQTTSubAckSuccessQos2 = 0x02, 
    eMQTTSubAckFailure = 0x80      
} AzureIoTMQTTSubAckStatus_t;
 
typedef enum AzureIoTMQTTResult
{
    eAzureIoTMQTTSuccess = 0,      
    eAzureIoTMQTTBadParameter,     
    eAzureIoTMQTTNoMemory,         
    eAzureIoTMQTTSendFailed,       
    eAzureIoTMQTTRecvFailed,       
    eAzureIoTMQTTBadResponse,      
    eAzureIoTMQTTServerRefused,    
    eAzureIoTMQTTNoDataAvailable,  
    eAzureIoTMQTTIllegalState,     
    eAzureIoTMQTTStateCollision,   
    eAzureIoTMQTTKeepAliveTimeout, 
    eAzureIoTMQTTFailed            
} AzureIoTMQTTResult_t;
 
typedef struct AzureIoTMQTTConnectInfo
{
    bool xCleanSession;
 
    uint16_t usKeepAliveSeconds;
 
    const uint8_t * pcClientIdentifier;
 
    uint16_t usClientIdentifierLength;
 
    const uint8_t * pcUserName;
 
    uint16_t usUserNameLength;
 
    const uint8_t * pcPassword;
 
    uint16_t usPasswordLength;
} AzureIoTMQTTConnectInfo_t;
 
typedef struct AzureIoTMQTTSubscribeInfo
{
    AzureIoTMQTTQoS_t xQoS;
 
    const uint8_t * pcTopicFilter;
 
    uint16_t usTopicFilterLength;
} AzureIoTMQTTSubscribeInfo_t;
 
typedef struct AzureIoTMQTTPublishInfo
{
    AzureIoTMQTTQoS_t xQOS;
 
    bool xRetain;
 
    bool xDup;
 
    const uint8_t * pcTopicName;
 
    uint16_t usTopicNameLength;
 
    const void * pvPayload;
 
    size_t xPayloadLength;
} AzureIoTMQTTPublishInfo_t;
 
typedef struct AzureIoTMQTTDeserializedInfo
{
    uint16_t usPacketIdentifier;                 
    AzureIoTMQTTPublishInfo_t * pxPublishInfo;   
    AzureIoTMQTTResult_t xDeserializationResult; 
} AzureIoTMQTTDeserializedInfo_t;
 
typedef struct AzureIoTMQTTPacketInfo
{
    uint8_t ucType;
 
    uint8_t * pucRemainingData;
 
    size_t xRemainingLength;
} AzureIoTMQTTPacketInfo_t;
 
typedef AzureIoTMQTT_t * AzureIoTMQTTHandle_t;
 
typedef uint32_t ( * AzureIoTMQTTGetCurrentTimeFunc_t )( void );
 
typedef void ( * AzureIoTMQTTEventCallback_t )( AzureIoTMQTTHandle_t pContext,
                                                struct AzureIoTMQTTPacketInfo * pxPacketInfo,
                                                struct AzureIoTMQTTDeserializedInfo * pxDeserializedInfo );
 
 
AzureIoTMQTTResult_t AzureIoTMQTT_Init( AzureIoTMQTTHandle_t xContext,
                                        const AzureIoTTransportInterface_t * pxTransportInterface,
                                        AzureIoTMQTTGetCurrentTimeFunc_t xGetTimeFunction,
                                        AzureIoTMQTTEventCallback_t xUserCallback,
                                        uint8_t * pucNetworkBuffer,
                                        size_t xNetworkBufferLength );
 
 
AzureIoTMQTTResult_t AzureIoTMQTT_Connect( AzureIoTMQTTHandle_t xContext,
                                           const AzureIoTMQTTConnectInfo_t * pxConnectInfo,
                                           const AzureIoTMQTTPublishInfo_t * pxWillInfo,
                                           uint32_t ulMilliseconds,
                                           bool * pxSessionPresent );
 
AzureIoTMQTTResult_t AzureIoTMQTT_Subscribe( AzureIoTMQTTHandle_t xContext,
                                             const AzureIoTMQTTSubscribeInfo_t * pxSubscriptionList,
                                             size_t xSubscriptionCount,
                                             uint16_t usPacketId );
 
AzureIoTMQTTResult_t AzureIoTMQTT_Publish( AzureIoTMQTTHandle_t xContext,
                                           const AzureIoTMQTTPublishInfo_t * pxPublishInfo,
                                           uint16_t usPacketId );
 
AzureIoTMQTTResult_t AzureIoTMQTT_Ping( AzureIoTMQTTHandle_t xContext );
 
AzureIoTMQTTResult_t AzureIoTMQTT_Unsubscribe( AzureIoTMQTTHandle_t xContext,
                                               const AzureIoTMQTTSubscribeInfo_t * pxSubscriptionList,
                                               size_t xSubscriptionCount,
                                               uint16_t usPacketId );
 
AzureIoTMQTTResult_t AzureIoTMQTT_Disconnect( AzureIoTMQTTHandle_t xContext );
 
 
AzureIoTMQTTResult_t AzureIoTMQTT_ProcessLoop( AzureIoTMQTTHandle_t xContext,
                                               uint32_t ulMilliseconds );
 
uint16_t AzureIoTMQTT_GetPacketId( AzureIoTMQTTHandle_t xContext );
 
 
AzureIoTMQTTResult_t AzureIoTMQTT_GetSubAckStatusCodes( const AzureIoTMQTTPacketInfo_t * pxSubackPacket,
                                                        uint8_t ** ppucPayloadStart,
                                                        size_t * pxPayloadSize );
 
#endif /* AZURE_IOT_MQTT_H */