D-Bus: dbus-watch.h Source File

D-Bus 1.14.4

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
29 DBUS_BEGIN_DECLS
30
36/* Public methods on DBusWatch are in dbus-connection.h */
37
38 typedef struct DBusWatchList DBusWatchList;
39
40#define _DBUS_WATCH_NVAL (1<<4)
41
43 typedef dbus_bool_t (* DBusWatchHandler) (DBusWatch *watch,
44 unsigned int flags,
45 void *data);
46
47DBUS_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);
54DBUS_PRIVATE_EXPORT
55 DBusWatch* _dbus_watch_ref (DBusWatch *watch);
56DBUS_PRIVATE_EXPORT
57void _dbus_watch_unref (DBusWatch *watch);
58DBUS_PRIVATE_EXPORT
59void _dbus_watch_invalidate (DBusWatch *watch);
60void _dbus_watch_sanitize_condition (DBusWatch *watch,
61 unsigned int *condition);
62void _dbus_watch_set_handler (DBusWatch *watch,
63 DBusWatchHandler handler,
64 void *data,
65 DBusFreeFunction free_data_function);
66
67
68DBUS_PRIVATE_EXPORT
69 DBusWatchList* _dbus_watch_list_new (void);
70DBUS_PRIVATE_EXPORT
71void _dbus_watch_list_free (DBusWatchList *watch_list);
72DBUS_PRIVATE_EXPORT
73 dbus_bool_t _dbus_watch_list_set_functions (DBusWatchList *watch_list,
74 DBusAddWatchFunction add_function,
75 DBusRemoveWatchFunction remove_function,
76 DBusWatchToggledFunction toggled_function,
77 void *data,
78 DBusFreeFunction free_data_function);
79DBUS_PRIVATE_EXPORT
80 dbus_bool_t _dbus_watch_list_add_watch (DBusWatchList *watch_list,
81 DBusWatch *watch);
82DBUS_PRIVATE_EXPORT
83void _dbus_watch_list_remove_watch (DBusWatchList *watch_list,
84 DBusWatch *watch);
85void _dbus_watch_list_toggle_watch (DBusWatchList *watch_list,
86 DBusWatch *watch,
87 dbus_bool_t enabled);
88void _dbus_watch_list_toggle_all_watches (DBusWatchList *watch_list,
89 dbus_bool_t enabled);
90 dbus_bool_t _dbus_watch_get_enabled (DBusWatch *watch);
91
92DBUS_PRIVATE_EXPORT
93 dbus_bool_t _dbus_watch_get_oom_last_time (DBusWatch *watch);
94DBUS_PRIVATE_EXPORT
95void _dbus_watch_set_oom_last_time (DBusWatch *watch,
96 dbus_bool_t oom);
97
98 DBusSocket _dbus_watch_get_socket (DBusWatch *watch);
99DBUS_PRIVATE_EXPORT
100DBusPollable _dbus_watch_get_pollable (DBusWatch *watch);
101
102static inline void
103_dbus_clear_watch (DBusWatch **pointer_to_watch)
104{
105 _dbus_clear_pointer_impl (DBusWatch, pointer_to_watch,
106 _dbus_watch_unref);
107}
108
111 DBUS_END_DECLS
112
113#endif /* DBUS_WATCH_H */
DBusWatchToggledFunction
void(* DBusWatchToggledFunction)(DBusWatch *watch, void *data)
Called when dbus_watch_get_enabled() may return a different value than it did before.
Definition: dbus-connection.h:98
DBusAddWatchFunction
dbus_bool_t(* DBusAddWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus needs a new watch to be monitored by the main loop.
Definition: dbus-connection.h:92
DBusRemoveWatchFunction
void(* DBusRemoveWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus no longer needs a watch to be monitored by the main loop.
Definition: dbus-connection.h:104
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_watch_list_add_watch
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_watch_list_toggle_watch
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's DBusWatchToggledFunction if appro...
Definition: dbus-watch.c:441
_dbus_watch_list_new
DBusWatchList * _dbus_watch_list_new(void)
Creates a new watch list.
Definition: dbus-watch.c:232
_dbus_watch_list_free
void _dbus_watch_list_free(DBusWatchList *watch_list)
Frees a DBusWatchList.
Definition: dbus-watch.c:249
_dbus_watch_list_set_functions
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
_dbus_watch_set_handler
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
_dbus_watch_list_toggle_all_watches
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's DBusWatchToggledFunction if a...
Definition: dbus-watch.c:472
_dbus_watch_sanitize_condition
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
_dbus_watch_new
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
DBusWatchHandler
dbus_bool_t(* DBusWatchHandler)(DBusWatch *watch, unsigned int flags, void *data)
function to run when the watch is handled
Definition: dbus-watch.h:43
_dbus_watch_ref
DBusWatch * _dbus_watch_ref(DBusWatch *watch)
Increments the reference count of a DBusWatch object.
Definition: dbus-watch.c:124
_dbus_watch_unref
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
_dbus_watch_list_remove_watch
void _dbus_watch_list_remove_watch(DBusWatchList *watch_list, DBusWatch *watch)
Removes a watch from the watch list, invoking the application's DBusRemoveWatchFunction if appropriat...
Definition: dbus-watch.c:414
_dbus_watch_invalidate
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
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:181
DBusWatchList
DBusWatchList implementation details.
Definition: dbus-watch.c:215
DBusWatch
Implementation of DBusWatch.
Definition: dbus-watch.c:41