]> git.meshlink.io Git - catta/blob - avahi-common/watch.h
* do no longer include timeval.h in watch.h by default
[catta] / avahi-common / watch.h
1 #ifndef foowatchhfoo
2 #define foowatchhfoo
3
4 /* $Id$ */
5
6 /***
7   This file is part of avahi.
8  
9   avahi is free software; you can redistribute it and/or modify it
10   under the terms of the GNU Lesser General Public License as
11   published by the Free Software Foundation; either version 2.1 of the
12   License, or (at your option) any later version.
13  
14   avahi is distributed in the hope that it will be useful, but WITHOUT
15   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
17   Public License for more details.
18  
19   You should have received a copy of the GNU Lesser General Public
20   License along with avahi; if not, write to the Free Software
21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22   USA.
23 ***/
24
25 /** \file watch.h Simplistic main loop abstraction */
26
27 #include <sys/poll.h>
28 #include <sys/time.h>
29
30 #include <avahi-common/cdecl.h>
31
32 #ifndef DOXYGEN_SHOULD_SKIP_THIS
33 AVAHI_C_DECL_BEGIN
34 #endif
35
36 /** An I/O watch object */
37 typedef struct AvahiWatch AvahiWatch;
38
39 /** A timeout watch object */
40 typedef struct AvahiTimeout AvahiTimeout;
41
42 /** An event polling abstraction object */
43 typedef struct AvahiPoll AvahiPoll;
44
45 /** Type of watch events */
46 typedef enum {
47     AVAHI_WATCH_IN = POLLIN,      /** Input event */
48     AVAHI_WATCH_OUT = POLLOUT,    /** Output event */
49     AVAHI_WATCH_ERR = POLLERR,    /** Error event */
50     AVAHI_WATCH_HUP = POLLHUP     /** Hangup event */
51 } AvahiWatchEvent;
52
53 /** Called whenever an I/O event happens  on an I/O watch */
54 typedef void (*AvahiWatchCallback)(AvahiWatch *w, int fd, AvahiWatchEvent event, void *userdata);
55
56 /** Called when the timeout is reached */
57 typedef void (*AvahiTimeoutCallback)(AvahiTimeout *t, void *userdata);
58
59 /** Defines an abstracted event polling API. This may be used to
60  connect Avahi to other main loops. This is losely based on Unix
61  poll(2). A consumer will call watch_new() for all file descriptors it
62  wants to listen for events on. In addition he can call set_wakeup()
63  to define a single wakeup time.*/
64 struct AvahiPoll {
65
66     /** Some abstract user data usable by the provider of the API */
67     void* userdata; 
68
69     /** Create a new watch for the specified file descriptor and for
70      * the specified events. The API will call the callback function
71      * whenever any of the events happens. */
72     AvahiWatch* (*watch_new)(const AvahiPoll *api, int fd, AvahiWatchEvent event, AvahiWatchCallback callback, void *userdata);
73
74     /** Update the events to wait for. It is safe to call this function from an AvahiWatchCallback */
75     void (*watch_update)(AvahiWatch *w, AvahiWatchEvent event);
76
77     /** Return the events that happened. It is safe to call this function from an AvahiWatchCallback  */
78     AvahiWatchEvent (*watch_get_events)(AvahiWatch *w);
79
80     /** Free a watch. It is safe to call this function from an AvahiWatchCallback */
81     void (*watch_free)(AvahiWatch *w);
82
83     /** Set a wakeup time for the polling loop. The API will call the
84     callback function when the absolute time *tv is reached. If tv is
85     NULL, the timeout is disabled. After the timeout expired the
86     callback function will be called and the timeout is disabled. You
87     can reenable it by calling timeout_update()  */
88     AvahiTimeout* (*timeout_new)(const AvahiPoll *api, const struct timeval *tv, AvahiTimeoutCallback callback, void *userdata);
89
90     /** Update the absolute expiration time for a timeout, If tv is
91      * null, the timeout is disabled. It is safe to call this function from an AvahiTimeoutCallback */
92     void (*timeout_update)(AvahiTimeout *, const struct timeval *tv);
93     
94     /** Free a timeout. It is safe to call this function from an AvahiTimeoutCallback */
95     void (*timeout_free)(AvahiTimeout *t);
96 };
97
98 #ifndef DOXYGEN_SHOULD_SKIP_THIS
99 AVAHI_C_DECL_END
100 #endif
101
102 #endif
103