From b56166f5a6dd2eaef4861c50cbb11b3568aa040e Mon Sep 17 00:00:00 2001 From: "zugz (tox)" Date: Wed, 31 Oct 2018 19:33:32 +0100 Subject: [PATCH] Add some hopefully helpful documentation to the functions in mono_time.h (I found I couldn't remember whether get_mono_time returned unix time or not, and had to source-dive to find out. This should make that unnecessary next time!) --- toxcore/mono_time.h | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/toxcore/mono_time.h b/toxcore/mono_time.h index 503548f222..aa244baeb0 100644 --- a/toxcore/mono_time.h +++ b/toxcore/mono_time.h @@ -45,11 +45,26 @@ typedef struct Mono_Time Mono_Time; Mono_Time *mono_time_new(void); void mono_time_free(Mono_Time *mono_time); +/** + * Update mono_time; subsequent calls to mono_time_get or mono_time_is_timeout + * will use the time at the call to mono_time_update. + */ void mono_time_update(Mono_Time *mono_time); + +/** + * Return unix time since epoch in seconds. + */ uint64_t mono_time_get(const Mono_Time *mono_time); + +/** + * Return true iff timestamp is at least timeout seconds in the past. + */ bool mono_time_is_timeout(const Mono_Time *mono_time, uint64_t timestamp, uint64_t timeout); -/* return current monotonic time in milliseconds (ms). */ +/** + * Return current monotonic time in milliseconds (ms). The starting point is + * unspecified. + */ uint64_t current_time_monotonic(Mono_Time *mono_time); typedef uint64_t mono_time_current_time_cb(Mono_Time *mono_time, void *user_data);