sntp: Add API to set update interval

Closes: https://github.com/espressif/esp-idf/issues/4437
Closes: IDFGH-2298
This commit is contained in:
Konstantin Kondrashov
2019-12-20 18:26:23 +08:00
committed by Mahavir Jain
parent 28314f9bb0
commit 98495e5939
3 changed files with 57 additions and 1 deletions

View File

@@ -120,6 +120,33 @@ void sntp_set_sync_status(sntp_sync_status_t sync_status);
*/
void sntp_set_time_sync_notification_cb(sntp_sync_time_cb_t callback);
/**
* @brief Set the sync interval of SNTP operation
*
* Note: SNTPv4 RFC 4330 enforces a minimum sync interval of 15 seconds.
* This sync interval will be used in the next attempt update time throught SNTP.
* To apply the new sync interval call the sntp_restart() function,
* otherwise, it will be applied after the last interval expired.
*
* @param interval_ms The sync interval in ms. It cannot be lower than 15 seconds, otherwise 15 seconds will be set.
*/
void sntp_set_sync_interval(uint32_t interval_ms);
/**
* @brief Get the sync interval of SNTP operation
*
* @return the sync interval
*/
uint32_t sntp_get_sync_interval(void);
/**
* @brief Restart SNTP
*
* @return True - Restart
* False - SNTP was not initialized yet
*/
bool sntp_restart(void);
#ifdef __cplusplus
}
#endif