Update core_mqtt.h

FreeRTOS · Sep 12, 2022 · 4de36cf · 4de36cf
1 parent 02f8f8e
commit 4de36cf
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/source/include/core_mqtt.h b/source/include/core_mqtt.h
@@ -70,6 +70,9 @@ struct MQTTDeserializedInfo;
  * @brief Application provided function to query the time elapsed since a given
  * epoch in milliseconds.
  *
+ * @note The timer should be a monotonic timer. It just needs to provide an
+ * incrementing count of milliseconds elapsed since a given epoch.
+ *
  * @return The time elapsed in milliseconds.
  */
 typedef uint32_t (* MQTTGetCurrentTimeFunc_t )( void );