D-Bus  1.13.7
dbus-watch.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 
30 
36 /* Public methods on DBusWatch are in dbus-connection.h */
37 
39 
40 #define _DBUS_WATCH_NVAL (1<<4)
41 
44  unsigned int flags,
45  void *data);
46 
47 DBUS_PRIVATE_EXPORT
48 DBusWatch* _dbus_watch_new (DBusPollable fd,
49  unsigned int flags,
50  dbus_bool_t enabled,
51  DBusWatchHandler handler,
52  void *data,
53  DBusFreeFunction free_data_function);
54 DBUS_PRIVATE_EXPORT
56 DBUS_PRIVATE_EXPORT
57 void _dbus_watch_unref (DBusWatch *watch);
58 DBUS_PRIVATE_EXPORT
59 void _dbus_watch_invalidate (DBusWatch *watch);
61  unsigned int *condition);
63  DBusWatchHandler handler,
64  void *data,
65  DBusFreeFunction free_data_function);
66 
67 
68 DBUS_PRIVATE_EXPORT
70 DBUS_PRIVATE_EXPORT
71 void _dbus_watch_list_free (DBusWatchList *watch_list);
72 DBUS_PRIVATE_EXPORT
74  DBusAddWatchFunction add_function,
75  DBusRemoveWatchFunction remove_function,
76  DBusWatchToggledFunction toggled_function,
77  void *data,
78  DBusFreeFunction free_data_function);
79 DBUS_PRIVATE_EXPORT
81  DBusWatch *watch);
82 DBUS_PRIVATE_EXPORT
84  DBusWatch *watch);
86  DBusWatch *watch,
87  dbus_bool_t enabled);
89  dbus_bool_t enabled);
90 dbus_bool_t _dbus_watch_get_enabled (DBusWatch *watch);
91 
92 DBUS_PRIVATE_EXPORT
93 dbus_bool_t _dbus_watch_get_oom_last_time (DBusWatch *watch);
94 DBUS_PRIVATE_EXPORT
95 void _dbus_watch_set_oom_last_time (DBusWatch *watch,
96  dbus_bool_t oom);
97 
98 DBusSocket _dbus_watch_get_socket (DBusWatch *watch);
99 DBUS_PRIVATE_EXPORT
100 DBusPollable _dbus_watch_get_pollable (DBusWatch *watch);
101 
102 static inline void
103 _dbus_clear_watch (DBusWatch **pointer_to_watch)
104 {
105  _dbus_clear_pointer_impl (DBusWatch, pointer_to_watch,
107 }
108 
112 
113 #endif /* DBUS_WATCH_H */
DBusWatch * _dbus_watch_new(DBusPollable fd, unsigned int flags, dbus_bool_t enabled, DBusWatchHandler handler, void *data, DBusFreeFunction free_data_function)
Creates a new DBusWatch.
Definition: dbus-watch.c:88
Implementation of DBusWatch.
Definition: dbus-watch.c:40
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
void(* DBusWatchToggledFunction)(DBusWatch *watch, void *data)
Called when dbus_watch_get_enabled() may return a different value than it did before.
dbus_bool_t(* DBusWatchHandler)(DBusWatch *watch, unsigned int flags, void *data)
function to run when the watch is handled
Definition: dbus-watch.h:43
void _dbus_watch_list_toggle_watch(DBusWatchList *watch_list, DBusWatch *watch, dbus_bool_t enabled)
Sets a watch to the given enabled state, invoking the application&#39;s DBusWatchToggledFunction if appro...
Definition: dbus-watch.c:441
void _dbus_watch_list_free(DBusWatchList *watch_list)
Frees a DBusWatchList.
Definition: dbus-watch.c:249
DBusWatchList * _dbus_watch_list_new(void)
Creates a new watch list.
Definition: dbus-watch.c:232
dbus_bool_t _dbus_watch_list_set_functions(DBusWatchList *watch_list, DBusAddWatchFunction add_function, DBusRemoveWatchFunction remove_function, DBusWatchToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets the watch functions.
Definition: dbus-watch.c:295
Socket interface.
Definition: dbus-sysdeps.h:178
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
void _dbus_watch_sanitize_condition(DBusWatch *watch, unsigned int *condition)
Sanitizes the given condition so that it only contains flags that the DBusWatch requested.
Definition: dbus-watch.c:185
void _dbus_watch_list_toggle_all_watches(DBusWatchList *watch_list, dbus_bool_t enabled)
Sets all watches to the given enabled state, invoking the application&#39;s DBusWatchToggledFunction if a...
Definition: dbus-watch.c:472
void _dbus_watch_invalidate(DBusWatch *watch)
Clears the file descriptor from a now-invalid watch object so that no one tries to use it...
Definition: dbus-watch.c:169
dbus_bool_t _dbus_watch_list_add_watch(DBusWatchList *watch_list, DBusWatch *watch)
Adds a new watch to the watch list, invoking the application DBusAddWatchFunction if appropriate...
Definition: dbus-watch.c:381
dbus_bool_t(* DBusAddWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus needs a new watch to be monitored by the main loop.
void(* DBusRemoveWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus no longer needs a watch to be monitored by the main loop.
DBusWatchList implementation details.
Definition: dbus-watch.c:214
void _dbus_watch_list_remove_watch(DBusWatchList *watch_list, DBusWatch *watch)
Removes a watch from the watch list, invoking the application&#39;s DBusRemoveWatchFunction if appropriat...
Definition: dbus-watch.c:414
void _dbus_watch_unref(DBusWatch *watch)
Decrements the reference count of a DBusWatch object and finalizes the object if the count reaches ze...
Definition: dbus-watch.c:138
DBusWatch * _dbus_watch_ref(DBusWatch *watch)
Increments the reference count of a DBusWatch object.
Definition: dbus-watch.c:124
void _dbus_watch_set_handler(DBusWatch *watch, DBusWatchHandler handler, void *data, DBusFreeFunction free_data_function)
Sets the handler for the watch.
Definition: dbus-watch.c:498
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.