From fcc9b0efe1accdb0edcb3143a8e15782e69383db Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Sun, 14 Aug 2005 02:33:41 +0000
Subject: * doxygen documentation updates * make AvahiPoll objects const * make
 poll() functions pluggable in AvahiSimplePoll

git-svn-id: file:///home/lennart/svn/public/avahi/trunk@314 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
---
 avahi-common/watch.h | 49 ++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 40 insertions(+), 9 deletions(-)

(limited to 'avahi-common/watch.h')

diff --git a/avahi-common/watch.h b/avahi-common/watch.h
index 70dedb7..75f53b3 100644
--- a/avahi-common/watch.h
+++ b/avahi-common/watch.h
@@ -22,37 +22,68 @@
   USA.
 ***/
 
+/** \file watch.h Simplistic main loop abstraction */
+
 #include <sys/poll.h>
 #include <avahi-common/cdecl.h>
 
 #include "timeval.h"
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_BEGIN
+#endif
 
+/** An I/O watch object */
 typedef struct AvahiWatch AvahiWatch;
+
+/** An event polling abstraction object */
 typedef struct AvahiPoll AvahiPoll;
 
+/** Type of watch events */
 typedef enum {
-    AVAHI_WATCH_IN = POLLIN,
-    AVAHI_WATCH_OUT = POLLOUT,
-    AVAHI_WATCH_ERR = POLLERR,
-    AVAHI_WATCH_HUP = POLLHUP
+    AVAHI_WATCH_IN = POLLIN,      /** Input event */
+    AVAHI_WATCH_OUT = POLLOUT,    /** Output event */
+    AVAHI_WATCH_ERR = POLLERR,    /** Error event */
+    AVAHI_WATCH_HUP = POLLHUP     /** Hangup event */
 } AvahiWatchEvent;
 
+/** 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);
 
+/** 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.*/
 struct AvahiPoll {
-    void* userdata;
-    
-    AvahiWatch* (*watch_new)(AvahiPoll *api, int fd, AvahiWatchEvent event, AvahiWatchCallback callback, void *userdata);
+
+    /** Some abstract user data usable by the implementor of the API */
+    void* userdata; 
+
+    /** Create a new watch for the specified file descriptor and for
+     * the specified events. The API will call the callback function
+     * 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. */
     void (*watch_update)(AvahiWatch *w, AvahiWatchEvent event);
+
+    /** Free a watch */
     void (*watch_free)(AvahiWatch *w);
-    
-    void (*set_wakeup)(AvahiPoll *api, const struct timeval *tv, AvahiWakeupCallback callback, void *userdata);
+
+    /** 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);
 };
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END
+#endif
 
 #endif
 
-- 
cgit