core_mqtt_serializer.h

Go to the documentation of this file.

/*
 * coreMQTT
 * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * 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.
 */
 
#ifndef CORE_MQTT_SERIALIZER_H
#define CORE_MQTT_SERIALIZER_H
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON */
 
#include "transport_interface.h"
 
/* MQTT packet types. */
 
#define MQTT_PACKET_TYPE_CONNECT        ( ( uint8_t ) 0x10U )  
#define MQTT_PACKET_TYPE_CONNACK        ( ( uint8_t ) 0x20U )  
#define MQTT_PACKET_TYPE_PUBLISH        ( ( uint8_t ) 0x30U )  
#define MQTT_PACKET_TYPE_PUBACK         ( ( uint8_t ) 0x40U )  
#define MQTT_PACKET_TYPE_PUBREC         ( ( uint8_t ) 0x50U )  
#define MQTT_PACKET_TYPE_PUBREL         ( ( uint8_t ) 0x62U )  
#define MQTT_PACKET_TYPE_PUBCOMP        ( ( uint8_t ) 0x70U )  
#define MQTT_PACKET_TYPE_SUBSCRIBE      ( ( uint8_t ) 0x82U )  
#define MQTT_PACKET_TYPE_SUBACK         ( ( uint8_t ) 0x90U )  
#define MQTT_PACKET_TYPE_UNSUBSCRIBE    ( ( uint8_t ) 0xA2U )  
#define MQTT_PACKET_TYPE_UNSUBACK       ( ( uint8_t ) 0xB0U )  
#define MQTT_PACKET_TYPE_PINGREQ        ( ( uint8_t ) 0xC0U )  
#define MQTT_PACKET_TYPE_PINGRESP       ( ( uint8_t ) 0xD0U )  
#define MQTT_PACKET_TYPE_DISCONNECT     ( ( uint8_t ) 0xE0U )  
#define MQTT_PACKET_TYPE_AUTH           ( ( uint8_t ) 0xF0U )  
#define MQTT_PUBLISH_ACK_PACKET_SIZE    ( 4UL )
 
#define MQTT_SUBSCRIBE_QOS1                    ( 0U ) 
#define MQTT_SUBSCRIBE_QOS2                    ( 1U ) 
#define MQTT_SUBSCRIBE_NO_LOCAL                ( 2U ) 
#define MQTT_SUBSCRIBE_RETAIN_AS_PUBLISHED     ( 3U ) 
#define MQTT_SUBSCRIBE_RETAIN_HANDLING1        ( 4U ) 
#define MQTT_SUBSCRIBE_RETAIN_HANDLING2        ( 5U ) 
/* CONNECT PROPERTIES. */
 
#define MQTT_SESSION_EXPIRY_ID      ( 0x11U )
 
#define MQTT_RECEIVE_MAX_ID         ( 0x21U )
 
#define MQTT_MAX_PACKET_SIZE_ID     ( 0x27U )
 
#define MQTT_TOPIC_ALIAS_MAX_ID     ( 0x22U )
 
#define MQTT_REQUEST_RESPONSE_ID    ( 0x19U )
 
#define MQTT_REQUEST_PROBLEM_ID     ( 0x17U )
 
#define MQTT_USER_PROPERTY_ID       ( 0x26U )
 
#define MQTT_AUTH_METHOD_ID         ( 0x15U )
 
#define MQTT_AUTH_DATA_ID           ( 0x16U )
 
 
/* Publish properties. */
 
#define MQTT_WILL_DELAY_ID          ( 0x18U )
 
#define MQTT_PAYLOAD_FORMAT_ID      ( 0x01U )
 
#define MQTT_MSG_EXPIRY_ID          ( 0x02U )
 
#define MQTT_CONTENT_TYPE_ID        ( 0x03U )
 
#define MQTT_RESPONSE_TOPIC_ID      ( 0x08U )
 
#define MQTT_CORRELATION_DATA_ID    ( 0x09U )
 
#define MQTT_TOPIC_ALIAS_ID         ( 0x23U )
 
 
/* CONNACK PROPERTIES. */
 
#define MQTT_MAX_QOS_ID              ( 0x24U )
 
#define MQTT_RETAIN_AVAILABLE_ID     ( 0x25U )
 
#define MQTT_ASSIGNED_CLIENT_ID      ( 0x12U )
 
#define MQTT_REASON_STRING_ID        ( 0x1FU )
 
#define MQTT_WILDCARD_ID             ( 0x28U )
 
#define MQTT_SUB_AVAILABLE_ID        ( 0x29U )
 
#define MQTT_SHARED_SUB_ID           ( 0x2AU )
 
#define MQTT_SERVER_KEEP_ALIVE_ID    ( 0x13U )
 
#define MQTT_RESPONSE_INFO_ID    ( 0x1AU )
 
#define MQTT_SERVER_REF_ID       ( 0x1CU )
 
#define MQTT_SUBSCRIPTION_ID_ID          ( 0x0BU )
 
/* Structures defined in this file. */
struct MQTTFixedBuffer;
struct MQTTConnectInfo;
struct MQTTSubscribeInfo;
struct MQTTPublishInfo;
struct MQTTPacketInfo;
 
typedef enum MQTTStatus
{
    MQTTSuccess = 0,                
    MQTTBadParameter,               
    MQTTNoMemory,                   
    MQTTSendFailed,                 
    MQTTRecvFailed,                 
    MQTTBadResponse,                
    MQTTServerRefused,              
    MQTTNoDataAvailable,            
    MQTTIllegalState,               
    MQTTStateCollision,             
    MQTTKeepAliveTimeout,           
    MQTTNeedMoreBytes,              
    MQTTEndOfProperties,            
    MQTTStatusConnected,            
    MQTTStatusNotConnected,         
    MQTTStatusDisconnectPending,    
    MQTTPublishStoreFailed,         
    MQTTPublishRetrieveFailed,       
    MQTTEventCallbackFailed         
} MQTTStatus_t;
 
typedef enum MQTTQoS
{
    MQTTQoS0 = 0, 
    MQTTQoS1 = 1, 
    MQTTQoS2 = 2  
} MQTTQoS_t;
 
typedef struct MQTTFixedBuffer
{
    uint8_t * pBuffer; 
    size_t size;       
} MQTTFixedBuffer_t;
 
typedef struct MQTTConnectInfo
{
    bool cleanSession;
 
    uint16_t keepAliveSeconds;
 
    const char * pClientIdentifier;
 
    size_t clientIdentifierLength;
 
    const char * pUserName;
 
    size_t userNameLength;
 
    const char * pPassword;
 
    size_t passwordLength;
} MQTTConnectInfo_t;
 
typedef enum MQTTRetainHandling{
    retainSendOnSub = 0, 
    retainSendOnSubIfNotPresent = 1,  
    retainDoNotSendonSub = 2 
}MQTTRetainHandling_t;
 
typedef struct MQTTSubscribeInfo
{
    MQTTQoS_t qos;
 
    const char * pTopicFilter;
 
    size_t topicFilterLength;
    bool noLocalOption;
 
    bool retainAsPublishedOption;
 
    MQTTRetainHandling_t retainHandlingOption;
 
} MQTTSubscribeInfo_t;
 
typedef struct MQTTPublishInfo
{
    MQTTQoS_t qos;
 
    bool retain;
 
    bool dup;
 
    const char * pTopicName;
 
    size_t topicNameLength;
 
    const void * pPayload;
 
    size_t payloadLength;
 
    size_t propertyLength;
 
} MQTTPublishInfo_t;
 
typedef struct MQTTPacketInfo
{
    uint8_t type;
 
    uint8_t * pRemainingData;
 
    uint32_t remainingLength;
 
    size_t headerLength;
} MQTTPacketInfo_t;
 
typedef struct MQTTPropBuilder
{
    uint8_t * pBuffer;           
    size_t bufferLength;         
    size_t currentIndex;       
    uint32_t fieldSet;           
} MQTTPropBuilder_t;
 
typedef struct MQTTReasonCodeInfo
{
    const uint8_t * reasonCode;
 
    size_t reasonCodeLength;
 
} MQTTReasonCodeInfo_t;
 
typedef struct MQTTConnectProperties
{
    uint32_t sessionExpiry;
 
    uint16_t receiveMax;
 
    uint32_t maxPacketSize;
 
    uint16_t topicAliasMax;
 
    bool  requestResponseInfo;
 
    bool  requestProblemInfo;
 
    uint16_t serverReceiveMax;
 
    uint8_t serverMaxQos;
 
    uint8_t retainAvailable;
 
    uint32_t serverMaxPacketSize;
 
    uint16_t serverTopicAliasMax;
 
    uint8_t isWildcardAvailable;
 
    uint8_t isSubscriptionIdAvailable;
 
    uint8_t isSharedAvailable;
 
    uint16_t serverKeepAlive;
 
 
} MQTTConnectionProperties_t;
 
typedef enum MQTTSuccessFailReasonCode
{
    /* PUBACK reason codes */
    MQTT_REASON_PUBACK_SUCCESS = 0x00U,                    
    MQTT_REASON_PUBACK_NO_MATCHING_SUBSCRIBERS = 0x10U,    
    MQTT_REASON_PUBACK_UNSPECIFIED_ERROR = 0x80U,         
    MQTT_REASON_PUBACK_IMPLEMENTATION_SPECIFIC_ERROR = 0x83U, 
    MQTT_REASON_PUBACK_NOT_AUTHORIZED = 0x87U,            
    MQTT_REASON_PUBACK_TOPIC_NAME_INVALID = 0x90U,        
    MQTT_REASON_PUBACK_PACKET_IDENTIFIER_IN_USE = 0x91U,  
    MQTT_REASON_PUBACK_QUOTA_EXCEEDED = 0x97U,            
    MQTT_REASON_PUBACK_PAYLOAD_FORMAT_INVALID = 0x99U,    
    /* PUBREC reason codes */
    MQTT_REASON_PUBREC_SUCCESS = 0x00U,                   
    MQTT_REASON_PUBREC_NO_MATCHING_SUBSCRIBERS = 0x10U,   
    MQTT_REASON_PUBREC_UNSPECIFIED_ERROR = 0x80U,        
    MQTT_REASON_PUBREC_IMPLEMENTATION_SPECIFIC_ERROR = 0x83U, 
    MQTT_REASON_PUBREC_NOT_AUTHORIZED = 0x87U,           
    MQTT_REASON_PUBREC_TOPIC_NAME_INVALID = 0x90U,       
    MQTT_REASON_PUBREC_PACKET_IDENTIFIER_IN_USE = 0x91U, 
    MQTT_REASON_PUBREC_QUOTA_EXCEEDED = 0x97U,           
    MQTT_REASON_PUBREC_PAYLOAD_FORMAT_INVALID = 0x99U,   
    /* PUBREL reason codes */
    MQTT_REASON_PUBREL_SUCCESS = 0x00U,                  
    MQTT_REASON_PUBREL_PACKET_IDENTIFIER_NOT_FOUND = 0x92U, 
    /* PUBCOMP reason codes */
    MQTT_REASON_PUBCOMP_SUCCESS = 0x00U,                 
    MQTT_REASON_PUBCOMP_PACKET_IDENTIFIER_NOT_FOUND = 0x92U, 
    /* CONNACK reason codes */
    MQTT_REASON_CONNACK_SUCCESS = 0x00U,                 
    MQTT_REASON_CONNACK_UNSPECIFIED_ERROR = 0x80U,       
    MQTT_REASON_CONNACK_MALFORMED_PACKET = 0x81U,        
    MQTT_REASON_CONNACK_PROTOCOL_ERROR = 0x82U,          
    MQTT_REASON_CONNACK_IMPLEMENTATION_SPECIFIC_ERROR = 0x83U, 
    MQTT_REASON_CONNACK_UNSUPPORTED_PROTOCOL_VERSION = 0x84U, 
    MQTT_REASON_CONNACK_CLIENT_IDENTIFIER_NOT_VALID = 0x85U, 
    MQTT_REASON_CONNACK_BAD_USER_NAME_OR_PASSWORD = 0x86U, 
    MQTT_REASON_CONNACK_NOT_AUTHORIZED = 0x87U,          
    MQTT_REASON_CONNACK_SERVER_UNAVAILABLE = 0x88U,      
    MQTT_REASON_CONNACK_SERVER_BUSY = 0x89U,             
    MQTT_REASON_CONNACK_BANNED = 0x8AU,                  
    MQTT_REASON_CONNACK_BAD_AUTHENTICATION_METHOD = 0x8CU, 
    MQTT_REASON_CONNACK_TOPIC_NAME_INVALID = 0x90U,      
    MQTT_REASON_CONNACK_PACKET_TOO_LARGE = 0x95U,        
    MQTT_REASON_CONNACK_QUOTA_EXCEEDED = 0x97U,          
    MQTT_REASON_CONNACK_PAYLOAD_FORMAT_INVALID = 0x99U,  
    MQTT_REASON_CONNACK_RETAIN_NOT_SUPPORTED = 0x9AU,    
    MQTT_REASON_CONNACK_QOS_NOT_SUPPORTED = 0x9BU,       
    MQTT_REASON_CONNACK_USE_ANOTHER_SERVER = 0x9CU,      
    MQTT_REASON_CONNACK_SERVER_MOVED = 0x9DU,            
    MQTT_REASON_CONNACK_CONNECTION_RATE_EXCEEDED = 0x9FU, 
    /* SUBACK reason codes */
    MQTT_REASON_SUBACK_GRANTED_QOS0 = 0x00U,             
    MQTT_REASON_SUBACK_GRANTED_QOS1 = 0x01U,             
    MQTT_REASON_SUBACK_GRANTED_QOS2 = 0x02U,             
    MQTT_REASON_SUBACK_UNSPECIFIED_ERROR = 0x80U,        
    MQTT_REASON_SUBACK_IMPLEMENTATION_SPECIFIC_ERROR = 0x83U, 
    MQTT_REASON_SUBACK_NOT_AUTHORIZED = 0x87U,           
    MQTT_REASON_SUBACK_TOPIC_FILTER_INVALID = 0x8FU,     
    MQTT_REASON_SUBACK_PACKET_IDENTIFIER_IN_USE = 0x91U, 
    MQTT_REASON_SUBACK_QUOTA_EXCEEDED = 0x97U,           
    MQTT_REASON_SUBACK_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED = 0x9EU, 
    MQTT_REASON_SUBACK_SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED = 0xA1U, 
    MQTT_REASON_SUBACK_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED = 0xA2U, 
    /* UNSUBACK reason codes */
    MQTT_REASON_UNSUBACK_SUCCESS = 0x00U,                
    MQTT_REASON_UNSUBACK_NO_SUBSCRIPTION_EXISTED = 0x11U, 
    MQTT_REASON_UNSUBACK_UNSPECIFIED_ERROR = 0x80U,      
    MQTT_REASON_UNSUBACK_IMPLEMENTATION_SPECIFIC_ERROR = 0x83U, 
    MQTT_REASON_UNSUBACK_NOT_AUTHORIZED = 0x87U,         
    MQTT_REASON_UNSUBACK_TOPIC_FILTER_INVALID = 0x8FU,   
    MQTT_REASON_UNSUBACK_PACKET_IDENTIFIER_IN_USE = 0x91U, 
    /* DISCONNECT reason codes */
    MQTT_REASON_DISCONNECT_NORMAL_DISCONNECTION = 0x00U,  
    MQTT_REASON_DISCONNECT_DISCONNECT_WITH_WILL_MESSAGE = 0x04U, 
    MQTT_REASON_DISCONNECT_UNSPECIFIED_ERROR = 0x80U,     
    MQTT_REASON_DISCONNECT_MALFORMED_PACKET = 0x81U,      
    MQTT_REASON_DISCONNECT_PROTOCOL_ERROR = 0x82U,        
    MQTT_REASON_DISCONNECT_IMPLEMENTATION_SPECIFIC_ERROR = 0x83U, 
    MQTT_REASON_DISCONNECT_NOT_AUTHORIZED = 0x87U,        
    MQTT_REASON_DISCONNECT_SERVER_BUSY = 0x89U,           
    MQTT_REASON_DISCONNECT_SERVER_SHUTTING_DOWN = 0x8BU,  
    MQTT_REASON_DISCONNECT_BAD_AUTHENTICATION_METHOD = 0x8CU, 
    MQTT_REASON_DISCONNECT_KEEP_ALIVE_TIMEOUT = 0x8DU,    
    MQTT_REASON_DISCONNECT_SESSION_TAKEN_OVER = 0x8EU,    
    MQTT_REASON_DISCONNECT_TOPIC_FILTER_INVALID = 0x8FU,  
    MQTT_REASON_DISCONNECT_TOPIC_NAME_INVALID = 0x90U,    
    MQTT_REASON_DISCONNECT_RECEIVE_MAXIMUM_EXCEEDED = 0x93U, 
    MQTT_REASON_DISCONNECT_TOPIC_ALIAS_INVALID = 0x94U,   
    MQTT_REASON_DISCONNECT_PACKET_TOO_LARGE = 0x95U,      
    MQTT_REASON_DISCONNECT_MESSAGE_RATE_TOO_HIGH = 0x96U, 
    MQTT_REASON_DISCONNECT_QUOTA_EXCEEDED = 0x97U,        
    MQTT_REASON_DISCONNECT_ADMINISTRATIVE_ACTION = 0x98U,  
    MQTT_REASON_DISCONNECT_PAYLOAD_FORMAT_INVALID = 0x99U, 
    MQTT_REASON_DISCONNECT_RETAIN_NOT_SUPPORTED = 0x9AU,   
    MQTT_REASON_DISCONNECT_QOS_NOT_SUPPORTED = 0x9BU,      
    MQTT_REASON_DISCONNECT_USE_ANOTHER_SERVER = 0x9CU,     
    MQTT_REASON_DISCONNECT_SERVER_MOVED = 0x9DU,           
    MQTT_REASON_DISCONNECT_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED = 0x9EU, 
    MQTT_REASON_DISCONNECT_CONNECTION_RATE_EXCEEDED = 0x9FU, 
    MQTT_REASON_DISCONNECT_MAXIMUM_CONNECT_TIME = 0xA0U,    
    MQTT_REASON_DISCONNECT_SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED = 0xA1U, 
    MQTT_REASON_DISCONNECT_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED = 0xA2U,    
    MQTT_INVALID_REASON_CODE = 0xFF 
} MQTTSuccessFailReasonCode_t;
 
typedef struct MQTTUserProperty
{
    const char * pKey;
    size_t keyLength;
    const char * pValue;
    size_t valueLength;
} MQTTUserProperty_t;
 
typedef enum MQTTSubscriptionType
{
    MQTT_TYPE_SUBSCRIBE,  
    MQTT_TYPE_UNSUBSCRIBE 
} MQTTSubscriptionType_t;
 
/* @[declare_mqtt_getconnectpacketsize] */
MQTTStatus_t MQTT_GetConnectPacketSize( const MQTTConnectInfo_t * pConnectInfo,
                                        const MQTTPublishInfo_t * pWillInfo,
                                        const MQTTPropBuilder_t * pConnectProperties,
                                        const MQTTPropBuilder_t * pWillProperties,
                                        uint32_t * pRemainingLength,
                                        uint32_t * pPacketSize );
/* @[declare_mqtt_getconnectpacketsize] */
 
/* @[declare_mqtt_serializeconnect] */
MQTTStatus_t MQTT_SerializeConnect( const MQTTConnectInfo_t * pConnectInfo,
                                    const MQTTPublishInfo_t * pWillInfo,
                                    const MQTTPropBuilder_t * pConnectProperties,
                                    const MQTTPropBuilder_t * pWillProperties,
                                    uint32_t remainingLength,
                                    const MQTTFixedBuffer_t * pFixedBuffer );
/* @[declare_mqtt_serializeconnect] */
 
/* @[declare_mqtt_getsubscribepacketsize] */
MQTTStatus_t MQTT_GetSubscribePacketSize( const MQTTSubscribeInfo_t * pSubscriptionList,
                                          size_t subscriptionCount,
                                          const MQTTPropBuilder_t * pSubscribeProperties,
                                          uint32_t * pRemainingLength,
                                          uint32_t * pPacketSize,
                                          uint32_t maxPacketSize );
/* @[declare_mqtt_getsubscribepacketsize] */
 
/* @[declare_mqtt_serializesubscribe] */
MQTTStatus_t MQTT_SerializeSubscribe( const MQTTSubscribeInfo_t * pSubscriptionList,
                                      size_t subscriptionCount,
                                      const MQTTPropBuilder_t * pSubscribeProperties,
                                      uint16_t packetId,
                                      uint32_t remainingLength,
                                      const MQTTFixedBuffer_t * pFixedBuffer );
/* @[declare_mqtt_serializesubscribe] */
 
/* @[declare_mqtt_getunsubscribepacketsize] */
MQTTStatus_t MQTT_GetUnsubscribePacketSize( const MQTTSubscribeInfo_t * pSubscriptionList,
                                            size_t subscriptionCount,
                                            const MQTTPropBuilder_t * pUnsubscribeProperties,
                                            uint32_t * pRemainingLength,
                                            uint32_t * pPacketSize,
                                            uint32_t maxPacketSize );
/* @[declare_mqtt_getunsubscribepacketsize] */
 
/* @[declare_mqtt_serializeunsubscribe] */
MQTTStatus_t MQTT_SerializeUnsubscribe( const MQTTSubscribeInfo_t * pSubscriptionList,
                                        size_t subscriptionCount,
                                        const MQTTPropBuilder_t * pUnsubscribeProperties,
                                        uint16_t packetId,
                                        uint32_t remainingLength,
                                        const MQTTFixedBuffer_t * pFixedBuffer );
/* @[declare_mqtt_serializeunsubscribe] */
 
/* @[declare_mqtt_getpublishpacketsize] */
MQTTStatus_t MQTT_GetPublishPacketSize( const MQTTPublishInfo_t * pPublishInfo,
                                        const MQTTPropBuilder_t * pPublishProperties,
                                        uint32_t * pRemainingLength,
                                        uint32_t * pPacketSize,
                                        uint32_t maxPacketSize );
/* @[declare_mqtt_getpublishpacketsize] */
 
/* @[declare_mqtt_serializepublish] */
MQTTStatus_t MQTT_SerializePublish( const MQTTPublishInfo_t * pPublishInfo,
                                    const MQTTPropBuilder_t * pPublishProperties,
                                    uint16_t packetId,
                                    uint32_t remainingLength,
                                    const MQTTFixedBuffer_t * pFixedBuffer );
/* @[declare_mqtt_serializepublish] */
 
/* @[declare_mqtt_serializepublishheaderwithouttopic] */
MQTTStatus_t MQTT_SerializePublishHeaderWithoutTopic( const MQTTPublishInfo_t * pPublishInfo,
                                                      uint32_t remainingLength,
                                                      uint8_t * pBuffer,
                                                      size_t * headerSize );
/* @[declare_mqtt_serializepublishheaderwithouttopic] */
 
/* @[declare_mqtt_serializepublishheader] */
MQTTStatus_t MQTT_SerializePublishHeader( const MQTTPublishInfo_t * pPublishInfo,
                                          const MQTTPropBuilder_t * pPublishProperties,
                                          uint16_t packetId,
                                          uint32_t remainingLength,
                                          const MQTTFixedBuffer_t * pFixedBuffer,
                                          size_t * pHeaderSize );
/* @[declare_mqtt_serializepublishheader] */
 
/* @[declare_mqtt_serializeack] */
MQTTStatus_t MQTT_SerializeAck( const MQTTFixedBuffer_t * pFixedBuffer,
                                uint8_t packetType,
                                uint16_t packetId,
                                const MQTTPropBuilder_t * pAckProperties,
                                const MQTTSuccessFailReasonCode_t * pReasonCode );
/* @[declare_mqtt_serializeack] */
 
/* @[declare_mqtt_getdisconnectpacketsize] */
MQTTStatus_t MQTT_GetDisconnectPacketSize( const MQTTPropBuilder_t * pDisconnectProperties,
                                           uint32_t * pRemainingLength,
                                           uint32_t * pPacketSize,
                                           uint32_t maxPacketSize,
                                           const MQTTSuccessFailReasonCode_t * pReasonCode );
/* @[declare_mqtt_getdisconnectpacketsize] */
 
/* @[declare_mqtt_serializedisconnect] */
MQTTStatus_t MQTT_SerializeDisconnect( const MQTTPropBuilder_t * pDisconnectProperties,
                                       const MQTTSuccessFailReasonCode_t * pReasonCode,
                                       uint32_t remainingLength,
                                       const MQTTFixedBuffer_t * pFixedBuffer );
/* @[declare_mqtt_serializedisconnect] */
 
/* @[declare_mqtt_getpingreqpacketsize] */
MQTTStatus_t MQTT_GetPingreqPacketSize( uint32_t * pPacketSize );
/* @[declare_mqtt_getpingreqpacketsize] */
 
/* @[declare_mqtt_serializepingreq] */
MQTTStatus_t MQTT_SerializePingreq( const MQTTFixedBuffer_t * pFixedBuffer );
/* @[declare_mqtt_serializepingreq] */
 
/* @[declare_mqtt_deserializepublish] */
MQTTStatus_t MQTT_DeserializePublish( const MQTTPacketInfo_t * pIncomingPacket,
                                      uint16_t * pPacketId,
                                      MQTTPublishInfo_t * pPublishInfo,
                                      MQTTPropBuilder_t * propBuffer,
                                      uint32_t maxPacketSize,
                                      uint16_t topicAliasMax );
/* @[declare_mqtt_deserializepublish] */
 
/* @[declare_mqtt_deserializeack] */
MQTTStatus_t MQTT_DeserializeAck( const MQTTPacketInfo_t * pIncomingPacket,
                                  uint16_t * pPacketId,
                                  MQTTReasonCodeInfo_t * pReasonCode,
                                  MQTTPropBuilder_t * pPropBuffer,
                                  const MQTTConnectionProperties_t * pConnectProperties );
/* @[declare_mqtt_deserializeack] */
 
/* @[declare_mqtt_deserializeconnack] */
MQTTStatus_t MQTT_DeserializeConnAck( const MQTTPacketInfo_t * pIncomingPacket,
                                      bool * pSessionPresent,
                                      MQTTPropBuilder_t * pPropBuffer,
                                      MQTTConnectionProperties_t * pConnectProperties );
/* @[declare_mqtt_deserializeconnack] */
 
/* @[declare_mqtt_getincomingpackettypeandlength] */
MQTTStatus_t MQTT_GetIncomingPacketTypeAndLength( TransportRecv_t readFunc,
                                                  NetworkContext_t * pNetworkContext,
                                                  MQTTPacketInfo_t * pIncomingPacket );
/* @[declare_mqtt_getincomingpackettypeandlength] */
 
 /* @[declare_mqtt_processincomingpackettypeandlength] */
MQTTStatus_t MQTT_ProcessIncomingPacketTypeAndLength( const uint8_t * pBuffer,
                                                      const size_t * pIndex,
                                                      MQTTPacketInfo_t * pIncomingPacket );
/* @[declare_mqtt_processincomingpackettypeandlength] */
 
 /* @[declare_mqtt_updateduplicatepublishflag] */
MQTTStatus_t MQTT_UpdateDuplicatePublishFlag( uint8_t * pHeader, bool set );
/* @[declare_mqtt_updateduplicatepublishflag] */
 
/* @[declare_mqtt_initconnect] */
MQTTStatus_t MQTT_InitConnect( MQTTConnectionProperties_t * pConnectProperties );
/* @[declare_mqtt_initconnect] */
 
/* @[declare_mqttpropertybuilder_init] */
MQTTStatus_t MQTTPropertyBuilder_Init( MQTTPropBuilder_t * pPropertyBuilder,
                                       uint8_t * buffer,
                                       size_t length );
/* @[declare_mqttpropertybuilder_init] */
 
/* @[declare_mqtt_validatewillproperties] */
MQTTStatus_t MQTT_ValidateWillProperties( const MQTTPropBuilder_t * pPropertyBuilder );
/* @[declare_mqtt_validatewillproperties] */
 
 
/* @[declare_mqtt_validateconnectproperties] */
MQTTStatus_t MQTT_ValidateConnectProperties( const MQTTPropBuilder_t * pPropertyBuilder,
                                             bool * isRequestProblemInfoSet,
                                             uint32_t * pPacketMaxSizeValue );
/* @[declare_mqtt_validateconnectproperties] */
 
/* @[declare_mqttpropadd_subscriptionid] */
MQTTStatus_t MQTTPropAdd_SubscriptionId( MQTTPropBuilder_t * pPropertyBuilder,
                                         uint32_t subscriptionId,
                                         const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_subscriptionid] */
 
/* @[declare_mqttpropadd_userprop] */
MQTTStatus_t MQTTPropAdd_UserProp( MQTTPropBuilder_t * pPropertyBuilder,
                                   const MQTTUserProperty_t * userProperty,
                                   const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_userprop] */
 
/* @[declare_mqttpropadd_sessionexpiry] */
MQTTStatus_t MQTTPropAdd_SessionExpiry( MQTTPropBuilder_t * pPropertyBuilder,
                                        uint32_t sessionExpiry,
                                        const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_sessionexpiry] */
 
/* @[declare_mqttpropadd_receivemax] */
MQTTStatus_t MQTTPropAdd_ReceiveMax( MQTTPropBuilder_t * pPropertyBuilder,
                                     uint16_t receiveMax,
                                     const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_receivemax] */
 
/* @[declare_mqttpropadd_maxpacketsize] */
MQTTStatus_t MQTTPropAdd_MaxPacketSize( MQTTPropBuilder_t * pPropertyBuilder,
                                        uint32_t maxPacketSize,
                                        const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_maxpacketsize] */
 
/* @[declare_mqttpropadd_topicaliasmax] */
MQTTStatus_t MQTTPropAdd_TopicAliasMax( MQTTPropBuilder_t * pPropertyBuilder,
                                        uint16_t topicAliasMax,
                                        const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_topicaliasmax] */
 
/* @[declare_mqttpropadd_requestrespinfo] */
MQTTStatus_t MQTTPropAdd_RequestRespInfo( MQTTPropBuilder_t * pPropertyBuilder,
                                          bool requestResponseInfo,
                                          const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_requestrespinfo] */
 
/* @[declare_mqttpropadd_requestprobinfo] */
MQTTStatus_t MQTTPropAdd_RequestProbInfo( MQTTPropBuilder_t * pPropertyBuilder,
                                          bool requestProblemInfo,
                                          const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_requestprobinfo] */
 
/* @[declare_mqttpropadd_authmethod] */
MQTTStatus_t MQTTPropAdd_AuthMethod( MQTTPropBuilder_t * pPropertyBuilder,
                                     const char * authMethod,
                                     size_t authMethodLength,
                                     const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_authmethod] */
 
/* @[declare_mqttpropadd_authdata] */
MQTTStatus_t MQTTPropAdd_AuthData( MQTTPropBuilder_t * pPropertyBuilder,
                                   const char * authData,
                                   size_t authDataLength,
                                   const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_authdata] */
 
/* @[declare_mqttpropadd_payloadformat] */
MQTTStatus_t MQTTPropAdd_PayloadFormat( MQTTPropBuilder_t * pPropertyBuilder,
                                        bool payloadFormat,
                                        const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_payloadformat] */
 
/* @[declare_mqttpropadd_messageexpiry] */
MQTTStatus_t MQTTPropAdd_MessageExpiry( MQTTPropBuilder_t * pPropertyBuilder,
                                        uint32_t messageExpiry,
                                        const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_messageexpiry] */
 
/* @[declare_mqttpropadd_willdelayinterval] */
MQTTStatus_t MQTTPropAdd_WillDelayInterval( MQTTPropBuilder_t * pPropertyBuilder,
                                            uint32_t willDelayInterval,
                                            const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_willdelayinterval] */
 
/* @[declare_mqttpropadd_topicalias] */
MQTTStatus_t MQTTPropAdd_TopicAlias( MQTTPropBuilder_t * pPropertyBuilder,
                                     uint16_t topicAlias,
                                     const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_topicalias] */
 
/* @[declare_mqttpropadd_responsetopic] */
MQTTStatus_t MQTTPropAdd_ResponseTopic( MQTTPropBuilder_t * pPropertyBuilder,
                                        const char * responseTopic,
                                        size_t responseTopicLength,
                                        const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_responsetopic] */
/* @[declare_mqttpropadd_correlationdata] */
MQTTStatus_t MQTTPropAdd_CorrelationData( MQTTPropBuilder_t * pPropertyBuilder,
                                          const void * pCorrelationData,
                                          size_t correlationLength,
                                          const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_correlationdata] */
 
/* @[declare_mqttpropadd_contenttype] */
MQTTStatus_t MQTTPropAdd_ContentType( MQTTPropBuilder_t * pPropertyBuilder,
                                      const char * contentType,
                                      size_t contentTypeLength,
                                      const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_contenttype] */
 
/* @[declare_mqttpropadd_reasonstring] */
MQTTStatus_t MQTTPropAdd_ReasonString( MQTTPropBuilder_t * pPropertyBuilder,
                                       const char * pReasonString,
                                       size_t reasonStringLength,
                                       const uint8_t * pOptionalMqttPacketType );
/* @[declare_mqttpropadd_reasonstring] */
 
/* @[declare_mqtt_validatesubscribeproperties] */
MQTTStatus_t MQTT_ValidateSubscribeProperties( bool isSubscriptionIdAvailable,
                                               const MQTTPropBuilder_t * propBuilder );
/* @[declare_mqtt_validatesubscribeproperties] */
 
MQTTStatus_t updateContextWithConnectProps( const MQTTPropBuilder_t * pPropBuilder,
                                            MQTTConnectionProperties_t * pConnectProperties );
 
MQTTStatus_t MQTT_GetNextPropertyType( const MQTTPropBuilder_t * pPropertyBuilder,
                                       const size_t * currentIndex,
                                       uint8_t * property );
 
MQTTStatus_t MQTT_SkipNextProperty( const MQTTPropBuilder_t * pPropertyBuilder,
                                    size_t * currentIndex );
 
/* @[declare_mqttpropget_userprop] */
MQTTStatus_t MQTTPropGet_UserProp( const MQTTPropBuilder_t * pPropertyBuilder,
                                   size_t * currentIndex,
                                   MQTTUserProperty_t * pUserProperty );
/* @[declare_mqttpropget_userprop] */
 
/* @[declare_mqttpropget_sessionexpiry] */
MQTTStatus_t MQTTPropGet_SessionExpiry( const MQTTPropBuilder_t * pPropertyBuilder,
                                        size_t * currentIndex,
                                        uint32_t * pSessionExpiry );
/* @[declare_mqttpropget_sessionexpiry] */
 
/* @[declare_mqttpropget_receivemax] */
MQTTStatus_t MQTTPropGet_ReceiveMax( const MQTTPropBuilder_t * pPropertyBuilder,
                                     size_t * currentIndex,
                                     uint16_t * pReceiveMax );
/* @[declare_mqttpropget_receivemax] */
 
/* @[declare_mqttpropget_maxqos] */
MQTTStatus_t MQTTPropGet_MaxQos( const MQTTPropBuilder_t * pPropertyBuilder,
                                 size_t * currentIndex,
                                 uint8_t * pMaxQos );
/* @[declare_mqttpropget_maxqos] */
 
/* @[declare_mqttpropget_retainavailable] */
MQTTStatus_t MQTTPropGet_RetainAvailable( const MQTTPropBuilder_t * pPropertyBuilder,
                                          size_t * currentIndex,
                                          uint8_t * pRetainAvailable );
/* @[declare_mqttpropget_retainavailable] */
 
/* @[declare_mqttpropget_maxpacketsize] */
MQTTStatus_t MQTTPropGet_MaxPacketSize( const MQTTPropBuilder_t * pPropertyBuilder,
                                        size_t * currentIndex,
                                        uint32_t * pMaxPacketSize );
/* @[declare_mqttpropget_maxpacketsize] */
 
/* @[declare_mqttpropget_assignedclientid] */
MQTTStatus_t MQTTPropGet_AssignedClientId( const MQTTPropBuilder_t * pPropertyBuilder,
                                           size_t * currentIndex,
                                           const char ** pClientId,
                                           size_t * pClientIdLength );
/* @[declare_mqttpropget_assignedclientid] */
 
/* @[declare_mqttpropget_topicaliasmax] */
MQTTStatus_t MQTTPropGet_TopicAliasMax( const MQTTPropBuilder_t * pPropertyBuilder,
                                        size_t * currentIndex,
                                        uint16_t * pTopicAliasMax );
/* @[declare_mqttpropget_topicaliasmax] */
 
/* @[declare_mqttpropget_reasonstring] */
MQTTStatus_t MQTTPropGet_ReasonString( const MQTTPropBuilder_t * pPropertyBuilder,
                                       size_t * currentIndex,
                                       const char ** pReasonString,
                                       size_t * pReasonStringLength );
/* @[declare_mqttpropget_reasonstring] */
 
/* @[declare_mqttpropget_wildcardid] */
MQTTStatus_t MQTTPropGet_WildcardId( const MQTTPropBuilder_t * pPropertyBuilder,
                                     size_t * currentIndex,
                                     uint8_t * pWildcardAvailable );
/* @[declare_mqttpropget_wildcardid] */
 
/* @[declare_mqttpropget_subsidavailable] */
MQTTStatus_t MQTTPropGet_SubsIdAvailable( const MQTTPropBuilder_t * pPropertyBuilder,
                                          size_t * currentIndex,
                                          uint8_t * pSubsIdAvailable );
/* @[declare_mqttpropget_subsidavailable] */
 
/* @[declare_mqttpropget_sharedsubavailable] */
MQTTStatus_t MQTTPropGet_SharedSubAvailable( const MQTTPropBuilder_t * pPropertyBuilder,
                                             size_t * currentIndex,
                                             uint8_t * pSharedSubAvailable );
/* @[declare_mqttpropget_sharedsubavailable] */
 
/* @[declare_mqttpropget_serverkeepalive] */
MQTTStatus_t MQTTPropGet_ServerKeepAlive( const MQTTPropBuilder_t * pPropertyBuilder,
                                          size_t * currentIndex,
                                          uint16_t * pServerKeepAlive );
/* @[declare_mqttpropget_serverkeepalive] */
 
/* @[declare_mqttpropget_responseinfo] */
MQTTStatus_t MQTTPropGet_ResponseInfo( const MQTTPropBuilder_t * pPropertyBuilder,
                                       size_t * currentIndex,
                                       const char ** pResponseInfo,
                                       size_t * pResponseInfoLength );
/* @[declare_mqttpropget_responseinfo] */
 
/* @[declare_mqttpropget_serverref] */
MQTTStatus_t MQTTPropGet_ServerRef( const MQTTPropBuilder_t * pPropertyBuilder,
                                    size_t * currentIndex,
                                    const char ** pServerRef,
                                    size_t * pServerRefLength );
/* @[declare_mqttpropget_serverref] */
 
/* @[declare_mqttpropget_authmethod] */
MQTTStatus_t MQTTPropGet_AuthMethod( const MQTTPropBuilder_t * pPropertyBuilder,
                                     size_t * currentIndex,
                                     const char ** pAuthMethod,
                                     size_t * pAuthMethodLen );
/* @[declare_mqttpropget_authmethod] */
 
/* @[declare_mqttpropget_authdata] */
MQTTStatus_t MQTTPropGet_AuthData( const MQTTPropBuilder_t * pPropertyBuilder,
                                   size_t * currentIndex,
                                   const char ** pAuthData,
                                   size_t * pAuthDataLen );
/* @[declare_mqttpropget_authdata] */
 
/* @[declare_mqttpropget_payloadformatindicator] */
MQTTStatus_t MQTTPropGet_PayloadFormatIndicator( const MQTTPropBuilder_t * pPropertyBuilder,
                                                 size_t * currentIndex,
                                                 uint8_t * pPayloadFormat );
/* @[declare_mqttpropget_payloadformatindicator] */
 
/* @[declare_mqttpropget_messageexpiryinterval] */
MQTTStatus_t MQTTPropGet_MessageExpiryInterval( const MQTTPropBuilder_t * pPropertyBuilder,
                                                size_t * currentIndex,
                                                uint32_t * pMessageExpiry );
/* @[declare_mqttpropget_messageexpiryinterval] */
 
/* @[declare_mqttpropget_topicalias] */
MQTTStatus_t MQTTPropGet_TopicAlias( const MQTTPropBuilder_t * pPropertyBuilder,
                                     size_t * currentIndex,
                                     uint16_t * pTopicAlias );
/* @[declare_mqttpropget_topicalias] */
 
/* @[declare_mqttpropget_responsetopic] */
MQTTStatus_t MQTTPropGet_ResponseTopic( const MQTTPropBuilder_t * pPropertyBuilder,
                                        size_t * currentIndex,
                                        const char ** pResponseTopic,
                                        size_t * pResponseTopicLength );
/* @[declare_mqttpropget_responsetopic] */
 
/* @[declare_mqttpropget_correlationdata] */
MQTTStatus_t MQTTPropGet_CorrelationData( const MQTTPropBuilder_t * pPropertyBuilder,
                                          size_t * currentIndex,
                                          const char ** pCorrelationData,
                                          size_t * pCorrelationDataLength );
/* @[declare_mqttpropget_correlationdata] */
 
/* @[declare_mqttpropget_subscriptionid] */
MQTTStatus_t MQTTPropGet_SubscriptionId( const MQTTPropBuilder_t * pPropertyBuilder,
                                         size_t * currentIndex,
                                         uint32_t * pSubscriptionId );
/* @[declare_mqttpropget_subscriptionid] */
 
/* @[declare_mqttpropget_contenttype] */
MQTTStatus_t MQTTPropGet_ContentType( const MQTTPropBuilder_t * pPropertyBuilder,
                                      size_t * currentIndex,
                                      const char ** pContentType,
                                      size_t * pContentTypeLength );
/* @[declare_mqttpropget_contenttype] */
 
/* @[declare_mqtt_validatepublishproperties] */
MQTTStatus_t MQTT_ValidatePublishProperties( uint16_t serverTopicAliasMax,
                                             const MQTTPropBuilder_t * propBuilder,
                                             uint16_t * topicAlias );
/* @[declare_mqtt_validatepublishproperties] */
 
/* @[declare_mqtt_validatepublishparams] */
MQTTStatus_t MQTT_ValidatePublishParams( const MQTTPublishInfo_t * pPublishInfo,
                                         uint8_t retainAvailable,
                                         uint8_t maxQos,
                                         uint16_t topicAlias,
                                         uint32_t maxPacketSize );
/* @[declare_mqtt_validatepublishparams] */
 
/* @[declare_mqtt_validatepublishackproperties] */
MQTTStatus_t MQTT_ValidatePublishAckProperties( const MQTTPropBuilder_t * pPropertyBuilder );
/* @[declare_mqtt_validatepublishackproperties] */
 
/* @[declare_mqtt_validateunsubscribeproperties] */
MQTTStatus_t MQTT_ValidateUnsubscribeProperties( const MQTTPropBuilder_t * pPropertyBuilder );
/* @[declare_mqtt_validateunsubscribeproperties] */
 
/* @[declare_mqtt_getackpacketsize] */
MQTTStatus_t MQTT_GetAckPacketSize( uint32_t * pRemainingLength,
                                    uint32_t * pPacketSize,
                                    uint32_t maxPacketSize,
                                    size_t ackPropertyLength );
/* @[declare_mqtt_getackpacketsize] */
 
/* @[declare_mqtt_validatedisconnectproperties] */
MQTTStatus_t MQTT_ValidateDisconnectProperties( uint32_t connectSessionExpiry,
                                                const MQTTPropBuilder_t * pPropertyBuilder );
/* @[declare_mqtt_validatedisconnectproperties] */
 
/* @[declare_mqtt_deserializedisconnect] */
MQTTStatus_t MQTT_DeserializeDisconnect( const MQTTPacketInfo_t * pPacket,
                                         uint32_t maxPacketSize,
                                         MQTTReasonCodeInfo_t * pDisconnectInfo,
                                         MQTTPropBuilder_t * pPropBuffer );
/* @[declare_mqtt_deserializedisconnect] */
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* ifndef CORE_MQTT_SERIALIZER_H */