X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-common%2Fwatch.h;h=7bab4f8fb8140f309787d06fa3303dea15ddd118;hb=50be1d3adfb0d0c378b3464a99690441ab1e5f14;hp=70dedb73c806de36197af35ec6f039638ffaf57c;hpb=4f0a5e7572a4257894b4bfede42c26d65152609e;p=catta

diff --git a/avahi-common/watch.h b/avahi-common/watch.h
index 70dedb7..7bab4f8 100644
--- a/avahi-common/watch.h
+++ b/avahi-common/watch.h
@@ -22,37 +22,82 @@
   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 I/O watch object */
+typedef struct AvahiTimeout AvahiTimeout;
+
+/** 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);
-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.*/
 struct AvahiPoll {
-    void* userdata;
-    
-    AvahiWatch* (*watch_new)(AvahiPoll *api, int fd, AvahiWatchEvent event, AvahiWatchCallback callback, void *userdata);
+
+    /** Some abstract user data usable by the provider 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. It is safe to call this function from an AvahiWatchCallback */
     void (*watch_update)(AvahiWatch *w, AvahiWatchEvent event);
+
+    /** 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 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);
     
-    void (*set_wakeup)(AvahiPoll *api, const struct timeval *tv, AvahiWakeupCallback callback, void *userdata);
+    /** 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