Skip to content

Commit

Permalink
added documentation for delegate functions
Browse files Browse the repository at this point in the history
  • Loading branch information
fessehaeve committed Apr 12, 2024
1 parent 6f72174 commit 78e78fb
Showing 1 changed file with 10 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,19 @@ class Delegate
}

/**
* @brief Signals application that UTCTime has changed through the timesync cluster.
* @brief Signals application that UTCTime has changed through the timesync cluster. This gets called when
* time is available for the first time or is updated. Therefore, @param time will always have a valid value.
* The negative case of time being unavailable is handled by NotifyTimeFailure().
*/
virtual void UTCTimeAvailabilityChanged(uint64_t time) {}
/**
* @brief Signals application that a new trusted time source is available. The application can then decide
* if it wants to attempt to query for time from this source.
*/
virtual void TrustedTimeSourceAvailabilityChanged(bool available, GranularityEnum granularity) {}
/**
* @brief Signals application that fetching time has failed. The reason is not relevant.
*/
virtual void NotifyTimeFailure() {}

virtual ~Delegate() = default;
Expand Down

0 comments on commit 78e78fb

Please sign in to comment.