Remove the simple UDP client/server tasks from the MQTT demo as the demo's network...

[freertos] / FreeRTOS-Plus / Demo / FreeRTOS_IoT_Libraries / task_pool / iot_config.h

diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/task_pool/iot_config.h b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/task_pool/iot_config.h
index 470a13d6daddd8045d9764e91524932a637e7c0e..0121f276dbb287f0a2cc2d0f0c629166ec23638f 100644 (file)
--- a/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/task_pool/iot_config.h
+++ b/FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/task_pool/iot_config.h
@@ -59,6 +59,17 @@
  */\r
 #define IOT_TASKPOOL_ENABLE_ASSERTS 1\r
 \r
+/*\r
+ * The full IoT Task Pool Library has many use cases, including Linux\r
+ * development.  Typical FreeRTOS use cases do not require the full\r
+ * functionality so an optimised implementation is provided specifically for use\r
+ * with FreeRTOS.  The optimised version has a fixed number of tasks in the\r
+ * pool, each of which uses statically allocated memory to ensure creation of\r
+ * the pool is guaranteed (it does not run out of heap space).\r
+ * IOT_TASKPOOL_NUMBER_OF_WORKERS sets the number of tasks in the pool.\r
+ */\r
+#define IOT_TASKPOOL_NUMBER_OF_WORKERS               3\r
+\r
 /*\r
  * Set the log level of the task pool library.\r
  *\r
@@ -71,15 +82,14 @@
  */\r
 #define IOT_LOG_LEVEL_TASKPOOL IOT_LOG_INFO\r
 \r
-/*\r
- *\r
- */\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
 /* Include the common configuration file for FreeRTOS. */\r
 #include "iot_config_common.h"\r