1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-server-protected.h Used by subclasses of DBusServer object (internal to D-Bus implementation)
4 * Copyright (C) 2002 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #ifndef DBUS_SERVER_PROTECTED_H
24 #define DBUS_SERVER_PROTECTED_H
27 #include <dbus/dbus-internals.h>
28 #include <dbus/dbus-threads-internal.h>
29 #include <dbus/dbus-server.h>
30 #include <dbus/dbus-address.h>
31 #include <dbus/dbus-timeout.h>
32 #include <dbus/dbus-watch.h>
33 #include <dbus/dbus-resources.h>
34 #include <dbus/dbus-dataslot.h>
35 #include <dbus/dbus-string.h>
39 typedef struct DBusServerVTable DBusServerVTable;
40 typedef union DBusGUID DBusGUID;
43 * A server's globally unique ID
47 dbus_uint32_t as_uint32s[4];
48 unsigned char as_bytes[16];
52 * Virtual table to be implemented by all server "subclasses"
54 struct DBusServerVTable
56 void (* finalize) (DBusServer *server);
57 /**< The finalize method must free the server. */
59 void (* disconnect) (DBusServer *server);
60 /**< Disconnect this server. */
64 * Internals of DBusServer object
68 DBusAtomic refcount; /**< Reference count. */
69 const DBusServerVTable *vtable; /**< Virtual methods for this instance. */
70 DBusMutex *mutex; /**< Lock on the server object */
72 DBusGUID guid; /**< Globally unique ID of server */
74 DBusString guid_hex; /**< Hex-encoded version of GUID */
76 DBusWatchList *watches; /**< Our watches */
77 DBusTimeoutList *timeouts; /**< Our timeouts */
79 char *address; /**< Address this server is listening on. */
81 int max_connections; /**< Max number of connections allowed at once. */
83 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
85 DBusNewConnectionFunction new_connection_function;
86 /**< Callback to invoke when a new connection is created. */
87 void *new_connection_data;
88 /**< Data for new connection callback */
89 DBusFreeFunction new_connection_free_data_function;
90 /**< Callback to invoke to free new_connection_data
91 * when server is finalized or data is replaced.
94 char **auth_mechanisms; /**< Array of allowed authentication mechanisms */
96 unsigned int disconnected : 1; /**< TRUE if we are disconnected. */
98 #ifndef DBUS_DISABLE_CHECKS
99 unsigned int have_server_lock : 1; /**< Does someone have the server mutex locked */
103 dbus_bool_t _dbus_server_init_base (DBusServer *server,
104 const DBusServerVTable *vtable,
105 const DBusString *address);
106 void _dbus_server_finalize_base (DBusServer *server);
107 dbus_bool_t _dbus_server_add_watch (DBusServer *server,
109 void _dbus_server_remove_watch (DBusServer *server,
111 void _dbus_server_toggle_watch (DBusServer *server,
113 dbus_bool_t enabled);
114 dbus_bool_t _dbus_server_add_timeout (DBusServer *server,
115 DBusTimeout *timeout);
116 void _dbus_server_remove_timeout (DBusServer *server,
117 DBusTimeout *timeout);
118 void _dbus_server_toggle_timeout (DBusServer *server,
119 DBusTimeout *timeout,
120 dbus_bool_t enabled);
122 void _dbus_server_ref_unlocked (DBusServer *server);
123 void _dbus_server_unref_unlocked (DBusServer *server);
127 DBUS_SERVER_LISTEN_NOT_HANDLED, /**< we aren't in charge of this address type */
128 DBUS_SERVER_LISTEN_OK, /**< we set up the listen */
129 DBUS_SERVER_LISTEN_BAD_ADDRESS, /**< malformed address */
130 DBUS_SERVER_LISTEN_DID_NOT_CONNECT /**< well-formed address but failed to set it up */
131 } DBusServerListenResult;
133 DBusServerListenResult _dbus_server_listen_platform_specific (DBusAddressEntry *entry,
134 DBusServer **server_p,
136 void _dbus_server_set_bad_address (DBusError *error,
137 const char *address_problem_type,
138 const char *address_problem_field,
139 const char *address_problem_other);
141 #ifdef DBUS_DISABLE_CHECKS
142 #define TOOK_LOCK_CHECK(server)
143 #define RELEASING_LOCK_CHECK(server)
144 #define HAVE_LOCK_CHECK(server)
146 #define TOOK_LOCK_CHECK(server) do { \
147 _dbus_assert (!(server)->have_server_lock); \
148 (server)->have_server_lock = TRUE; \
150 #define RELEASING_LOCK_CHECK(server) do { \
151 _dbus_assert ((server)->have_server_lock); \
152 (server)->have_server_lock = FALSE; \
154 #define HAVE_LOCK_CHECK(server) _dbus_assert ((server)->have_server_lock)
155 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
158 #define TRACE_LOCKS 0
160 #define SERVER_LOCK(server) do { \
161 if (TRACE_LOCKS) { _dbus_verbose (" LOCK: %s\n", _DBUS_FUNCTION_NAME); } \
162 _dbus_mutex_lock ((server)->mutex); \
163 TOOK_LOCK_CHECK (server); \
166 #define SERVER_UNLOCK(server) do { \
167 if (TRACE_LOCKS) { _dbus_verbose (" UNLOCK: %s\n", _DBUS_FUNCTION_NAME); } \
168 RELEASING_LOCK_CHECK (server); \
169 _dbus_mutex_unlock ((server)->mutex); \
174 #endif /* DBUS_SERVER_PROTECTED_H */