D-Bus  1.16.2
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  * SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
7  *
8  * Licensed under the Academic Free License version 2.1
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 #ifndef DBUS_WATCH_H
26 #define DBUS_WATCH_H
27 
28 #include <dbus/dbus-internals.h>
29 #include <dbus/dbus-connection.h>
30 
32 
38 /* Public methods on DBusWatch are in dbus-connection.h */
39 
41 
42 #define _DBUS_WATCH_NVAL (1<<4)
43 
46  unsigned int flags,
47  void *data);
48 
49 DBUS_PRIVATE_EXPORT
50 DBusWatch* _dbus_watch_new (DBusPollable fd,
51  unsigned int flags,
52  dbus_bool_t enabled,
53  DBusWatchHandler handler,
54  void *data,
55  DBusFreeFunction free_data_function);
56 DBUS_PRIVATE_EXPORT
58 DBUS_PRIVATE_EXPORT
59 void _dbus_watch_unref (DBusWatch *watch);
60 DBUS_PRIVATE_EXPORT
61 void _dbus_watch_invalidate (DBusWatch *watch);
63  unsigned int *condition);
65  DBusWatchHandler handler,
66  void *data,
67  DBusFreeFunction free_data_function);
68 
69 
70 DBUS_PRIVATE_EXPORT
72 DBUS_PRIVATE_EXPORT
73 void _dbus_watch_list_free (DBusWatchList *watch_list);
74 DBUS_PRIVATE_EXPORT
76  DBusAddWatchFunction add_function,
77  DBusRemoveWatchFunction remove_function,
78  DBusWatchToggledFunction toggled_function,
79  void *data,
80  DBusFreeFunction free_data_function);
81 DBUS_PRIVATE_EXPORT
83  DBusWatch *watch);
84 DBUS_PRIVATE_EXPORT
86  DBusWatch *watch);
88  DBusWatch *watch,
89  dbus_bool_t enabled);
91  dbus_bool_t enabled);
92 dbus_bool_t _dbus_watch_get_enabled (DBusWatch *watch);
93 
94 DBUS_PRIVATE_EXPORT
95 dbus_bool_t _dbus_watch_get_oom_last_time (DBusWatch *watch);
96 DBUS_PRIVATE_EXPORT
97 void _dbus_watch_set_oom_last_time (DBusWatch *watch,
98  dbus_bool_t oom);
99 
100 DBusSocket _dbus_watch_get_socket (DBusWatch *watch);
101 DBUS_PRIVATE_EXPORT
102 DBusPollable _dbus_watch_get_pollable (DBusWatch *watch);
103 
104 static inline void
105 _dbus_clear_watch (DBusWatch **pointer_to_watch)
106 {
107  _dbus_clear_pointer_impl (DBusWatch, pointer_to_watch,
109 }
110 
114 
115 #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:90
Implementation of DBusWatch.
Definition: dbus-watch.c:42
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:65
#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:45
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:443
void _dbus_watch_list_free(DBusWatchList *watch_list)
Frees a DBusWatchList.
Definition: dbus-watch.c:251
DBusWatchList * _dbus_watch_list_new(void)
Creates a new watch list.
Definition: dbus-watch.c:234
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:297
Socket interface.
Definition: dbus-sysdeps.h:185
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:37
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:187
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:474
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:171
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:383
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:216
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:416
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:140
DBusWatch * _dbus_watch_ref(DBusWatch *watch)
Increments the reference count of a DBusWatch object.
Definition: dbus-watch.c:126
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:500
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.