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)
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef DBUS_SERVER_PROTECTED_H
24 #define DBUS_SERVER_PROTECTED_H
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>
38 typedef struct DBusServerVTable DBusServerVTable;
41 * Virtual table to be implemented by all server "subclasses"
43 struct DBusServerVTable
45 void (* finalize) (DBusServer *server);
46 /**< The finalize method must free the server. */
48 void (* disconnect) (DBusServer *server);
49 /**< Disconnect this server. */
53 * Internals of DBusServer object
57 DBusAtomic refcount; /**< Reference count. */
58 const DBusServerVTable *vtable; /**< Virtual methods for this instance. */
59 DBusMutex *mutex; /**< Lock on the server object */
61 DBusGUID guid; /**< Globally unique ID of server */
63 DBusString guid_hex; /**< Hex-encoded version of GUID */
65 DBusWatchList *watches; /**< Our watches */
66 DBusTimeoutList *timeouts; /**< Our timeouts */
68 char *address; /**< Address this server is listening on. */
70 int max_connections; /**< Max number of connections allowed at once. */
72 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
74 DBusNewConnectionFunction new_connection_function;
75 /**< Callback to invoke when a new connection is created. */
76 void *new_connection_data;
77 /**< Data for new connection callback */
78 DBusFreeFunction new_connection_free_data_function;
79 /**< Callback to invoke to free new_connection_data
80 * when server is finalized or data is replaced.
83 char **auth_mechanisms; /**< Array of allowed authentication mechanisms */
85 unsigned int disconnected : 1; /**< TRUE if we are disconnected. */
87 #ifndef DBUS_DISABLE_CHECKS
88 unsigned int have_server_lock : 1; /**< Does someone have the server mutex locked */
92 dbus_bool_t _dbus_server_init_base (DBusServer *server,
93 const DBusServerVTable *vtable,
94 const DBusString *address);
95 void _dbus_server_finalize_base (DBusServer *server);
96 dbus_bool_t _dbus_server_add_watch (DBusServer *server,
98 void _dbus_server_remove_watch (DBusServer *server,
100 void _dbus_server_toggle_watch (DBusServer *server,
102 dbus_bool_t enabled);
103 dbus_bool_t _dbus_server_add_timeout (DBusServer *server,
104 DBusTimeout *timeout);
105 void _dbus_server_remove_timeout (DBusServer *server,
106 DBusTimeout *timeout);
107 void _dbus_server_toggle_timeout (DBusServer *server,
108 DBusTimeout *timeout,
109 dbus_bool_t enabled);
111 void _dbus_server_ref_unlocked (DBusServer *server);
112 void _dbus_server_unref_unlocked (DBusServer *server);
116 DBUS_SERVER_LISTEN_NOT_HANDLED, /**< we aren't in charge of this address type */
117 DBUS_SERVER_LISTEN_OK, /**< we set up the listen */
118 DBUS_SERVER_LISTEN_BAD_ADDRESS, /**< malformed address */
119 DBUS_SERVER_LISTEN_DID_NOT_CONNECT /**< well-formed address but failed to set it up */
120 } DBusServerListenResult;
122 DBusServerListenResult _dbus_server_listen_platform_specific (DBusAddressEntry *entry,
123 DBusServer **server_p,
126 #ifdef DBUS_DISABLE_CHECKS
127 #define TOOK_LOCK_CHECK(server)
128 #define RELEASING_LOCK_CHECK(server)
129 #define HAVE_LOCK_CHECK(server)
131 #define TOOK_LOCK_CHECK(server) do { \
132 _dbus_assert (!(server)->have_server_lock); \
133 (server)->have_server_lock = TRUE; \
135 #define RELEASING_LOCK_CHECK(server) do { \
136 _dbus_assert ((server)->have_server_lock); \
137 (server)->have_server_lock = FALSE; \
139 #define HAVE_LOCK_CHECK(server) _dbus_assert ((server)->have_server_lock)
140 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
143 #define TRACE_LOCKS 0
145 #define SERVER_LOCK(server) do { \
146 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
147 _dbus_mutex_lock ((server)->mutex); \
148 TOOK_LOCK_CHECK (server); \
151 #define SERVER_UNLOCK(server) do { \
152 if (TRACE_LOCKS) { _dbus_verbose ("UNLOCK\n"); } \
153 RELEASING_LOCK_CHECK (server); \
154 _dbus_mutex_unlock ((server)->mutex); \
159 #endif /* DBUS_SERVER_PROTECTED_H */