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 40 /** 41 * Virtual table to be implemented by all server "subclasses" 42 */ 43 struct DBusServerVTable 44 { 45 void (* finalize) (DBusServer *server); 46 /**< The finalize method must free the server. */ 47 48 void (* disconnect) (DBusServer *server); 49 /**< Disconnect this server. */ 50 }; 51 52 /** 53 * @ingroup DBusServerInternals 54 * Internals of DBusServer object 55 */ 56 struct DBusServer 57 { 58 DBusAtomic refcount; /**< Reference count. */ 59 const DBusServerVTable *vtable; /**< Virtual methods for this instance. */ 60 DBusRMutex *mutex; /**< Lock on the server object */ 61 62 DBusGUID guid; /**< Globally unique ID of server */ 63 64 DBusString guid_hex; /**< Hex-encoded version of GUID */ 65 66 DBusWatchList *watches; /**< Our watches */ 67 DBusTimeoutList *timeouts; /**< Our timeouts */ 68 69 char *address; /**< Address this server is listening on. */ 70 dbus_bool_t published_address; /**< flag which indicates that server has published its bus address. */ 71 72 int max_connections; /**< Max number of connections allowed at once. */ 73 74 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */ 75 76 DBusNewConnectionFunction new_connection_function; 77 /**< Callback to invoke when a new connection is created. */ 78 void *new_connection_data; 79 /**< Data for new connection callback */ 80 DBusFreeFunction new_connection_free_data_function; 81 /**< Callback to invoke to free new_connection_data 82 * when server is finalized or data is replaced. 83 */ 84 85 char **auth_mechanisms; /**< Array of allowed authentication mechanisms */ 86 87 unsigned int disconnected : 1; /**< TRUE if we are disconnected. */ 88 89 #ifndef DBUS_DISABLE_CHECKS 90 unsigned int have_server_lock : 1; /**< Does someone have the server mutex locked */ 91 #endif 92 }; 93 94 dbus_bool_t _dbus_server_init_base (DBusServer *server, 95 const DBusServerVTable *vtable, 96 const DBusString *address); 97 void _dbus_server_finalize_base (DBusServer *server); 98 dbus_bool_t _dbus_server_add_watch (DBusServer *server, 99 DBusWatch *watch); 100 void _dbus_server_remove_watch (DBusServer *server, 101 DBusWatch *watch); 102 void _dbus_server_toggle_watch (DBusServer *server, 103 DBusWatch *watch, 104 dbus_bool_t enabled); 105 dbus_bool_t _dbus_server_add_timeout (DBusServer *server, 106 DBusTimeout *timeout); 107 void _dbus_server_remove_timeout (DBusServer *server, 108 DBusTimeout *timeout); 109 void _dbus_server_toggle_timeout (DBusServer *server, 110 DBusTimeout *timeout, 111 dbus_bool_t enabled); 112 113 void _dbus_server_ref_unlocked (DBusServer *server); 114 void _dbus_server_unref_unlocked (DBusServer *server); 115 116 typedef enum 117 { 118 DBUS_SERVER_LISTEN_NOT_HANDLED, /**< we aren't in charge of this address type */ 119 DBUS_SERVER_LISTEN_OK, /**< we set up the listen */ 120 DBUS_SERVER_LISTEN_BAD_ADDRESS, /**< malformed address */ 121 DBUS_SERVER_LISTEN_DID_NOT_CONNECT, /**< well-formed address but failed to set it up */ 122 DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED /**< address is already used */ 123 } DBusServerListenResult; 124 125 DBusServerListenResult _dbus_server_listen_platform_specific (DBusAddressEntry *entry, 126 DBusServer **server_p, 127 DBusError *error); 128 129 #ifdef DBUS_ENABLE_VERBOSE_MODE 130 void _dbus_server_trace_ref (DBusServer *server, 131 int old_refcount, 132 int new_refcount, 133 const char *why); 134 #else 135 #define _dbus_server_trace_ref(s,o,n,w) \ 136 do \ 137 {\ 138 (void) (o); \ 139 (void) (n); \ 140 } while (0) 141 #endif 142 143 #ifdef DBUS_DISABLE_CHECKS 144 #define TOOK_LOCK_CHECK(server) 145 #define RELEASING_LOCK_CHECK(server) 146 #define HAVE_LOCK_CHECK(server) 147 #else 148 #define TOOK_LOCK_CHECK(server) do { \ 149 _dbus_assert (!(server)->have_server_lock); \ 150 (server)->have_server_lock = TRUE; \ 151 } while (0) 152 #define RELEASING_LOCK_CHECK(server) do { \ 153 _dbus_assert ((server)->have_server_lock); \ 154 (server)->have_server_lock = FALSE; \ 155 } while (0) 156 #define HAVE_LOCK_CHECK(server) _dbus_assert ((server)->have_server_lock) 157 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */ 158 #endif 159 160 #define TRACE_LOCKS 0 161 162 #define SERVER_LOCK(server) do { \ 163 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \ 164 _dbus_rmutex_lock ((server)->mutex); \ 165 TOOK_LOCK_CHECK (server); \ 166 } while (0) 167 168 #define SERVER_UNLOCK(server) do { \ 169 if (TRACE_LOCKS) { _dbus_verbose ("UNLOCK\n"); } \ 170 RELEASING_LOCK_CHECK (server); \ 171 _dbus_rmutex_unlock ((server)->mutex); \ 172 } while (0) 173 174 DBUS_END_DECLS 175 176 #endif /* DBUS_SERVER_PROTECTED_H */ 177
