X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-common%2Fwatch.h;h=86e63d3bf59f6afc15692dd56a293f87944e532d;hb=9c0f9c65093cfa53d45f9b68782321eb8063a032;hp=6d1a36e56fd56a12de6245a1860ffd428a961323;hpb=d9fd3e92dd9ae1b51e22053510da90c5af563bfd;p=catta diff --git a/avahi-common/watch.h b/avahi-common/watch.h index 6d1a36e..86e63d3 100644 --- a/avahi-common/watch.h +++ b/avahi-common/watch.h @@ -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 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); };