make anonymous structs appear properly in doxygen

[catta] / avahi-common / watch.h

diff --git a/avahi-common/watch.h b/avahi-common/watch.h
index 75f53b36db2a1bad0a982a5ee53c6db4818416f9..c779a58214f81f728c592e12cac11412be354943 100644 (file)
--- a/avahi-common/watch.h
+++ b/avahi-common/watch.h
@@ -25,17 +25,18 @@
 /** \file watch.h Simplistic main loop abstraction */
 
 #include <sys/poll.h>
-#include <avahi-common/cdecl.h>
+#include <sys/time.h>
 
-#include "timeval.h"
+#include <avahi-common/cdecl.h>
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_BEGIN
-#endif
 
-/** An I/O watch object */
+/** \struct AvahiWatch An I/O watch object */
 typedef struct AvahiWatch AvahiWatch;
 
+/** \struct AvahiTimeout A timeout watch object */
+typedef struct AvahiTimeout AvahiTimeout;
+
 /** An event polling abstraction object */
 typedef struct AvahiPoll AvahiPoll;
 
@@ -50,17 +51,17 @@ typedef enum {
 /** Called whenever an I/O event happens  on an I/O watch */
 typedef void (*AvahiWatchCallback)(AvahiWatch *w, int fd, AvahiWatchEvent event, void *userdata);
 
-/** Called when the wakeup time is reached */
-typedef void (*AvahiWakeupCallback)(AvahiPoll *api, void *userdata);
+/** Called when the timeout is reached */
+typedef void (*AvahiTimeoutCallback)(AvahiTimeout *t, void *userdata);
 
 /** Defines an abstracted event polling API. This may be used to
  connect Avahi to other main loops. This is losely based on Unix
  poll(2). A consumer will call watch_new() for all file descriptors it
- wants to listen for events on. In addition he can call set_wakeup()
- to define a single wakeup time.*/
+ wants to listen for events on. In addition he can call timeout_new()
+ to define time based events .*/
 struct AvahiPoll {
 
-    /** Some abstract user data usable by the implementor of the API */
+    /** Some abstract user data usable by the provider of the API */
     void* userdata; 
 
     /** Create a new watch for the specified file descriptor and for
@@ -68,22 +69,31 @@ struct AvahiPoll {
      * whenever any of the events happens. */
     AvahiWatch* (*watch_new)(const AvahiPoll *api, int fd, AvahiWatchEvent event, AvahiWatchCallback callback, void *userdata);
 
-    /** Update the events to wait for. */
+    /** Update the events to wait for. It is safe to call this function from an AvahiWatchCallback */
     void (*watch_update)(AvahiWatch *w, AvahiWatchEvent event);
 
-    /** Free a watch */
+    /** Return the events that happened. It is safe to call this function from an AvahiWatchCallback  */
+    AvahiWatchEvent (*watch_get_events)(AvahiWatch *w);
+
+    /** Free a watch. It is safe to call this function from an AvahiWatchCallback */
     void (*watch_free)(AvahiWatch *w);
 
     /** Set a wakeup time for the polling loop. The API will call the
-    callback function when the absolute time *tv is reached. If *tv is
-    NULL, the callback will be called in the next main loop
-    iteration. If callback is NULL the wakeup time is disabled. */
-    void (*set_wakeup)(const AvahiPoll *api, const struct timeval *tv, AvahiWakeupCallback callback, void *userdata);
+    callback function when the absolute time *tv is reached. If tv is
+    NULL, the timeout is disabled. After the timeout expired the
+    callback function will be called and the timeout is disabled. You
+    can reenable it by calling timeout_update()  */
+    AvahiTimeout* (*timeout_new)(const AvahiPoll *api, const struct timeval *tv, AvahiTimeoutCallback callback, void *userdata);
+
+    /** Update the absolute expiration time for a timeout, If tv is
+     * null, the timeout is disabled. It is safe to call this function from an AvahiTimeoutCallback */
+    void (*timeout_update)(AvahiTimeout *, const struct timeval *tv);
+    
+    /** Free a timeout. It is safe to call this function from an AvahiTimeoutCallback */
+    void (*timeout_free)(AvahiTimeout *t);
 };
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END
-#endif
 
 #endif