]> git.meshlink.io Git - catta/blobdiff - avahi-common/watch.h
forgot to pull the publish_no_reverse change to the example.
[catta] / avahi-common / watch.h
index bc8ae2f71c83df5da7073bc354f39ce31a919b5c..86e63d3bf59f6afc15692dd56a293f87944e532d 100644 (file)
@@ -1,21 +1,19 @@
 #ifndef foowatchhfoo
 #define foowatchhfoo
 
-/* $Id$ */
-
 /***
   This file is part of avahi.
+
   avahi is free software; you can redistribute it and/or modify it
   under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2.1 of the
   License, or (at your option) any later version.
+
   avahi is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
   Public License for more details.
+
   You should have received a copy of the GNU Lesser General Public
   License along with avahi; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
@@ -42,10 +40,10 @@ typedef struct AvahiPoll AvahiPoll;
 
 /** Type of watch events */
 typedef enum {
-    AVAHI_WATCH_IN = POLLIN,      /** Input event */
-    AVAHI_WATCH_OUT = POLLOUT,    /** Output event */
-    AVAHI_WATCH_ERR = POLLERR,    /** Error event */
-    AVAHI_WATCH_HUP = POLLHUP     /** Hangup event */
+    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 */
@@ -55,14 +53,14 @@ typedef void (*AvahiWatchCallback)(AvahiWatch *w, int fd, AvahiWatchEvent event,
 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
+ connect Avahi to other main loops. This is loosely 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 provider of the API */
-    void* userdata; 
+    void* userdata;
 
     /** Create a new watch for the specified file descriptor and for
      * the specified events. The API will call the callback function
@@ -86,9 +84,9 @@ struct AvahiPoll {
     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 */
+     * 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);
 };