Merge pull request #5 from AniruddhaKanhere/reTransmit

Fix unit test and remove clearall function

Author: AniruddhaKanhere

source/core_mqtt.c

@@ -451,8 +451,7 @@ static MQTTStatus_t handleUncleanSessionResumption( MQTTContext_t * pContext );
  *
  * @param[in] pContext Initialized MQTT context.
  *
- * @return #MQTTPublishClearAllFailed if clearing all the copied publishes fails;
- * #MQTTSuccess otherwise.
+ * @return #MQTTSuccess always otherwise.
  */
 static MQTTStatus_t handleCleanSession( MQTTContext_t * pContext );
 
@@ -1609,10 +1608,9 @@ static MQTTStatus_t handlePublishAcks( MQTTContext_t * pContext,
     if( ( ackType == MQTTPuback ) || ( ackType == MQTTPubrec ) )
     {
         if( ( status == MQTTSuccess ) &&
-            ( pContext->clearFunction != NULL ) &&
-            ( pContext->clearFunction( pContext, packetIdentifier ) != true ) )
+            ( pContext->clearFunction != NULL ) )
         {
-            LogWarn( ( "Failed to clear copied publish on receiving an ack.\n" ) );
+            pContext->clearFunction( pContext, packetIdentifier );
         }
     }
 
@@ -2584,6 +2582,8 @@ static MQTTStatus_t handleUncleanSessionResumption( MQTTContext_t * pContext )
 static MQTTStatus_t handleCleanSession( MQTTContext_t * pContext )
 {
     MQTTStatus_t status = MQTTSuccess;
+    MQTTStateCursor_t cursor = MQTT_STATE_CURSOR_INITIALIZER;
+    uint16_t packetId = MQTT_PACKET_ID_INVALID;
 
     assert( pContext != NULL );
 
@@ -2606,10 +2606,22 @@ static MQTTStatus_t handleCleanSession( MQTTContext_t * pContext )
                          pContext->incomingPublishRecordMaxCount * sizeof( *pContext->incomingPublishRecords ) );
     }
 
-    if( ( pContext->clearAllFunction != NULL ) &&
-        ( pContext->clearAllFunction( pContext ) != true ) )
+    if( pContext->clearFunction != NULL ) 
     {
-        status = MQTTPublishClearAllFailed;
+        cursor = MQTT_STATE_CURSOR_INITIALIZER;
+
+        /* Resend all the PUBLISH for which PUBACK/PUBREC is not received
+         * after session is reestablished. */
+        do
+        {
+            packetId = MQTT_PublishToResend( pContext, &cursor );
+
+            if( packetId != MQTT_PACKET_ID_INVALID )
+            {
+                pContext->clearFunction( pContext, packetId );
+            }
+        } while( ( packetId != MQTT_PACKET_ID_INVALID ) &&
+                 ( status == MQTTSuccess ) );
     }
 
     return status;
@@ -2780,8 +2792,7 @@ MQTTStatus_t MQTT_InitStatefulQoS( MQTTContext_t * pContext,
 MQTTStatus_t MQTT_InitRetransmits( MQTTContext_t * pContext,
                                    MQTTStorePacketForRetransmit storeFunction,
                                    MQTTRetrievePacketForRetransmit retrieveFunction,
-                                   MQTTClearPacketForRetransmit clearFunction,
-                                   MQTTClearAllPacketsForRetransmit clearAllFunction )
+                                   MQTTClearPacketForRetransmit clearFunction )
 {
     MQTTStatus_t status = MQTTSuccess;
 
@@ -2806,17 +2817,11 @@ MQTTStatus_t MQTT_InitRetransmits( MQTTContext_t * pContext,
         LogError( ( "Invalid parameter: clearFunction is NULL" ) );
         status = MQTTBadParameter;
     }
-    else if( clearAllFunction == NULL )
-    {
-        LogError( ( "Invalid parameter: clearAllFunction is NULL" ) );
-        status = MQTTBadParameter;
-    }
     else
     {
         pContext->storeFunction = storeFunction;
         pContext->retrieveFunction = retrieveFunction;
         pContext->clearFunction = clearFunction;
-        pContext->clearAllFunction = clearAllFunction;
     }
 
     return status;
@@ -3711,10 +3716,6 @@ const char * MQTT_Status_strerror( MQTTStatus_t status )
             str = "MQTTPublishRetrieveFailed";
             break;
 
-        case MQTTPublishClearAllFailed:
-            str = "MQTTPublishClearAllFailed";
-            break;
-
         default:
             str = "Invalid MQTT Status code";
             break;

source/include/core_mqtt.h

@@ -158,22 +158,10 @@ typedef bool ( * MQTTRetrievePacketForRetransmit)( struct MQTTContext * pContext
  * @return True if the clear is successful else false.
  */
 /* @[define_mqtt_retransmitclearpacket] */
-typedef bool (* MQTTClearPacketForRetransmit)( struct MQTTContext * pContext,
+typedef void (* MQTTClearPacketForRetransmit)( struct MQTTContext * pContext,
                                                uint16_t packetId );
 /* @[define_mqtt_retransmitclearpacket] */
 
-/**
- * @brief User defined callback used to clear all copied publish packets. Used to
- * when connecting with a clean session.
- *
- * @param[in] pContext Initialised MQTT Context.
- *
- * @return True if the clear all is successful else false.
- */
-/* @[define_mqtt_retransmitclearallpackets] */
-typedef bool (* MQTTClearAllPacketsForRetransmit)( struct MQTTContext * pContext );
-/* @[define_mqtt_retransmitclearallpackets] */
-
 /**
  * @ingroup mqtt_enum_types
  * @brief Values indicating if an MQTT connection exists.
@@ -335,11 +323,6 @@ typedef struct MQTTContext
      * @brief User defined API used to clear a particular copied publish packet.
      */
     MQTTClearPacketForRetransmit clearFunction;
-
-    /**
-     * @brief User defined API used to clear all copied publish packets.
-     */
-    MQTTClearAllPacketsForRetransmit clearAllFunction;
 } MQTTContext_t;
 
 /**
@@ -517,7 +500,6 @@ MQTTStatus_t MQTT_InitStatefulQoS( MQTTContext_t * pContext,
  * @param[in] storeFunction User defined API used to store outgoing publishes.
  * @param[in] retrieveFunction User defined API used to retreive a copied publish for resend operation.
  * @param[in] clearFunction User defined API used to clear a particular copied publish packet.
- * @param[in] clearAllFunction User defined API used to clear a particular copied publish packet.
  *
  * @return #MQTTBadParameter if invalid parameters are passed;
  * #MQTTSuccess otherwise.
@@ -599,8 +581,7 @@ MQTTStatus_t MQTT_InitStatefulQoS( MQTTContext_t * pContext,
 MQTTStatus_t MQTT_InitRetransmits( MQTTContext_t * pContext,
                                    MQTTStorePacketForRetransmit storeFunction,
                                    MQTTRetrievePacketForRetransmit retrieveFunction,
-                                   MQTTClearPacketForRetransmit clearFunction,
-                                   MQTTClearAllPacketsForRetransmit clearAllFunction );
+                                   MQTTClearPacketForRetransmit clearFunction );
 /* @[declare_mqtt_initretransmits] */
 
 /**
@@ -662,8 +643,6 @@ MQTTStatus_t MQTT_CheckConnectStatus( MQTTContext_t * pContext );
  * #MQTTStatusConnected if the connection is already established
  * #MQTTStatusDisconnectPending if the user is expected to call MQTT_Disconnect
  * before calling any other API
- * MQTTPublishClearAllFailed if on a clean session connection, clearing all the
- * previously copied publishes fails
  * MQTTPublishRetrieveFailed if on an unclean session connection, the copied
  * publishes are not retrieved successfully for retransmission
  * #MQTTSuccess otherwise.

source/include/core_mqtt_serializer.h

@@ -99,15 +99,13 @@ typedef enum MQTTStatus
     MQTTNeedMoreBytes,              /**< MQTT_ProcessLoop/MQTT_ReceiveLoop has received
                                     incomplete data; it should be called again (probably after
                                     a delay). */
-    MQTTStatusConnected,            /**< MQTT connection is established with the broker */
-    MQTTStatusNotConnected,         /**< MQTT connection is not established with the broker */
-    MQTTStatusDisconnectPending,    /**< Transport Interface has failed and MQTT connection needs to be closed */
+    MQTTStatusConnected,            /**< MQTT connection is established with the broker. */
+    MQTTStatusNotConnected,         /**< MQTT connection is not established with the broker. */
+    MQTTStatusDisconnectPending,    /**< Transport Interface has failed and MQTT connection needs to be closed. */
     MQTTPublishStoreFailed,         /**< User provided API to store a copy of outgoing publish for retransmission  purposes,
-                                    has failed */
-    MQTTPublishRetrieveFailed,      /**< User provided API to retrieve the copy of a publish while reconnecting
-                                    with an unclean session has failed */
-    MQTTPublishClearAllFailed       /**< User provided API to clear all the copies of publishes while connecting with a clean
-                                    session has failed */
+                                    has failed. */
+    MQTTPublishRetrieveFailed       /**< User provided API to retrieve the copy of a publish while reconnecting
+                                    with an unclean session has failed. */
 } MQTTStatus_t;
 
 /**