D-Bus: dbus-server-protected.h Source File

D-Bus 1.12.2

dbus-server-protected.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-server-protected.h Used by subclasses of DBusServer object (internal to D-Bus implementation)
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_SERVER_PROTECTED_H
24 #define DBUS_SERVER_PROTECTED_H
25
26 #include <dbus/dbus-internals.h>
27 #include <dbus/dbus-threads-internal.h>
28 #include <dbus/dbus-server.h>
29 #include <dbus/dbus-address.h>
30 #include <dbus/dbus-timeout.h>
31 #include <dbus/dbus-watch.h>
32 #include <dbus/dbus-resources.h>
33 #include <dbus/dbus-dataslot.h>
34 #include <dbus/dbus-string.h>
35
36 DBUS_BEGIN_DECLS
37
38 typedef struct DBusServerVTable DBusServerVTable;
39
43 struct DBusServerVTable
44 {
45 void (* finalize) (DBusServer *server);
48 void (* disconnect) (DBusServer *server);
50 };
51
56 struct DBusServer
57 {
58 DBusAtomic refcount;
59 const DBusServerVTable *vtable;
60 DBusRMutex *mutex;
62 DBusGUID guid;
64 DBusString guid_hex;
66 DBusWatchList *watches;
67 DBusTimeoutList *timeouts;
69 char *address;
70 dbus_bool_t published_address;
72 int max_connections;
74 DBusDataSlotList slot_list;
76 DBusNewConnectionFunction new_connection_function;
78 void *new_connection_data;
80 DBusFreeFunction new_connection_free_data_function;
85 char **auth_mechanisms;
87 unsigned int disconnected : 1;
89 #ifndef DBUS_DISABLE_CHECKS
90 unsigned int have_server_lock : 1;
91 #endif
92 };
93
94 dbus_bool_t _dbus_server_init_base (DBusServer *server,
95 const DBusServerVTable *vtable,
96 const DBusString *address,
97 DBusError *error);
98 void _dbus_server_finalize_base (DBusServer *server);
99 dbus_bool_t _dbus_server_add_watch (DBusServer *server,
100 DBusWatch *watch);
101 void _dbus_server_remove_watch (DBusServer *server,
102 DBusWatch *watch);
103 DBUS_PRIVATE_EXPORT
104 void _dbus_server_toggle_all_watches (DBusServer *server,
105 dbus_bool_t enabled);
106 dbus_bool_t _dbus_server_add_timeout (DBusServer *server,
107 DBusTimeout *timeout);
108 void _dbus_server_remove_timeout (DBusServer *server,
109 DBusTimeout *timeout);
110 void _dbus_server_toggle_timeout (DBusServer *server,
111 DBusTimeout *timeout,
112 dbus_bool_t enabled);
113
114 DBUS_PRIVATE_EXPORT
115 void _dbus_server_ref_unlocked (DBusServer *server);
116 DBUS_PRIVATE_EXPORT
117 void _dbus_server_unref_unlocked (DBusServer *server);
118
119 typedef enum
120 {
121 DBUS_SERVER_LISTEN_NOT_HANDLED,
122 DBUS_SERVER_LISTEN_OK,
123 DBUS_SERVER_LISTEN_BAD_ADDRESS,
124 DBUS_SERVER_LISTEN_DID_NOT_CONNECT,
125 DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED
126 } DBusServerListenResult;
127
128 DBusServerListenResult _dbus_server_listen_platform_specific (DBusAddressEntry *entry,
129 DBusServer **server_p,
130 DBusError *error);
131
132 #ifdef DBUS_ENABLE_VERBOSE_MODE
133 void _dbus_server_trace_ref (DBusServer *server,
134 int old_refcount,
135 int new_refcount,
136 const char *why);
137 #else
138 #define _dbus_server_trace_ref(s,o,n,w) \
139 do \
140 {\
141 (void) (o); \
142 (void) (n); \
143 } while (0)
144 #endif
145
146 #ifdef DBUS_DISABLE_CHECKS
147 #define TOOK_LOCK_CHECK(server)
148 #define RELEASING_LOCK_CHECK(server)
149 #define HAVE_LOCK_CHECK(server)
150 #else
151 #define TOOK_LOCK_CHECK(server) do { \
152 _dbus_assert (!(server)->have_server_lock); \
153 (server)->have_server_lock = TRUE; \
154 } while (0)
155 #define RELEASING_LOCK_CHECK(server) do { \
156 _dbus_assert ((server)->have_server_lock); \
157 (server)->have_server_lock = FALSE; \
158 } while (0)
159 #define HAVE_LOCK_CHECK(server) _dbus_assert ((server)->have_server_lock)
160 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
161 #endif
162
163 #define TRACE_LOCKS 0
164
165 #define SERVER_LOCK(server) do { \
166 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
167 _dbus_rmutex_lock ((server)->mutex); \
168 TOOK_LOCK_CHECK (server); \
169 } while (0)
170
171 #define SERVER_UNLOCK(server) do { \
172 if (TRACE_LOCKS) { _dbus_verbose ("UNLOCK\n"); } \
173 RELEASING_LOCK_CHECK (server); \
174 _dbus_rmutex_unlock ((server)->mutex); \
175 } while (0)
176
177 DBUS_END_DECLS
178
179 #endif /* DBUS_SERVER_PROTECTED_H */
DBusAtomic
An atomic integer safe to increment or decrement from multiple threads.
Definition: dbus-sysdeps.h:280
DBusTimeout
Internals of DBusTimeout.
Definition: dbus-timeout.c:40
_dbus_server_add_watch
dbus_bool_t _dbus_server_add_watch(DBusServer *server, DBusWatch *watch)
Adds a watch for this server, chaining out to application-provided watch handlers.
Definition: dbus-server.c:296
DBusWatch
Implementation of DBusWatch.
Definition: dbus-watch.c:40
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:64
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBusServerVTable::disconnect
void(* disconnect)(DBusServer *server)
Disconnect this server.
Definition: dbus-server-protected.h:48
DBusServer::disconnected
unsigned int disconnected
TRUE if we are disconnected.
Definition: dbus-server-protected.h:87
DBusServer
Internals of DBusServer object.
Definition: dbus-server-protected.h:56
DBusGUID
A globally unique ID ; we have one for each DBusServer, and also one for each machine with libdbus in...
Definition: dbus-internals.h:394
_dbus_server_ref_unlocked
DBUS_PRIVATE_EXPORT void _dbus_server_ref_unlocked(DBusServer *server)
Like dbus_server_ref() but does not acquire the lock (must already be held)
Definition: dbus-server.c:456
DBusNewConnectionFunction
void(* DBusNewConnectionFunction)(DBusServer *server, DBusConnection *new_connection, void *data)
Called when a new connection to the server is available.
Definition: dbus-server.h:48
_dbus_server_listen_platform_specific
DBusServerListenResult _dbus_server_listen_platform_specific(DBusAddressEntry *entry, DBusServer **server_p, DBusError *error)
Tries to interpret the address entry in a platform-specific way, creating a platform-specific server ...
Definition: dbus-server-unix.c:54
DBusServer::new_connection_function
DBusNewConnectionFunction new_connection_function
Callback to invoke when a new connection is created.
Definition: dbus-server-protected.h:76
DBusServer::auth_mechanisms
char ** auth_mechanisms
Array of allowed authentication mechanisms.
Definition: dbus-server-protected.h:85
DBusServer::vtable
const DBusServerVTable * vtable
Virtual methods for this instance.
Definition: dbus-server-protected.h:59
DBusServerVTable::finalize
void(* finalize)(DBusServer *server)
The finalize method must free the server.
Definition: dbus-server-protected.h:45
DBusServer::mutex
DBusRMutex * mutex
Lock on the server object.
Definition: dbus-server-protected.h:60
_dbus_server_toggle_timeout
void _dbus_server_toggle_timeout(DBusServer *server, DBusTimeout *timeout, dbus_bool_t enabled)
Toggles a timeout and notifies app via server&#39;s DBusTimeoutToggledFunction if available.
Definition: dbus-server.c:439
DBusString
Definition: dbus-string.h:42
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_server_unref_unlocked
DBUS_PRIVATE_EXPORT void _dbus_server_unref_unlocked(DBusServer *server)
Like dbus_server_unref() but does not acquire the lock (must already be held)
Definition: dbus-server.c:475
DBusServer::refcount
DBusAtomic refcount
Reference count.
Definition: dbus-server-protected.h:58
DBusServer::timeouts
DBusTimeoutList * timeouts
Our timeouts.
Definition: dbus-server-protected.h:67
DBusAddressEntry
Internals of DBusAddressEntry.
Definition: dbus-address.c:43
_dbus_server_remove_watch
void _dbus_server_remove_watch(DBusServer *server, DBusWatch *watch)
Removes a watch previously added with _dbus_server_remove_watch().
Definition: dbus-server.c:312
DBusError
Object representing an exception.
Definition: dbus-errors.h:48
_dbus_server_remove_timeout
void _dbus_server_remove_timeout(DBusServer *server, DBusTimeout *timeout)
Removes a timeout previously added with _dbus_server_add_timeout().
Definition: dbus-server.c:420
_dbus_server_finalize_base
void _dbus_server_finalize_base(DBusServer *server)
Finalizes the members of the DBusServer base class.
Definition: dbus-server.c:201
DBusServerVTable
Virtual table to be implemented by all server "subclasses".
Definition: dbus-server-protected.h:43
DBusServer::watches
DBusWatchList * watches
Our watches.
Definition: dbus-server-protected.h:66
DBusServer::slot_list
DBusDataSlotList slot_list
Data stored by allocated integer ID.
Definition: dbus-server-protected.h:74
DBusDataSlotList
Data structure that stores the actual user data set at a given slot.
Definition: dbus-dataslot.h:69
DBusServer::address
char * address
Address this server is listening on.
Definition: dbus-server-protected.h:69
DBusServer::published_address
dbus_bool_t published_address
flag which indicates that server has published its bus address.
Definition: dbus-server-protected.h:70
DBusServer::new_connection_free_data_function
DBusFreeFunction new_connection_free_data_function
Callback to invoke to free new_connection_data when server is finalized or data is replaced...
Definition: dbus-server-protected.h:80
DBusWatchList
DBusWatchList implementation details.
Definition: dbus-watch.c:214
DBusServer::new_connection_data
void * new_connection_data
Data for new connection callback.
Definition: dbus-server-protected.h:78
_dbus_server_init_base
dbus_bool_t _dbus_server_init_base(DBusServer *server, const DBusServerVTable *vtable, const DBusString *address, DBusError *error)
Initializes the members of the DBusServer base class.
Definition: dbus-server.c:112
DBusServer::have_server_lock
unsigned int have_server_lock
Does someone have the server mutex locked.
Definition: dbus-server-protected.h:90
DBusServer::guid_hex
DBusString guid_hex
Hex-encoded version of GUID.
Definition: dbus-server-protected.h:64
_dbus_server_toggle_all_watches
DBUS_PRIVATE_EXPORT void _dbus_server_toggle_all_watches(DBusServer *server, dbus_bool_t enabled)
Toggles all watch and notifies app via server&#39;s DBusWatchToggledFunction if available.
Definition: dbus-server.c:330
_dbus_server_add_timeout
dbus_bool_t _dbus_server_add_timeout(DBusServer *server, DBusTimeout *timeout)
Adds a timeout for this server, chaining out to application-provided timeout handlers.
Definition: dbus-server.c:405
DBusRMutex
Definition: dbus-sysdeps-pthread.c:49
DBusServer::guid
DBusGUID guid
Globally unique ID of server.
Definition: dbus-server-protected.h:62
DBusServer::max_connections
int max_connections
Max number of connections allowed at once.
Definition: dbus-server-protected.h:72
DBusTimeoutList
DBusTimeoutList implementation details.
Definition: dbus-timeout.c:180
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.