X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;ds=sidebyside;f=avahi-common%2Fwatch.h;h=31adad7e51e55a23c92cdde04b59a9d279c78253;hb=4762665d22b1e3097b537e9a5e27d2f2b0bfcfde;hp=b973683c239083ca77ef12231251aebece6615e0;hpb=11fdf8612c684b0faf85781ef1b2766bf6ea1f0b;p=catta diff --git a/avahi-common/watch.h b/avahi-common/watch.h index b973683..31adad7 100644 --- a/avahi-common/watch.h +++ b/avahi-common/watch.h @@ -29,9 +29,7 @@ #include -#ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_BEGIN -#endif /** An I/O watch object */ typedef struct AvahiWatch AvahiWatch; @@ -44,10 +42,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 */ @@ -57,10 +55,10 @@ 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 */ @@ -88,16 +86,14 @@ 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); }; -#ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_END -#endif #endif