Changeset ba1b2194 in mainline for include/time/timeout.h

Timestamp:

2005-10-16T19:49:15Z (20 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

75eacab

Parents:

9cefba4

Message:

Doxygen comments.

File:

• include/time/timeout.h (modified) (2 diffs)

include/time/timeout.h

@@ -37 +37 @@
 #define us2ticks(us)    ((__u64)(((__u32) (us)/(1000000/HZ))))
 
-typedef void (* timeout_handler)(void *arg);
+typedef void (* timeout_handler_t)(void *arg);
 
 struct timeout {
         spinlock_t lock;
 
-        link_t link;
+        link_t link;                    /**< Link to the list of active timeouts on THE->cpu */
         
-        __u64 ticks;
+        __u64 ticks;                    /**< Timeout will be activated in this amount of clock() ticks. */
 
-        timeout_handler handler;
-        void *arg;
+        timeout_handler_t handler;      /**< Function that will be called on timeout activation. */
+        void *arg;                      /**< Argument to be passed to handler() function. */
         
-        cpu_t *cpu;
+        cpu_t *cpu;                     /**< On which processor is this timeout registered. */
 };
 
@@ -55 +55 @@
 extern void timeout_initialize(timeout_t *t);
 extern void timeout_reinitialize(timeout_t *t);
-extern void timeout_register(timeout_t *t, __u64 usec, timeout_handler f, void *arg);
-extern int timeout_unregister(timeout_t *t);
+extern void timeout_register(timeout_t *t, __u64 usec, timeout_handler_t f, void *arg);
+extern bool timeout_unregister(timeout_t *t);
 
 #endif