D-Bus  1.13.7
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 
37 
38 typedef struct DBusServerVTable DBusServerVTable;
39 
44 {
45  void (* finalize) (DBusServer *server);
48  void (* disconnect) (DBusServer *server);
50 };
51 
56 struct DBusServer
57 {
69  char *address;
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 
95  const DBusServerVTable *vtable,
96  const DBusString *address,
97  DBusError *error);
99 void _dbus_server_disconnect_unlocked (DBusServer *server);
101  DBusWatch *watch);
103  DBusWatch *watch);
104 DBUS_PRIVATE_EXPORT
106  dbus_bool_t enabled);
108  DBusTimeout *timeout);
110  DBusTimeout *timeout);
112  DBusTimeout *timeout,
113  dbus_bool_t enabled);
114 
115 DBUS_PRIVATE_EXPORT
117 DBUS_PRIVATE_EXPORT
119 
120 typedef enum
121 {
122  DBUS_SERVER_LISTEN_NOT_HANDLED,
123  DBUS_SERVER_LISTEN_OK,
124  DBUS_SERVER_LISTEN_BAD_ADDRESS,
125  DBUS_SERVER_LISTEN_DID_NOT_CONNECT,
126  DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED
127 } DBusServerListenResult;
128 
129 DBusServerListenResult _dbus_server_listen_platform_specific (DBusAddressEntry *entry,
130  DBusServer **server_p,
131  DBusError *error);
132 
133 #ifdef DBUS_ENABLE_VERBOSE_MODE
134 void _dbus_server_trace_ref (DBusServer *server,
135  int old_refcount,
136  int new_refcount,
137  const char *why);
138 #else
139 #define _dbus_server_trace_ref(s,o,n,w) \
140  do \
141  {\
142  (void) (o); \
143  (void) (n); \
144  } while (0)
145 #endif
146 
147 #ifdef DBUS_DISABLE_CHECKS
148 #define TOOK_LOCK_CHECK(server)
149 #define RELEASING_LOCK_CHECK(server)
150 #define HAVE_LOCK_CHECK(server)
151 #else
152 #define TOOK_LOCK_CHECK(server) do { \
153  _dbus_assert (!(server)->have_server_lock); \
154  (server)->have_server_lock = TRUE; \
155  } while (0)
156 #define RELEASING_LOCK_CHECK(server) do { \
157  _dbus_assert ((server)->have_server_lock); \
158  (server)->have_server_lock = FALSE; \
159  } while (0)
160 #define HAVE_LOCK_CHECK(server) _dbus_assert ((server)->have_server_lock)
161 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
162 #endif
163 
164 #define TRACE_LOCKS 0
165 
166 #define SERVER_LOCK(server) do { \
167  if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
168  _dbus_rmutex_lock ((server)->mutex); \
169  TOOK_LOCK_CHECK (server); \
170  } while (0)
171 
172 #define SERVER_UNLOCK(server) do { \
173  if (TRACE_LOCKS) { _dbus_verbose ("UNLOCK\n"); } \
174  RELEASING_LOCK_CHECK (server); \
175  _dbus_rmutex_unlock ((server)->mutex); \
176  } while (0)
177 
179 
180 #endif /* DBUS_SERVER_PROTECTED_H */
An atomic integer safe to increment or decrement from multiple threads.
Definition: dbus-sysdeps.h:323
Internals of DBusTimeout.
Definition: dbus-timeout.c:40
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
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(* disconnect)(DBusServer *server)
Disconnect this server.
unsigned int disconnected
TRUE if we are disconnected.
Internals of DBusServer object.
A globally unique ID ; we have one for each DBusServer, and also one for each machine with libdbus in...
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
void(* DBusNewConnectionFunction)(DBusServer *server, DBusConnection *new_connection, void *data)
Called when a new connection to the server is available.
Definition: dbus-server.h:48
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 ...
DBusNewConnectionFunction new_connection_function
Callback to invoke when a new connection is created.
char ** auth_mechanisms
Array of allowed authentication mechanisms.
const DBusServerVTable * vtable
Virtual methods for this instance.
void(* finalize)(DBusServer *server)
The finalize method must free the server.
DBusRMutex * mutex
Lock on the server object.
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
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
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
DBusAtomic refcount
Reference count.
DBusTimeoutList * timeouts
Our timeouts.
Internals of DBusAddressEntry.
Definition: dbus-address.c:44
void _dbus_server_remove_watch(DBusServer *server, DBusWatch *watch)
Removes a watch previously added with _dbus_server_remove_watch().
Definition: dbus-server.c:312
Object representing an exception.
Definition: dbus-errors.h:48
void _dbus_server_remove_timeout(DBusServer *server, DBusTimeout *timeout)
Removes a timeout previously added with _dbus_server_add_timeout().
Definition: dbus-server.c:420
void _dbus_server_finalize_base(DBusServer *server)
Finalizes the members of the DBusServer base class.
Definition: dbus-server.c:201
Virtual table to be implemented by all server "subclasses".
DBusWatchList * watches
Our watches.
DBusDataSlotList slot_list
Data stored by allocated integer ID.
Data structure that stores the actual user data set at a given slot.
Definition: dbus-dataslot.h:69
char * address
Address this server is listening on.
dbus_bool_t published_address
flag which indicates that server has published its bus address.
DBusFreeFunction new_connection_free_data_function
Callback to invoke to free new_connection_data when server is finalized or data is replaced...
DBusWatchList implementation details.
Definition: dbus-watch.c:214
void * new_connection_data
Data for new connection callback.
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
unsigned int have_server_lock
Does someone have the server mutex locked.
DBusString guid_hex
Hex-encoded version of GUID.
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_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
DBusGUID guid
Globally unique ID of server.
int max_connections
Max number of connections allowed at once.
DBusTimeoutList implementation details.
Definition: dbus-timeout.c:180
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.