Add MQTT_InitStatefulQoS API

Author: AniruddhaKanhere

source/core_mqtt.c

@@ -2737,7 +2737,9 @@ MQTTStatus_t MQTT_InitStatefulQoS( MQTTContext_t * pContext,
                                    MQTTPubAckInfo_t * pOutgoingPublishRecords,
                                    size_t outgoingPublishCount,
                                    MQTTPubAckInfo_t * pIncomingPublishRecords,
-                                   size_t incomingPublishCount )
+                                   size_t incomingPublishCount,
+                                   uint8_t * pAckPropsBuf,
+                                   size_t ackPropsBufLength )
 {
     MQTTStatus_t status = MQTTSuccess;
 
@@ -2783,6 +2785,16 @@ MQTTStatus_t MQTT_InitStatefulQoS( MQTTContext_t * pContext,
         pContext->incomingPublishRecords = pIncomingPublishRecords;
         pContext->outgoingPublishRecordMaxCount = outgoingPublishCount;
         pContext->outgoingPublishRecords = pOutgoingPublishRecords;
+
+        if( ( pAckPropsBuf != NULL ) && ( ackPropsBufLength != 0U ) )
+        {
+            status = MQTTPropertyBuilder_Init( &pContext->ackPropsBuffer, pAckPropsBuf, ackPropsBufLength );
+        }
+        else
+        {
+            pContext->ackPropsBuffer.pBuffer = NULL;
+            pContext->ackPropsBuffer.bufferLength = 0;
+        }
     }
 
     return status;

source/core_mqtt_serializer.c

@@ -2750,3 +2750,31 @@ MQTTStatus_t MQTT_InitConnect( MQTTConnectionProperties_t * pConnectProperties )
 }
 
 /*-----------------------------------------------------------*/
+
+MQTTStatus_t MQTTPropertyBuilder_Init( MQTTPropBuilder_t * pPropertyBuilder,
+                                       uint8_t * buffer,
+                                       size_t length )
+{
+    MQTTStatus_t status = MQTTSuccess;
+
+    if( ( pPropertyBuilder == NULL ) || ( buffer == NULL ) || ( length == 0U ) )
+    {
+        LogError( ( "Invalid arguments passed to MQTTPropertyBuilder_Init. "
+                    "pPropertyBuilder must be non-NULL; "
+                    "buffer must be non-NULL; "
+                    "and length must be non-zero. " ) );
+        status = MQTTBadParameter;
+    }
+
+    if( status == MQTTSuccess )
+    {
+        pPropertyBuilder->pBuffer = buffer;
+        pPropertyBuilder->currentIndex = 0;
+        pPropertyBuilder->bufferLength = length;
+        pPropertyBuilder->fieldSet = 0; /* 0 means no field is set. */
+    }
+
+    return status;
+}
+
+/*-----------------------------------------------------------*/

source/include/core_mqtt.h

@@ -438,9 +438,10 @@ MQTTStatus_t MQTT_Init( MQTTContext_t * pContext,
  * publishes.
  * @param[in] incomingPublishCount Maximum number of records which can be kept in the memory
  * pointed to by @p pIncomingPublishRecords.
- *
- * @return #MQTTBadParameter if invalid parameters are passed;
- * #MQTTSuccess otherwise.
+ * @param[in] pAckPropsBuf Pointer to memory which will be used to store properties of outgoing publish-ACKS.
+ * @param[in] ackPropsBufLength Length of the buffer pointed to by @p pBuffer.
+ * @return #MQTTBadParameter if invalid parameters are passed;<br>
+ * #MQTTSuccess otherwise.<br>
  *
  * <b>Example</b>
  * @code{c}
@@ -483,7 +484,16 @@ MQTTStatus_t MQTT_Init( MQTTContext_t * pContext,
  * {
  *      // We do not expect any incoming publishes in this example, therefore the incoming
  *      // publish pointer is NULL and the count is zero.
- *      status = MQTT_InitStatefulQoS( &mqttContext, outgoingPublishes, outgoingPublishCount, NULL, 0 );
+ *      // The buffer is used to store properties of outgoing publish-ACKS.
+ *      uint8_t ackPropsBuf[ 500 ];
+ *      size_t ackPropsBufLength = sizeof( ackPropsBuf );
+ *      status = MQTT_InitStatefulQoS( &mqttContext,
+ *                                     outgoingPublishes,
+ *                                     outgoingPublishCount,
+ *                                     NULL,
+ *                                     0,
+ *                                     ackPropsBuf,
+ *                                     ackPropsBufLength );
  *
  *      // Now QoS1 and/or QoS2 publishes can be sent with this context.
  * }
@@ -494,7 +504,9 @@ MQTTStatus_t MQTT_InitStatefulQoS( MQTTContext_t * pContext,
                                    MQTTPubAckInfo_t * pOutgoingPublishRecords,
                                    size_t outgoingPublishCount,
                                    MQTTPubAckInfo_t * pIncomingPublishRecords,
-                                   size_t incomingPublishCount );
+                                   size_t incomingPublishCount,
+                                   uint8_t * pAckPropsBuf,
+                                   size_t ackPropsBufLength );
 /* @[declare_mqtt_initstatefulqos] */
 
 /**

source/include/core_mqtt_serializer.h

@@ -1420,6 +1420,23 @@ uint8_t * MQTT_SerializeUnsubscribeHeader( size_t remainingLength,
 MQTTStatus_t MQTT_InitConnect( MQTTConnectionProperties_t * pConnectProperties );
 /* @[declare_mqtt_initconnect] */
 
+/**
+ * @brief Initialize the property builder.
+ *
+ * @param[out] pPropertyBuilder Property builder to initialize.
+ * @param[in] buffer Buffer to store the properties.
+ * @param[in] length Length of the buffer.
+ *
+ * @return
+ * - #MQTTBadParameter if invalid parameters are passed.
+ * - #MQTTSuccess otherwise.
+ */
+/* @[declare_mqttpropertybuilder_init] */
+MQTTStatus_t MQTTPropertyBuilder_Init( MQTTPropBuilder_t * pPropertyBuilder,
+                                        uint8_t * buffer,
+                                        size_t length );
+/* @[declare_mqttpropertybuilder_init] */
+
 /* *INDENT-OFF* */
 #ifdef __cplusplus
     }