2006-10-21 Havoc Pennington <hp@redhat.com>
[platform/upstream/dbus.git] / dbus / dbus-watch.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-watch.h DBusWatch internal interfaces
3  *
4  * Copyright (C) 2002  Red Hat Inc.
5  *
6  * Licensed under the Academic Free License version 2.1
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  */
23 #ifndef DBUS_WATCH_H
24 #define DBUS_WATCH_H
25
26 #include <dbus/dbus-internals.h>
27 #include <dbus/dbus-connection.h>
28
29 DBUS_BEGIN_DECLS
30
31 /**
32  * @addtogroup DBusWatchInternals
33  * @{
34  */
35
36 /* Public methods on DBusWatch are in dbus-connection.h */
37
38 typedef struct DBusWatchList DBusWatchList;
39
40 typedef dbus_bool_t (* DBusWatchHandler) (DBusWatch    *watch,
41                                           unsigned int  flags,
42                                           void         *data);
43
44 DBusWatch* _dbus_watch_new                (int               fd,
45                                            unsigned int      flags,
46                                            dbus_bool_t       enabled,
47                                            DBusWatchHandler  handler,
48                                            void             *data,
49                                            DBusFreeFunction  free_data_function);
50 DBusWatch* _dbus_watch_ref                (DBusWatch        *watch);
51 void       _dbus_watch_unref              (DBusWatch        *watch);
52 void       _dbus_watch_invalidate         (DBusWatch        *watch);
53 void       _dbus_watch_sanitize_condition (DBusWatch        *watch,
54                                            unsigned int     *condition);
55 void       _dbus_watch_set_handler        (DBusWatch        *watch,
56                                            DBusWatchHandler  handler,
57                                            void             *data,
58                                            DBusFreeFunction  free_data_function);
59
60
61 DBusWatchList* _dbus_watch_list_new           (void);
62 void           _dbus_watch_list_free          (DBusWatchList           *watch_list);
63 dbus_bool_t    _dbus_watch_list_set_functions (DBusWatchList           *watch_list,
64                                                DBusAddWatchFunction     add_function,
65                                                DBusRemoveWatchFunction  remove_function,
66                                                DBusWatchToggledFunction toggled_function,
67                                                void                    *data,
68                                                DBusFreeFunction         free_data_function);
69 dbus_bool_t    _dbus_watch_list_add_watch     (DBusWatchList           *watch_list,
70                                                DBusWatch               *watch);
71 void           _dbus_watch_list_remove_watch  (DBusWatchList           *watch_list,
72                                                DBusWatch               *watch);
73 void           _dbus_watch_list_toggle_watch  (DBusWatchList           *watch_list,
74                                                DBusWatch               *watch,
75                                                dbus_bool_t              enabled);
76
77 /** @} */
78
79 DBUS_END_DECLS
80
81 #endif /* DBUS_WATCH_H */