1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-server-debug.h In-proc debug server implementation
4 * Copyright (C) 2003 CodeFactory AB
6 * Licensed under the Academic Free License version 1.2
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
24 #include "dbus-internals.h"
25 #include "dbus-server-debug.h"
26 #include "dbus-transport-debug.h"
27 #include "dbus-connection-internal.h"
28 #include "dbus-hash.h"
30 #ifdef DBUS_BUILD_TESTS
33 * @defgroup DBusServerDebug DBusServerDebug
34 * @ingroup DBusInternals
35 * @brief In-process debug server used in unit tests.
37 * Types and functions related to DBusServerDebug.
38 * This is used for unit testing.
44 * Default timeout interval when reading or writing.
46 #define DEFAULT_INTERVAL 1
49 * Opaque object representing a debug server implementation.
51 typedef struct DBusServerDebug DBusServerDebug;
54 * Implementation details of DBusServerDebug. All members
57 struct DBusServerDebug
59 DBusServer base; /**< Parent class members. */
61 char *name; /**< Server name. */
64 /* Not thread safe, but OK since we don't use
67 static DBusHashTable *server_hash;
70 debug_finalize (DBusServer *server)
75 debug_disconnect (DBusServer *server)
79 static DBusServerVTable debug_vtable = {
85 * Looks up a server by its name.
87 * @param server_name the server name.
88 * @returns the server, or #NULL if none exists.
91 _dbus_server_debug_lookup (const char *server_name)
96 return _dbus_hash_table_lookup_string (server_hash, server_name);
100 * Creates a new debug server.
102 * @param server_name the name of the server.
103 * @param error address where an error can be returned.
104 * @returns a new server, or #NULL on failure.
107 _dbus_server_debug_new (const char *server_name,
110 DBusServerDebug *debug_server;
113 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
117 server_hash = _dbus_hash_table_new (DBUS_HASH_STRING, NULL, NULL);
121 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
126 if (_dbus_hash_table_lookup_string (server_hash, server_name) != NULL)
128 dbus_set_error (error, DBUS_ERROR_ADDRESS_IN_USE,
133 debug_server = dbus_new0 (DBusServerDebug, 1);
135 if (debug_server == NULL)
138 if (!_dbus_string_init (&address))
141 if (!_dbus_string_append (&address, "debug:name=") ||
142 !_dbus_string_append (&address, server_name))
145 debug_server->name = _dbus_strdup (server_name);
146 if (debug_server->name == NULL)
149 if (!_dbus_server_init_base (&debug_server->base,
154 if (!_dbus_hash_table_insert_string (server_hash,
159 _dbus_string_free (&address);
161 return (DBusServer *)debug_server;
164 _dbus_server_finalize_base (&debug_server->base);
166 dbus_free (debug_server->name);
168 _dbus_string_free (&address);
170 dbus_free (debug_server);
172 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
180 DBusTransport *transport;
181 DBusTimeout *timeout;
182 } ServerAndTransport;
185 handle_new_client (void *data)
187 ServerAndTransport *st = data;
188 DBusTransport *transport;
189 DBusConnection *connection;
191 _dbus_verbose (" new debug client transport %p connecting to server\n",
194 transport = _dbus_transport_debug_server_new (st->transport);
195 if (transport == NULL)
198 connection = _dbus_connection_new_for_transport (transport);
199 _dbus_transport_unref (transport);
201 if (connection == NULL)
204 /* See if someone wants to handle this new connection,
205 * self-referencing for paranoia
207 if (st->server->new_connection_function)
209 dbus_server_ref (st->server);
211 (* st->server->new_connection_function) (st->server, connection,
212 st->server->new_connection_data);
213 dbus_server_unref (st->server);
216 _dbus_server_remove_timeout (st->server, st->timeout);
218 /* If no one grabbed a reference, the connection will die. */
219 dbus_connection_unref (connection);
221 /* killing timeout frees both "st" and "timeout" */
222 _dbus_timeout_unref (st->timeout);
228 * Tells the server to accept a transport so the transport
229 * can send messages to it.
231 * @param server the server
232 * @param transport the transport
233 * @returns #TRUE on success.
236 _dbus_server_debug_accept_transport (DBusServer *server,
237 DBusTransport *transport)
239 ServerAndTransport *st = NULL;
241 st = dbus_new (ServerAndTransport, 1);
245 st->transport = transport;
248 st->timeout = _dbus_timeout_new (DEFAULT_INTERVAL, handle_new_client, st,
251 if (st->timeout == NULL)
254 if (!_dbus_server_add_timeout (server, st->timeout))
261 _dbus_timeout_unref (st->timeout);
268 #endif /* DBUS_BUILD_TESTS */