Cosmetic changes in the MQTT demo

- Fix warnings in the MQTT code.
- Update comments in the iot_config.h.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@2702 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/FreeRTOSIPConfig.h b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/FreeRTOSIPConfig.h
index 563f0cb09542bf9ab0b36806d8ff9ec7a28e69a7..4729ef107ba4eb2afc1148ae096428889181546a 100644 (file)
--- a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/FreeRTOSIPConfig.h
+++ b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/FreeRTOSIPConfig.h
@@ -146,7 +146,7 @@ stack will revert to using the static IP address even when ipconfigUSE_DHCP is
 set to 1 if a valid configuration cannot be obtained from a DHCP server for any\r
 reason.  The static configuration used is that passed into the stack by the\r
 FreeRTOS_IPInit() function call. */\r
-#define ipconfigUSE_DHCP       0\r
+#define ipconfigUSE_DHCP       1\r
 \r
 /* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at\r
 increasing time intervals until either a reply is received from a DHCP server\r

diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/WIN32.vcxproj b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/WIN32.vcxproj
index 329a1129bc12786f3cb0dfba4ea97041e03f3dc4..f2157c81345c68f74a13acf94ca44399cb08197b 100644 (file)
--- a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/WIN32.vcxproj
+++ b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/WIN32.vcxproj
@@ -71,7 +71,7 @@
       <SuppressStartupBanner>true</SuppressStartupBanner>\r
       <DisableLanguageExtensions>false</DisableLanguageExtensions>\r
       <DebugInformationFormat>EditAndContinue</DebugInformationFormat>\r
-      <AdditionalOptions>/wd4210 /wd4127 /wd4214 /wd4201 /wd4244  /wd4310 %(AdditionalOptions)</AdditionalOptions>\r
+      <AdditionalOptions>/wd4210 /wd4127 /wd4214 /wd4201 /wd4244  /wd4310 /wd4200 %(AdditionalOptions)</AdditionalOptions>\r
       <BrowseInformation>true</BrowseInformation>\r
       <PrecompiledHeader>NotUsing</PrecompiledHeader>\r
       <ExceptionHandling>false</ExceptionHandling>\r

diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/iot_config.h b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/iot_config.h
index a326f471e74003b4ccc95d2dd8beaa8ea5b2b936..1f9568618b9c844585f6670da4ac4452bdc28536 100644 (file)
--- a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/iot_config.h
+++ b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/iot_config.h
@@ -28,27 +28,29 @@
 #include "FreeRTOS.h"\r
 #include "platform/iot_platform_types_freertos.h" //_RB_Makes common config file FreeRTOS specific\r
 \r
-/*\r
- * Set this to the number of recyclable tasks for the task pool to cache.\r
+/**\r
+ * @brief The number of recyclable jobs for the task pool to cache.\r
  *\r
- * Caching dynamically allocated tasks (recyclable tasks) helps the application\r
- * to limit the number of allocations at runtime. Caching recyclable tasks may\r
+ * Caching dynamically allocated jobs (recyclable jobs) helps the application\r
+ * to limit the number of allocations at runtime. Caching recyclable jobs may\r
  * help making the application more responsive and predictable, by removing a\r
  * potential for memory allocation failures, but it may also have negative\r
  * repercussions on the amount of memory available at any given time. It is up\r
- * to the application developer to strike the correct balance these competing\r
- * needs. The task pool will cache when the application calling\r
- * IotTaskPool_RecycleJob. Any recycled tasks in excess of\r
+ * to the application developer to strike the correct balance among these\r
+ * competing needs. The task pool will cache a job when the application calls\r
+ * IotTaskPool_RecycleJob on a job which was created using\r
+ * IotTaskPool_CreateRecyclableJob API. Any recycled jobs in excess of\r
  * IOT_TASKPOOL_JOBS_RECYCLE_LIMIT will be destroyed and its memory will be\r
- * release.\r
+ * released.\r
  *\r
  * Default value (if undefined): 8\r
  */\r
-#define IOT_TASKPOOL_JOBS_RECYCLE_LIMIT 8\r
+#define IOT_TASKPOOL_JOBS_RECYCLE_LIMIT             8\r
 \r
-/*\r
+/**\r
+ * @brief Enable/Disable asserts for the task pool library.\r
+ * \r
  * Set this to 1 to perform sanity checks when using the task pool library.\r
- *\r
  * Asserts are useful for debugging, but should be disabled in production code.\r
  * If this is set to 1, IotTaskPool_Assert can be defined to set the assertion\r
  * function; otherwise, the standard library's assert function will be used.\r
@@ -57,10 +59,10 @@
  * Recommended values: 1 when debugging; 0 in production code.\r
  * Default value (if undefined): 0\r
  */\r
-#define IOT_TASKPOOL_ENABLE_ASSERTS 1\r
+#define IOT_TASKPOOL_ENABLE_ASSERTS                 1\r
 \r
-/*\r
- * Set the log level of the task pool library.\r
+/**\r
+ * @brief Set the log level of the task pool library.\r
  *\r
  * Log messages from the task pool library at or below this setting will be\r
  * printed.\r
@@ -69,22 +71,37 @@
  * Default value (if undefined): IOT_LOG_LEVEL_GLOBAL; if that is undefined,\r
  * then IOT_LOG_NONE.\r
  */\r
-#define IOT_LOG_LEVEL_TASKPOOL IOT_LOG_INFO\r
+#define IOT_LOG_LEVEL_TASKPOOL                      IOT_LOG_INFO\r
 \r
-/*\r
- *\r
+/**\r
+ * @brief The number of worker tasks in the task pool.\r
+ * \r
+ * The minimal version of the of task pool library only supports one task pool\r
+ * and the number of the worker tasks is fixed at the compile time.\r
  */\r
-#define IOT_TASKPOOL_NUMBER_OF_WORKERS 3\r
+#define IOT_TASKPOOL_NUMBER_OF_WORKERS              3\r
 \r
-/*\r
- *\r
+/**\r
+ * @brief The stack size (in bytes) for each worker task in the task pool.\r
+ * \r
+ * The minimal version of the of task pool library only supports one task pool\r
+ * and the configuration of each worker task fixed at the compile time.\r
  */\r
-#define IOT_TASKPOOL_WORKER_STACK_SIZE_BYTES 2048\r
+#define IOT_TASKPOOL_WORKER_STACK_SIZE_BYTES        2048\r
 \r
-/* How long the MQTT library will wait for PINGRESPs or PUBACKs. */\r
-#define IOT_MQTT_RESPONSE_WAIT_MS ( 10000 )\r
+/**\r
+ * @brief The amount of time the MQTT library waits for responses (PINGRESPs or\r
+ * PUBACKs) from the MQTT broker.\r
+ */\r
+#define IOT_MQTT_RESPONSE_WAIT_MS                   ( 10000 )\r
 \r
-#define AWS_IOT_MQTT_ENABLE_METRICS 0\r
+/**\r
+ * @brief Enable/Disable anonymous metrics collection when using AWS IoT.\r
+ *\r
+ * This demo does not support TLS and so does not work with AWS IoT. Therefore,\r
+ * the metric collection must be disabled.\r
+ */\r
+#define AWS_IOT_MQTT_ENABLE_METRICS                 0\r
 \r
 /* Include the common configuration file for FreeRTOS. */\r
 #include "iot_config_common.h"\r

diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/main.c b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/main.c
index 5b0f4e132bab978098d9bb8fb539db5d332ee563..5b6c054fb9566d36cdf7db514b2fbd61b41c0448 100644 (file)
--- a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/main.c
+++ b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/main.c
@@ -65,8 +65,8 @@ environment.
 \r
 mainCREATE_SIMPLE_MQTT_EXAMPLE_TASKS:  TBD\r
 */\r
-#define mainCREATE_SIMPLE_UDP_CLIENT_SERVER_TASKS      1\r
-#define mainCREATE_SIMPLE_MQTT_EXAMPLE_TASKS           0\r
+#define mainCREATE_SIMPLE_UDP_CLIENT_SERVER_TASKS      0\r
+#define mainCREATE_SIMPLE_MQTT_EXAMPLE_TASKS           1\r
 \r
 /* Simple UDP client and server task parameters. */\r
 #define mainSIMPLE_UDP_CLIENT_SERVER_TASK_PRIORITY             ( tskIDLE_PRIORITY )\r

diff --git a/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/mqtt/src/iot_mqtt_operation.c b/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/mqtt/src/iot_mqtt_operation.c
index bfe08d7b2d95c31c39b0bb4a4ff54e53cdcc757e..9e4ec282e0c24108f41e512e718b822815008595 100644 (file)
--- a/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/mqtt/src/iot_mqtt_operation.c
+++ b/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/mqtt/src/iot_mqtt_operation.c
@@ -1105,7 +1105,10 @@ _mqttOperation_t * _IotMqtt_FindOperation( _mqttConnection_t * pMqttConnection,
     IotTaskPoolError_t taskPoolStatus = IOT_TASKPOOL_SUCCESS;\r
     _mqttOperation_t * pResult = NULL;\r
     IotLink_t * pResultLink = NULL;\r
-    _operationMatchParam_t param = { .type = type, .pPacketIdentifier = pPacketIdentifier };\r
+    _operationMatchParam_t param = { 0 };\r
+\r
+    param.type = type;\r
+    param.pPacketIdentifier = pPacketIdentifier;\r
 \r
     if( pPacketIdentifier != NULL )\r
     {\r

diff --git a/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/mqtt/src/iot_mqtt_subscription.c b/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/mqtt/src/iot_mqtt_subscription.c
index 99664de057840ffaae2335db193744b810c5cf8d..59caccc7fb33103fef9701b2ef77e55a0e4238a4 100644 (file)
--- a/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/mqtt/src/iot_mqtt_subscription.c
+++ b/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/mqtt/src/iot_mqtt_subscription.c
@@ -406,12 +406,11 @@ void _IotMqtt_InvokeSubscriptionCallback( _mqttConnection_t * pMqttConnection,
 \r
     void ( * callbackFunction )( void *,\r
                                  IotMqttCallbackParam_t * ) = NULL;\r
-    _topicMatchParams_t topicMatchParams =\r
-    {\r
-        .pTopicName      = pCallbackParam->u.message.info.pTopicName,\r
-        .topicNameLength = pCallbackParam->u.message.info.topicNameLength,\r
-        .exactMatchOnly  = false\r
-    };\r
+    _topicMatchParams_t topicMatchParams = { 0 };\r
+\r
+    topicMatchParams.pTopicName = pCallbackParam->u.message.info.pTopicName;\r
+    topicMatchParams.topicNameLength = pCallbackParam->u.message.info.topicNameLength;\r
+    topicMatchParams.exactMatchOnly = false;\r
 \r
     /* Prevent any other thread from modifying the subscription list while this\r
      * function is searching. */\r
@@ -508,11 +507,10 @@ void _IotMqtt_RemoveSubscriptionByPacket( _mqttConnection_t * pMqttConnection,
                                           uint16_t packetIdentifier,\r
                                           int32_t order )\r
 {\r
-    const _packetMatchParams_t packetMatchParams =\r
-    {\r
-        .packetIdentifier = packetIdentifier,\r
-        .order            = order\r
-    };\r
+    _packetMatchParams_t packetMatchParams = { 0 };\r
+\r
+    packetMatchParams.packetIdentifier = packetIdentifier;\r
+    packetMatchParams.order = order;\r
 \r
     IotMutex_Lock( &( pMqttConnection->subscriptionMutex ) );\r
     IotListDouble_RemoveAllMatches( &( pMqttConnection->subscriptionList ),\r
@@ -593,12 +591,11 @@ bool IotMqtt_IsSubscribed( IotMqttConnection_t mqttConnection,
     bool status = false;\r
     _mqttSubscription_t * pSubscription = NULL;\r
     IotLink_t * pSubscriptionLink = NULL;\r
-    _topicMatchParams_t topicMatchParams =\r
-    {\r
-        .pTopicName      = pTopicFilter,\r
-        .topicNameLength = topicFilterLength,\r
-        .exactMatchOnly  = true\r
-    };\r
+    _topicMatchParams_t topicMatchParams = { 0 };\r
+\r
+    topicMatchParams.pTopicName = pTopicFilter;\r
+    topicMatchParams.topicNameLength = topicFilterLength;\r
+    topicMatchParams.exactMatchOnly = false;\r
 \r
     /* Prevent any other thread from modifying the subscription list while this\r
      * function is running. */\r