X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Futil%2Ftimer.h;h=22a5ee3607334ef222c11fd25f945fba308fa0c9;hb=bab0811f845cedb817a3c3a29dd91ade07d5a886;hp=df06fc3453ce7e3b879d2e16debd795bf71786c2;hpb=7afcc1abf6cdf512244fc11529dde53e53f110ea;p=chaz%2Ftint2

diff --git a/src/util/timer.h b/src/util/timer.h
index df06fc3..22a5ee3 100644
--- a/src/util/timer.h
+++ b/src/util/timer.h
@@ -25,30 +25,36 @@ extern GSList* timeout_list;
 extern struct timeval next_timeout;
 
 
-struct timeout {
-	int interval_msec;
-	struct timespec timeout_expires;
-	void (*_callback)(void*);
-	void* arg;
-	void* multi_timeout;
-};
+typedef struct _timeout timeout;
 
 
 // timer functions
+/**
+  * Single shot timer (i.e. timer with interval_msec == 0) are deleted automatically as soon as they expire
+  * i.e. you do not need to stop them, however it is safe to call stop_timeout for these timers.
+  * Periodic timeouts are aligned to each other whenever possible, i.e. one interval_msec is an
+  * integral multiple of the other.
+**/
+
 /** installs a timeout with the first timeout of 'value_msec' and then a periodic timeout with
-	* 'interval_msec'. '_callback' is the callback function when the timer reaches the timeout.
-	* returns a pointer to the timeout, which is needed for stopping it again **/
-const struct timeout* add_timeout(int value_msec, int interval_msec, void (*_callback)(void*), void* arg);
+  * 'interval_msec'. '_callback' is the callback function when the timer reaches the timeout.
+  * returns a pointer to the timeout, which is needed for stopping it again
+**/
+timeout* add_timeout(int value_msec, int interval_msec, void (*_callback)(void*), void* arg);
 
-void change_timeout(const struct timeout* t, int value_msec, int interval_msec, void (*_callback)(void*), void* arg);
+/** changes timeout 't'. If timeout 't' does not exist, nothing happens **/
+void change_timeout(timeout* t, int value_msec, int interval_msec, void (*_callback)(void*), void* arg);
 
 /** stops the timeout 't' **/
-void stop_timeout(const struct timeout* t);
+void stop_timeout(timeout* t);
 
 /** stops all timeouts **/
 void stop_all_timeouts();
 
+/** update_next_timeout updates next_timeout to the value, when the next installed timeout will expire **/
 void update_next_timeout();
+
+/** Callback of all expired timeouts **/
 void callback_timeout_expired();
 
 #endif // TIMER_H