/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-connection.c DBusConnection object
*
- * Copyright (C) 2002 Red Hat Inc.
+ * Copyright (C) 2002, 2003 Red Hat Inc.
*
* Licensed under the Academic Free License version 1.2
*
#include "dbus-connection.h"
#include "dbus-list.h"
+#include "dbus-timeout.h"
#include "dbus-transport.h"
#include "dbus-watch.h"
#include "dbus-connection-internal.h"
#include "dbus-list.h"
+#include "dbus-hash.h"
+#include "dbus-message-internal.h"
+#include "dbus-message-handler.h"
+#include "dbus-threads.h"
+#include "dbus-protocol.h"
/**
* @defgroup DBusConnection DBusConnection
* @{
*/
+/** default timeout value when waiting for a message reply */
+#define DEFAULT_TIMEOUT_VALUE (15 * 1000)
+
+static dbus_bool_t _dbus_modify_sigpipe = TRUE;
+
+/** Opaque typedef for DBusDataSlot */
+typedef struct DBusDataSlot DBusDataSlot;
+/** DBusDataSlot is used to store application data on the connection */
+struct DBusDataSlot
+{
+ void *data; /**< The application data */
+ DBusFreeFunction free_data_func; /**< Free the application data */
+};
+
/**
* Implementation details of DBusConnection. All fields are private.
*/
{
int refcount; /**< Reference count. */
+ DBusMutex *mutex;
+
+ /* Protects dispatch_message */
+ dbus_bool_t dispatch_acquired;
+ DBusCondVar *dispatch_cond;
+
+ /* Protects transport io path */
+ dbus_bool_t io_path_acquired;
+ DBusCondVar *io_path_cond;
+
DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
+ DBusMessage *message_borrowed; /**< True if the first incoming message has been borrowed */
+ DBusCondVar *message_returned_cond;
+
int n_outgoing; /**< Length of outgoing queue. */
int n_incoming; /**< Length of incoming queue. */
DBusTransport *transport; /**< Object that sends/receives messages over network. */
DBusWatchList *watches; /**< Stores active watches. */
+ DBusTimeoutList *timeouts; /**< Stores active timeouts. */
+
+ DBusHashTable *handler_table; /**< Table of registered DBusMessageHandler */
+ DBusList *filter_list; /**< List of filters. */
+ DBusDataSlot *data_slots; /**< Data slots */
+ int n_slots; /**< Slots allocated so far. */
+
+ DBusHashTable *pending_replies; /**< Hash of message serials and their message handlers. */
+ DBusCounter *connection_counter; /**< Counter that we decrement when finalized */
- DBusConnectionErrorFunction error_function; /**< Callback for errors. */
- void *error_data; /**< Data for error callback. */
- DBusFreeFunction error_free_data_function; /**< Free function for error callback data. */
+ int client_serial; /**< Client serial. Increments each time a message is sent */
+ DBusList *disconnect_message_link;
};
+typedef struct
+{
+ DBusConnection *connection;
+ DBusMessageHandler *handler;
+ DBusTimeout *timeout;
+ int serial;
+
+ DBusList *timeout_link; /* Preallocated timeout response */
+
+ dbus_bool_t timeout_added;
+ dbus_bool_t connection_added;
+} ReplyHandlerData;
+
+static void reply_handler_data_free (ReplyHandlerData *data);
+
+static void _dbus_connection_free_data_slots_nolock (DBusConnection *connection);
+static void _dbus_connection_remove_timeout_locked (DBusConnection *connection,
+ DBusTimeout *timeout);
+
+
+
/**
* Adds a message to the incoming message queue, returning #FALSE
* if there's insufficient memory to queue the message.
_dbus_connection_queue_received_message (DBusConnection *connection,
DBusMessage *message)
{
+ ReplyHandlerData *reply_handler_data;
+ dbus_int32_t reply_serial;
+
+ _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
+
if (!_dbus_list_append (&connection->incoming_messages,
message))
return FALSE;
+ /* If this is a reply we're waiting on, remove timeout for it */
+ reply_serial = _dbus_message_get_reply_serial (message);
+ if (reply_serial != -1)
+ {
+ reply_handler_data = _dbus_hash_table_lookup_int (connection->pending_replies,
+ reply_serial);
+ if (reply_handler_data != NULL)
+ {
+ if (reply_handler_data->timeout_added)
+ _dbus_connection_remove_timeout_locked (connection,
+ reply_handler_data->timeout);
+ reply_handler_data->timeout_added = FALSE;
+ }
+ }
+
dbus_message_ref (message);
connection->n_incoming += 1;
+ _dbus_verbose ("Incoming message %p added to queue, %d incoming\n",
+ message, connection->n_incoming);
+
return TRUE;
}
/**
+ * Adds a link + message to the incoming message queue.
+ * Can't fail. Takes ownership of both link and message.
+ *
+ * @param connection the connection.
+ * @param link the list node and message to queue.
+ *
+ * @todo This needs to wake up the mainloop if it is in
+ * a poll/select and this is a multithreaded app.
+ */
+static void
+_dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
+ DBusList *link)
+{
+ _dbus_list_append_link (&connection->incoming_messages, link);
+
+ connection->n_incoming += 1;
+
+ _dbus_verbose ("Incoming synthesized message %p added to queue, %d incoming\n",
+ link->data, connection->n_incoming);
+}
+
+
+/**
* Checks whether there are messages in the outgoing message queue.
*
* @param connection the connection.
}
/**
- * Gets the next outgoing message. The message remanins in the
+ * Gets the next outgoing message. The message remains in the
* queue, and the caller does not own a reference to it.
*
* @param connection the connection.
_dbus_connection_message_sent (DBusConnection *connection,
DBusMessage *message)
{
+ _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
_dbus_assert (message == _dbus_list_get_last (&connection->outgoing_messages));
+
_dbus_list_pop_last (&connection->outgoing_messages);
dbus_message_unref (message);
connection->n_outgoing -= 1;
+
+ _dbus_verbose ("Message %p removed from outgoing queue, %d left to send\n",
+ message, connection->n_outgoing);
+
if (connection->n_outgoing == 0)
_dbus_transport_messages_pending (connection->transport,
connection->n_outgoing);
_dbus_connection_add_watch (DBusConnection *connection,
DBusWatch *watch)
{
- return _dbus_watch_list_add_watch (connection->watches,
- watch);
-
- return TRUE;
+ if (connection->watches) /* null during finalize */
+ return _dbus_watch_list_add_watch (connection->watches,
+ watch);
+ else
+ return FALSE;
}
/**
_dbus_connection_remove_watch (DBusConnection *connection,
DBusWatch *watch)
{
- _dbus_watch_list_remove_watch (connection->watches,
- watch);
+ if (connection->watches) /* null during finalize */
+ _dbus_watch_list_remove_watch (connection->watches,
+ watch);
+}
+
+/**
+ * Adds a timeout using the connection's DBusAddTimeoutFunction if
+ * available. Otherwise records the timeout to be added when said
+ * function is available. Also re-adds the timeout if the
+ * DBusAddTimeoutFunction changes. May fail due to lack of memory.
+ *
+ * @param connection the connection.
+ * @param timeout the timeout to add.
+ * @returns #TRUE on success.
+ */
+dbus_bool_t
+_dbus_connection_add_timeout (DBusConnection *connection,
+ DBusTimeout *timeout)
+{
+ if (connection->timeouts) /* null during finalize */
+ return _dbus_timeout_list_add_timeout (connection->timeouts,
+ timeout);
+ else
+ return FALSE;
+}
+
+/**
+ * Removes a timeout using the connection's DBusRemoveTimeoutFunction
+ * if available. It's an error to call this function on a timeout
+ * that was not previously added.
+ *
+ * @param connection the connection.
+ * @param timeout the timeout to remove.
+ */
+void
+_dbus_connection_remove_timeout (DBusConnection *connection,
+ DBusTimeout *timeout)
+{
+ if (connection->timeouts) /* null during finalize */
+ _dbus_timeout_list_remove_timeout (connection->timeouts,
+ timeout);
}
static void
-handle_error (DBusConnection *connection,
- DBusResultCode result)
+_dbus_connection_remove_timeout_locked (DBusConnection *connection,
+ DBusTimeout *timeout)
+{
+ dbus_mutex_lock (connection->mutex);
+ _dbus_connection_remove_timeout (connection, timeout);
+ dbus_mutex_unlock (connection->mutex);
+}
+
+
+/**
+ * Tells the connection that the transport has been disconnected.
+ * Results in posting a disconnect message on the incoming message
+ * queue. Only has an effect the first time it's called.
+ *
+ * @param connection the connection
+ */
+void
+_dbus_connection_notify_disconnected (DBusConnection *connection)
{
- if (result != DBUS_RESULT_SUCCESS &&
- connection->error_function != NULL)
+ if (connection->disconnect_message_link)
{
- dbus_connection_ref (connection);
- (* connection->error_function) (connection, result,
- connection->error_data);
- dbus_connection_unref (connection);
+ /* We haven't sent the disconnect message already */
+ _dbus_connection_queue_synthesized_message_link (connection,
+ connection->disconnect_message_link);
+ connection->disconnect_message_link = NULL;
}
}
-static void
-set_result_handled (DBusConnection *connection,
- DBusResultCode *result_address,
- DBusResultCode result)
+
+/**
+ * Acquire the transporter I/O path. This must be done before
+ * doing any I/O in the transporter. May sleep and drop the
+ * connection mutex while waiting for the I/O path.
+ *
+ * @param connection the connection.
+ * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
+ * @returns TRUE if the I/O path was acquired.
+ */
+static dbus_bool_t
+_dbus_connection_acquire_io_path (DBusConnection *connection,
+ int timeout_milliseconds)
{
- dbus_set_result (result_address, result);
- handle_error (connection, result);
+ dbus_bool_t res = TRUE;
+ if (timeout_milliseconds != -1)
+ res = dbus_condvar_wait_timeout (connection->io_path_cond,
+ connection->mutex,
+ timeout_milliseconds);
+ else
+ dbus_condvar_wait (connection->io_path_cond, connection->mutex);
+
+ if (res)
+ {
+ _dbus_assert (!connection->io_path_acquired);
+
+ connection->io_path_acquired = TRUE;
+ }
+
+ return res;
}
/**
- * Reports a transport error to the connection. Typically
- * results in an application error callback being invoked.
+ * Release the I/O path when you're done with it. Only call
+ * after you've acquired the I/O. Wakes up at most one thread
+ * currently waiting to acquire the I/O path.
*
* @param connection the connection.
- * @param result_code the error code.
*/
-void
-_dbus_connection_transport_error (DBusConnection *connection,
- DBusResultCode result_code)
+static void
+_dbus_connection_release_io_path (DBusConnection *connection)
{
- handle_error (connection, result_code);
+ _dbus_assert (connection->io_path_acquired);
+
+ connection->io_path_acquired = FALSE;
+ dbus_condvar_wake_one (connection->io_path_cond);
}
+
/**
* Queues incoming messages and sends outgoing messages for this
* connection, optionally blocking in the process. Each call to
{
if (connection->n_outgoing == 0)
flags &= ~DBUS_ITERATION_DO_WRITING;
-
- _dbus_transport_do_iteration (connection->transport,
- flags, timeout_milliseconds);
+
+ if (_dbus_connection_acquire_io_path (connection,
+ (flags & DBUS_ITERATION_BLOCK)?timeout_milliseconds:0))
+ {
+ _dbus_transport_do_iteration (connection->transport,
+ flags, timeout_milliseconds);
+ _dbus_connection_release_io_path (connection);
+ }
}
/**
{
DBusConnection *connection;
DBusWatchList *watch_list;
-
+ DBusTimeoutList *timeout_list;
+ DBusHashTable *handler_table, *pending_replies;
+ DBusMutex *mutex;
+ DBusCondVar *message_returned_cond;
+ DBusCondVar *dispatch_cond;
+ DBusCondVar *io_path_cond;
+ DBusList *disconnect_link;
+ DBusMessage *disconnect_message;
+
watch_list = NULL;
connection = NULL;
+ handler_table = NULL;
+ pending_replies = NULL;
+ timeout_list = NULL;
+ mutex = NULL;
+ message_returned_cond = NULL;
+ dispatch_cond = NULL;
+ io_path_cond = NULL;
+ disconnect_link = NULL;
+ disconnect_message = NULL;
watch_list = _dbus_watch_list_new ();
if (watch_list == NULL)
goto error;
+
+ timeout_list = _dbus_timeout_list_new ();
+ if (timeout_list == NULL)
+ goto error;
+
+ handler_table =
+ _dbus_hash_table_new (DBUS_HASH_STRING,
+ dbus_free, NULL);
+ if (handler_table == NULL)
+ goto error;
+
+ pending_replies =
+ _dbus_hash_table_new (DBUS_HASH_INT,
+ NULL, (DBusFreeFunction)reply_handler_data_free);
+ if (pending_replies == NULL)
+ goto error;
connection = dbus_new0 (DBusConnection, 1);
if (connection == NULL)
goto error;
+
+ mutex = dbus_mutex_new ();
+ if (mutex == NULL)
+ goto error;
+
+ message_returned_cond = dbus_condvar_new ();
+ if (message_returned_cond == NULL)
+ goto error;
+
+ dispatch_cond = dbus_condvar_new ();
+ if (dispatch_cond == NULL)
+ goto error;
+
+ io_path_cond = dbus_condvar_new ();
+ if (io_path_cond == NULL)
+ goto error;
+
+ disconnect_message = dbus_message_new (NULL, DBUS_MESSAGE_LOCAL_DISCONNECT);
+ if (disconnect_message == NULL)
+ goto error;
+
+ disconnect_link = _dbus_list_alloc_link (disconnect_message);
+ if (disconnect_link == NULL)
+ goto error;
+
+ if (_dbus_modify_sigpipe)
+ _dbus_disable_sigpipe ();
connection->refcount = 1;
+ connection->mutex = mutex;
+ connection->dispatch_cond = dispatch_cond;
+ connection->io_path_cond = io_path_cond;
+ connection->message_returned_cond = message_returned_cond;
connection->transport = transport;
connection->watches = watch_list;
+ connection->timeouts = timeout_list;
+ connection->handler_table = handler_table;
+ connection->pending_replies = pending_replies;
+ connection->filter_list = NULL;
+ connection->data_slots = NULL;
+ connection->n_slots = 0;
+ connection->client_serial = 1;
+
+ connection->disconnect_message_link = disconnect_link;
+
_dbus_transport_ref (transport);
_dbus_transport_set_connection (transport, connection);
return connection;
error:
+ if (disconnect_message != NULL)
+ dbus_message_unref (disconnect_message);
+
+ if (disconnect_link != NULL)
+ _dbus_list_free_link (disconnect_link);
+
+ if (io_path_cond != NULL)
+ dbus_condvar_free (io_path_cond);
+
+ if (dispatch_cond != NULL)
+ dbus_condvar_free (dispatch_cond);
+
+ if (message_returned_cond != NULL)
+ dbus_condvar_free (message_returned_cond);
+
+ if (mutex != NULL)
+ dbus_mutex_free (mutex);
+
+ if (connection != NULL)
+ dbus_free (connection);
- _dbus_assert (connection == NULL);
+ if (handler_table)
+ _dbus_hash_table_unref (handler_table);
+ if (pending_replies)
+ _dbus_hash_table_unref (pending_replies);
+
if (watch_list)
_dbus_watch_list_free (watch_list);
+
+ if (timeout_list)
+ _dbus_timeout_list_free (timeout_list);
return NULL;
}
+static dbus_int32_t
+_dbus_connection_get_next_client_serial (DBusConnection *connection)
+{
+ int serial;
+
+ serial = connection->client_serial++;
+
+ if (connection->client_serial < 0)
+ connection->client_serial = 1;
+
+ return serial;
+}
+
+/**
+ * Used to notify a connection when a DBusMessageHandler is
+ * destroyed, so the connection can drop any reference
+ * to the handler. This is a private function, but still
+ * takes the connection lock. Don't call it with the lock held.
+ *
+ * @param connection the connection
+ * @param handler the handler
+ */
+void
+_dbus_connection_handler_destroyed_locked (DBusConnection *connection,
+ DBusMessageHandler *handler)
+{
+ DBusHashIter iter;
+ DBusList *link;
+
+ dbus_mutex_lock (connection->mutex);
+
+ _dbus_hash_iter_init (connection->handler_table, &iter);
+ while (_dbus_hash_iter_next (&iter))
+ {
+ DBusMessageHandler *h = _dbus_hash_iter_get_value (&iter);
+
+ if (h == handler)
+ _dbus_hash_iter_remove_entry (&iter);
+ }
+
+ link = _dbus_list_get_first_link (&connection->filter_list);
+ while (link != NULL)
+ {
+ DBusMessageHandler *h = link->data;
+ DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
+
+ if (h == handler)
+ _dbus_list_remove_link (&connection->filter_list,
+ link);
+
+ link = next;
+ }
+ dbus_mutex_unlock (connection->mutex);
+}
+
+/**
+ * Adds the counter used to count the number of open connections.
+ * Increments the counter by one, and saves it to be decremented
+ * again when this connection is finalized.
+ *
+ * @param connection a #DBusConnection
+ * @param counter counter that tracks number of connections
+ */
+void
+_dbus_connection_set_connection_counter (DBusConnection *connection,
+ DBusCounter *counter)
+{
+ _dbus_assert (connection->connection_counter == NULL);
+
+ connection->connection_counter = counter;
+ _dbus_counter_ref (connection->connection_counter);
+ _dbus_counter_adjust (connection->connection_counter, 1);
+}
+
/** @} */
/**
void
dbus_connection_ref (DBusConnection *connection)
{
+ dbus_mutex_lock (connection->mutex);
+ _dbus_assert (connection->refcount > 0);
+
connection->refcount += 1;
+ dbus_mutex_unlock (connection->mutex);
}
/**
- * Decrements the reference count of a DBusConnection, and finalizes
- * it if the count reaches zero. If a connection is still connected
- * when it's finalized, it will be disconnected (that is, associated
- * file handles will be closed).
+ * Increments the reference count of a DBusConnection.
+ * Requires that the caller already holds the connection lock.
*
* @param connection the connection.
*/
void
-dbus_connection_unref (DBusConnection *connection)
+_dbus_connection_ref_unlocked (DBusConnection *connection)
{
- _dbus_assert (connection != NULL);
_dbus_assert (connection->refcount > 0);
+ connection->refcount += 1;
+}
+
+
+/* This is run without the mutex held, but after the last reference
+ to the connection has been dropped we should have no thread-related
+ problems */
+static void
+_dbus_connection_last_unref (DBusConnection *connection)
+{
+ DBusHashIter iter;
+ DBusList *link;
+
+ _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
- connection->refcount -= 1;
- if (connection->refcount == 0)
+ if (connection->connection_counter != NULL)
{
- /* free error data as a side effect */
- dbus_connection_set_error_function (connection,
- NULL, NULL, NULL);
-
- _dbus_watch_list_free (connection->watches);
+ /* subtract ourselves from the counter */
+ _dbus_counter_adjust (connection->connection_counter, - 1);
+ _dbus_counter_unref (connection->connection_counter);
+ connection->connection_counter = NULL;
+ }
+
+ _dbus_watch_list_free (connection->watches);
+ connection->watches = NULL;
+
+ _dbus_timeout_list_free (connection->timeouts);
+ connection->timeouts = NULL;
+
+ _dbus_connection_free_data_slots_nolock (connection);
+
+ _dbus_hash_iter_init (connection->handler_table, &iter);
+ while (_dbus_hash_iter_next (&iter))
+ {
+ DBusMessageHandler *h = _dbus_hash_iter_get_value (&iter);
- _dbus_list_foreach (&connection->outgoing_messages,
- (DBusForeachFunction) dbus_message_unref,
- NULL);
- _dbus_list_clear (&connection->outgoing_messages);
-
- _dbus_list_foreach (&connection->incoming_messages,
- (DBusForeachFunction) dbus_message_unref,
- NULL);
- _dbus_list_clear (&connection->incoming_messages);
+ _dbus_message_handler_remove_connection (h, connection);
+ }
+
+ link = _dbus_list_get_first_link (&connection->filter_list);
+ while (link != NULL)
+ {
+ DBusMessageHandler *h = link->data;
+ DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
- _dbus_transport_unref (connection->transport);
+ _dbus_message_handler_remove_connection (h, connection);
- dbus_free (connection);
+ link = next;
+ }
+
+ _dbus_hash_table_unref (connection->handler_table);
+ connection->handler_table = NULL;
+
+ _dbus_hash_table_unref (connection->pending_replies);
+ connection->pending_replies = NULL;
+
+ _dbus_list_clear (&connection->filter_list);
+
+ _dbus_list_foreach (&connection->outgoing_messages,
+ (DBusForeachFunction) dbus_message_unref,
+ NULL);
+ _dbus_list_clear (&connection->outgoing_messages);
+
+ _dbus_list_foreach (&connection->incoming_messages,
+ (DBusForeachFunction) dbus_message_unref,
+ NULL);
+ _dbus_list_clear (&connection->incoming_messages);
+
+ _dbus_transport_unref (connection->transport);
+
+ if (connection->disconnect_message_link)
+ {
+ DBusMessage *message = connection->disconnect_message_link->data;
+ dbus_message_unref (message);
+ _dbus_list_free_link (connection->disconnect_message_link);
}
+
+ dbus_condvar_free (connection->dispatch_cond);
+ dbus_condvar_free (connection->io_path_cond);
+ dbus_condvar_free (connection->message_returned_cond);
+
+ dbus_mutex_free (connection->mutex);
+
+ dbus_free (connection);
+}
+
+/**
+ * Decrements the reference count of a DBusConnection, and finalizes
+ * it if the count reaches zero. It is a bug to drop the last reference
+ * to a connection that has not been disconnected.
+ *
+ * @param connection the connection.
+ */
+void
+dbus_connection_unref (DBusConnection *connection)
+{
+ dbus_bool_t last_unref;
+
+ dbus_mutex_lock (connection->mutex);
+
+ _dbus_assert (connection != NULL);
+ _dbus_assert (connection->refcount > 0);
+
+ connection->refcount -= 1;
+ last_unref = (connection->refcount == 0);
+
+ dbus_mutex_unlock (connection->mutex);
+
+ if (last_unref)
+ _dbus_connection_last_unref (connection);
}
/**
void
dbus_connection_disconnect (DBusConnection *connection)
{
+ dbus_mutex_lock (connection->mutex);
_dbus_transport_disconnect (connection->transport);
+ dbus_mutex_unlock (connection->mutex);
}
/**
dbus_bool_t
dbus_connection_get_is_connected (DBusConnection *connection)
{
- return _dbus_transport_get_is_connected (connection->transport);
+ dbus_bool_t res;
+
+ dbus_mutex_lock (connection->mutex);
+ res = _dbus_transport_get_is_connected (connection->transport);
+ dbus_mutex_unlock (connection->mutex);
+
+ return res;
+}
+
+/**
+ * Gets whether the connection was authenticated. (Note that
+ * if the connection was authenticated then disconnected,
+ * this function still returns #TRUE)
+ *
+ * @param connection the connection
+ * @returns #TRUE if the connection was ever authenticated
+ */
+dbus_bool_t
+dbus_connection_get_is_authenticated (DBusConnection *connection)
+{
+ dbus_bool_t res;
+
+ dbus_mutex_lock (connection->mutex);
+ res = _dbus_transport_get_is_authenticated (connection->transport);
+ dbus_mutex_unlock (connection->mutex);
+
+ return res;
}
/**
*
* @param connection the connection.
* @param message the message to write.
+ * @param client_serial return location for client serial.
* @param result address where result code can be placed.
* @returns #TRUE on success.
*/
dbus_bool_t
dbus_connection_send_message (DBusConnection *connection,
DBusMessage *message,
+ dbus_int32_t *client_serial,
DBusResultCode *result)
-{
+
+{
+ dbus_int32_t serial;
+
+ dbus_mutex_lock (connection->mutex);
+
if (!_dbus_list_prepend (&connection->outgoing_messages,
message))
{
- set_result_handled (connection, result, DBUS_RESULT_NO_MEMORY);
+ dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
+ dbus_mutex_unlock (connection->mutex);
return FALSE;
}
dbus_message_ref (message);
connection->n_outgoing += 1;
- _dbus_message_lock (message);
+ _dbus_verbose ("Message %p added to outgoing queue, %d pending to send\n",
+ message, connection->n_outgoing);
+
+ if (_dbus_message_get_client_serial (message) == -1)
+ {
+ serial = _dbus_connection_get_next_client_serial (connection);
+ _dbus_message_set_client_serial (message, serial);
+ }
+
+ if (client_serial)
+ *client_serial = _dbus_message_get_client_serial (message);
+ _dbus_message_lock (message);
+
if (connection->n_outgoing == 1)
_dbus_transport_messages_pending (connection->transport,
connection->n_outgoing);
+
+ dbus_mutex_unlock (connection->mutex);
+
+ return TRUE;
}
-/**
- * Blocks until the outgoing message queue is empty.
- *
- * @param connection the connection.
- */
-void
-dbus_connection_flush (DBusConnection *connection)
+static void
+reply_handler_timeout (void *data)
{
- while (connection->n_outgoing > 0)
- _dbus_connection_do_iteration (connection,
- DBUS_ITERATION_DO_WRITING |
- DBUS_ITERATION_BLOCK,
- -1);
-}
+ DBusConnection *connection;
+ ReplyHandlerData *reply_handler_data = data;
-/**
- * Gets the number of messages in the incoming message queue.
- *
- * @param connection the connection.
+ connection = reply_handler_data->connection;
+
+ dbus_mutex_lock (connection->mutex);
+ if (reply_handler_data->timeout_link)
+ {
+ _dbus_connection_queue_synthesized_message_link (connection,
+ reply_handler_data->timeout_link);
+ reply_handler_data->timeout_link = NULL;
+ }
+
+ _dbus_connection_remove_timeout (connection,
+ reply_handler_data->timeout);
+ reply_handler_data->timeout_added = FALSE;
+
+ dbus_mutex_unlock (connection->mutex);
+}
+
+static void
+reply_handler_data_free (ReplyHandlerData *data)
+{
+ if (!data)
+ return;
+
+ if (data->timeout_added)
+ _dbus_connection_remove_timeout_locked (data->connection,
+ data->timeout);
+
+ if (data->connection_added)
+ _dbus_message_handler_remove_connection (data->handler,
+ data->connection);
+
+ if (data->timeout_link)
+ {
+ dbus_message_unref ((DBusMessage *)data->timeout_link->data);
+ _dbus_list_free_link (data->timeout_link);
+ }
+
+ dbus_message_handler_unref (data->handler);
+
+ dbus_free (data);
+}
+
+/**
+ * Queues a message to send, as with dbus_connection_send_message(),
+ * but also sets up a DBusMessageHandler to receive a reply to the
+ * message. If no reply is received in the given timeout_milliseconds,
+ * expires the pending reply and sends the DBusMessageHandler a
+ * synthetic error reply (generated in-process, not by the remote
+ * application) indicating that a timeout occurred.
+ *
+ * Reply handlers see their replies after message filters see them,
+ * but before message handlers added with
+ * dbus_connection_register_handler() see them, regardless of the
+ * reply message's name. Reply handlers are only handed a single
+ * message as a reply, after a reply has been seen the handler is
+ * removed. If a filter filters out the reply before the handler sees
+ * it, the handler is not removed but the timeout will immediately
+ * fire. If a filter was dumb and removed the timeout reply then
+ * the reply is lost (this will give a runtime warning).
+ *
+ * If #NULL is passed for the reply_handler, the timeout reply will
+ * still be generated and placed into the message queue, but no
+ * specific message handler will receive the reply.
+ *
+ * If -1 is passed for the timeout, a sane default timeout is used. -1
+ * is typically the best value for the timeout for this reason, unless
+ * you want a very short or very long timeout. There is no way to
+ * avoid a timeout entirely, other than passing INT_MAX for the
+ * timeout to postpone it indefinitely.
+ *
+ * @param connection the connection
+ * @param message the message to send
+ * @param reply_handler message handler expecting the reply, or #NULL
+ * @param timeout_milliseconds timeout in milliseconds or -1 for default
+ * @param result return location for result code
+ * @returns #TRUE if the message is successfully queued, #FALSE if no memory.
+ *
+ * @todo this function isn't implemented because we need message serials
+ * and other slightly more rich DBusMessage implementation in order to
+ * implement it. The basic idea will be to keep a hash of serials we're
+ * expecting a reply to, and also to add a way to tell GLib or Qt to
+ * install a timeout. Then install a timeout which is the shortest
+ * timeout of any pending reply.
+ *
+ */
+dbus_bool_t
+dbus_connection_send_message_with_reply (DBusConnection *connection,
+ DBusMessage *message,
+ DBusMessageHandler *reply_handler,
+ int timeout_milliseconds,
+ DBusResultCode *result)
+{
+ DBusTimeout *timeout;
+ ReplyHandlerData *data;
+ DBusMessage *reply;
+ DBusList *reply_link;
+ dbus_int32_t serial = -1;
+
+ if (timeout_milliseconds == -1)
+ timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
+
+ data = dbus_new0 (ReplyHandlerData, 1);
+
+ if (!data)
+ {
+ dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
+ return FALSE;
+ }
+
+ timeout = _dbus_timeout_new (timeout_milliseconds, reply_handler_timeout,
+ data, NULL);
+
+ if (!timeout)
+ {
+ reply_handler_data_free (data);
+ dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
+ return FALSE;
+ }
+
+ dbus_mutex_lock (connection->mutex);
+
+ /* Add timeout */
+ if (!_dbus_connection_add_timeout (connection, timeout))
+ {
+ reply_handler_data_free (data);
+ _dbus_timeout_unref (timeout);
+ dbus_mutex_unlock (connection->mutex);
+
+ dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
+ return FALSE;
+ }
+
+ /* The connection now owns the reference to the timeout. */
+ _dbus_timeout_unref (timeout);
+
+ data->timeout_added = TRUE;
+ data->timeout = timeout;
+ data->connection = connection;
+
+ if (!_dbus_message_handler_add_connection (reply_handler, connection))
+ {
+ dbus_mutex_unlock (connection->mutex);
+ reply_handler_data_free (data);
+
+ dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
+ return FALSE;
+ }
+ data->connection_added = TRUE;
+
+ /* Assign a serial to the message */
+ if (_dbus_message_get_client_serial (message) == -1)
+ {
+ serial = _dbus_connection_get_next_client_serial (connection);
+ _dbus_message_set_client_serial (message, serial);
+ }
+
+ data->handler = reply_handler;
+ data->serial = serial;
+
+ dbus_message_handler_ref (reply_handler);
+
+ reply = dbus_message_new_error_reply (message, DBUS_ERROR_NO_REPLY,
+ "No reply within specified time");
+ if (!reply)
+ {
+ dbus_mutex_unlock (connection->mutex);
+ reply_handler_data_free (data);
+
+ dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
+ return FALSE;
+ }
+
+ reply_link = _dbus_list_alloc_link (reply);
+ if (!reply)
+ {
+ dbus_mutex_unlock (connection->mutex);
+ dbus_message_unref (reply);
+ reply_handler_data_free (data);
+
+ dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
+ return FALSE;
+ }
+
+ data->timeout_link = reply_link;
+
+ /* Insert the serial in the pending replies hash. */
+ if (!_dbus_hash_table_insert_int (connection->pending_replies, serial, data))
+ {
+ dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
+ dbus_mutex_unlock (connection->mutex);
+ reply_handler_data_free (data);
+
+ return FALSE;
+ }
+
+ dbus_mutex_unlock (connection->mutex);
+
+ if (!dbus_connection_send_message (connection, message, NULL, result))
+ {
+ /* This will free the handler data too */
+ _dbus_hash_table_remove_int (connection->pending_replies, serial);
+ return FALSE;
+ }
+
+ dbus_set_result (result, DBUS_RESULT_SUCCESS);
+ return TRUE;
+}
+
+/**
+ * Sends a message and blocks a certain time period while waiting for a reply.
+ * This function does not dispatch any message handlers until the main loop
+ * has been reached. This function is used to do non-reentrant "method calls."
+ * If a reply is received, it is returned, and removed from the incoming
+ * message queue. If it is not received, #NULL is returned and the
+ * result is set to #DBUS_RESULT_NO_REPLY. If something else goes
+ * wrong, result is set to whatever is appropriate, such as
+ * #DBUS_RESULT_NO_MEMORY.
+ *
+ * @todo I believe if we get EINTR or otherwise interrupt the
+ * do_iteration call in here, we won't block the required length of
+ * time. I think there probably has to be a loop: "while (!timeout_elapsed)
+ * { check_for_reply_in_queue(); iterate_with_remaining_timeout(); }"
+ *
+ * @param connection the connection
+ * @param message the message to send
+ * @param timeout_milliseconds timeout in milliseconds or -1 for default
+ * @param result return location for result code
+ * @returns the message that is the reply or #NULL with an error code if the
+ * function fails.
+ */
+DBusMessage *
+dbus_connection_send_message_with_reply_and_block (DBusConnection *connection,
+ DBusMessage *message,
+ int timeout_milliseconds,
+ DBusResultCode *result)
+{
+ dbus_int32_t client_serial;
+ DBusList *link;
+
+ if (timeout_milliseconds == -1)
+ timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
+
+ if (!dbus_connection_send_message (connection, message, &client_serial, result))
+ return NULL;
+
+ /* Flush message queue */
+ dbus_connection_flush (connection);
+
+ dbus_mutex_lock (connection->mutex);
+
+ /* Now we wait... */
+ /* THREAD TODO: This is busted. What if a dispatch_message or pop_message
+ * gets the message before we do?
+ */
+ _dbus_connection_do_iteration (connection,
+ DBUS_ITERATION_DO_READING |
+ DBUS_ITERATION_BLOCK,
+ timeout_milliseconds);
+
+ /* Check if we've gotten a reply */
+ link = _dbus_list_get_first_link (&connection->incoming_messages);
+
+ while (link != NULL)
+ {
+ DBusMessage *reply = link->data;
+
+ if (_dbus_message_get_reply_serial (reply) == client_serial)
+ {
+ _dbus_list_remove (&connection->incoming_messages, link);
+ dbus_message_ref (message);
+
+ if (result)
+ *result = DBUS_RESULT_SUCCESS;
+
+ dbus_mutex_unlock (connection->mutex);
+ return reply;
+ }
+ link = _dbus_list_get_next_link (&connection->incoming_messages, link);
+ }
+
+ if (result)
+ *result = DBUS_RESULT_NO_REPLY;
+
+ dbus_mutex_unlock (connection->mutex);
+
+ return NULL;
+}
+
+/**
+ * Blocks until the outgoing message queue is empty.
+ *
+ * @param connection the connection.
+ */
+void
+dbus_connection_flush (DBusConnection *connection)
+{
+ dbus_mutex_lock (connection->mutex);
+ while (connection->n_outgoing > 0)
+ _dbus_connection_do_iteration (connection,
+ DBUS_ITERATION_DO_WRITING |
+ DBUS_ITERATION_BLOCK,
+ -1);
+ dbus_mutex_unlock (connection->mutex);
+}
+
+/**
+ * Gets the number of messages in the incoming message queue.
+ *
+ * @param connection the connection.
* @returns the number of messages in the queue.
*/
int
dbus_connection_get_n_messages (DBusConnection *connection)
{
- return connection->n_incoming;
+ int res;
+
+ dbus_mutex_lock (connection->mutex);
+ res = connection->n_incoming;
+ dbus_mutex_unlock (connection->mutex);
+ return res;
+}
+
+
+/* Call with mutex held. Will drop it while waiting and re-acquire
+ before returning */
+static void
+_dbus_connection_wait_for_borrowed (DBusConnection *connection)
+{
+ _dbus_assert (connection->message_borrowed != NULL);
+
+ while (connection->message_borrowed != NULL)
+ dbus_condvar_wait (connection->message_returned_cond, connection->mutex);
}
/**
* Returns the first-received message from the incoming message queue,
- * leaving it in the queue. The caller does not own a reference to the
- * returned message. If the queue is empty, returns #NULL.
+ * leaving it in the queue. If the queue is empty, returns #NULL.
+ *
+ * The caller does not own a reference to the returned message, and must
+ * either return it using dbus_connection_return_message or keep it after
+ * calling dbus_connection_steal_borrowed_message. No one can get at the
+ * message while its borrowed, so return it as quickly as possible and
+ * don't keep a reference to it after returning it. If you need to keep
+ * the message, make a copy of it.
*
* @param connection the connection.
* @returns next message in the incoming queue.
*/
DBusMessage*
-dbus_connection_peek_message (DBusConnection *connection)
+dbus_connection_borrow_message (DBusConnection *connection)
+{
+ DBusMessage *message;
+
+ dbus_mutex_lock (connection->mutex);
+
+ if (connection->message_borrowed != NULL)
+ _dbus_connection_wait_for_borrowed (connection);
+
+ message = _dbus_list_get_first (&connection->incoming_messages);
+
+ if (message)
+ connection->message_borrowed = message;
+
+ dbus_mutex_unlock (connection->mutex);
+ return message;
+}
+
+/**
+ * @todo docs
+ */
+void
+dbus_connection_return_message (DBusConnection *connection,
+ DBusMessage *message)
+{
+ dbus_mutex_lock (connection->mutex);
+
+ _dbus_assert (message == connection->message_borrowed);
+
+ connection->message_borrowed = NULL;
+ dbus_condvar_wake_all (connection->message_returned_cond);
+
+ dbus_mutex_unlock (connection->mutex);
+}
+
+/**
+ * @todo docs
+ */
+void
+dbus_connection_steal_borrowed_message (DBusConnection *connection,
+ DBusMessage *message)
+{
+ DBusMessage *pop_message;
+
+ dbus_mutex_lock (connection->mutex);
+
+ _dbus_assert (message == connection->message_borrowed);
+
+ pop_message = _dbus_list_pop_first (&connection->incoming_messages);
+ _dbus_assert (message == pop_message);
+
+ connection->n_incoming -= 1;
+
+ _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
+ message, connection->n_incoming);
+
+ connection->message_borrowed = NULL;
+ dbus_condvar_wake_all (connection->message_returned_cond);
+
+ dbus_mutex_unlock (connection->mutex);
+}
+
+
+/* See dbus_connection_pop_message, but requires the caller to own
+ the lock before calling. May drop the lock while running. */
+static DBusMessage*
+_dbus_connection_pop_message_unlocked (DBusConnection *connection)
{
- return _dbus_list_get_first (&connection->incoming_messages);
+ if (connection->message_borrowed != NULL)
+ _dbus_connection_wait_for_borrowed (connection);
+
+ if (connection->n_incoming > 0)
+ {
+ DBusMessage *message;
+
+ message = _dbus_list_pop_first (&connection->incoming_messages);
+ connection->n_incoming -= 1;
+
+ _dbus_verbose ("Incoming message %p removed from queue, %d incoming\n",
+ message, connection->n_incoming);
+
+ return message;
+ }
+ else
+ return NULL;
}
+
/**
* Returns the first-received message from the incoming message queue,
* removing it from the queue. The caller owns a reference to the
DBusMessage*
dbus_connection_pop_message (DBusConnection *connection)
{
- if (connection->n_incoming > 0)
- {
- connection->n_incoming -= 1;
- return _dbus_list_pop_first (&connection->incoming_messages);
- }
- else
- return NULL;
+ DBusMessage *message;
+ dbus_mutex_lock (connection->mutex);
+
+ message = _dbus_connection_pop_message_unlocked (connection);
+
+ dbus_mutex_unlock (connection->mutex);
+
+ return message;
}
/**
- * Sets the error handler function for the connection.
- *
+ * Acquire the dispatcher. This must be done before dispatching
+ * messages in order to guarantee the right order of
+ * message delivery. May sleep and drop the connection mutex
+ * while waiting for the dispatcher.
+ *
* @param connection the connection.
- * @param error_function the error handler.
- * @param data data to pass to the error handler.
- * @param free_data_function function to be called to free the data.
*/
-void
-dbus_connection_set_error_function (DBusConnection *connection,
- DBusConnectionErrorFunction error_function,
- void *data,
- DBusFreeFunction free_data_function)
+static void
+_dbus_connection_acquire_dispatch (DBusConnection *connection)
+{
+ dbus_condvar_wait (connection->dispatch_cond, connection->mutex);
+ _dbus_assert (!connection->dispatch_acquired);
+
+ connection->dispatch_acquired = TRUE;
+}
+
+/**
+ * Release the dispatcher when you're done with it. Only call
+ * after you've acquired the dispatcher. Wakes up at most one
+ * thread currently waiting to acquire the dispatcher.
+ *
+ * @param connection the connection.
+ */
+static void
+_dbus_connection_release_dispatch (DBusConnection *connection)
{
- if (connection->error_free_data_function != NULL)
- (* connection->error_free_data_function) (connection->error_data);
+ _dbus_assert (connection->dispatch_acquired);
- connection->error_function = error_function;
- connection->error_data = data;
- connection->error_free_data_function = free_data_function;
+ connection->dispatch_acquired = FALSE;
+ dbus_condvar_wake_one (connection->dispatch_cond);
+}
+
+static void
+_dbus_connection_failed_pop (DBusConnection *connection,
+ DBusList *message_link)
+{
+ _dbus_list_prepend_link (&connection->incoming_messages,
+ message_link);
+ connection->n_incoming += 1;
+}
+
+/**
+ * Pops the first-received message from the current incoming message
+ * queue, runs any handlers for it, then unrefs the message.
+ *
+ * @param connection the connection
+ * @returns #TRUE if the queue is not empty after dispatch
+ */
+dbus_bool_t
+dbus_connection_dispatch_message (DBusConnection *connection)
+{
+ DBusMessageHandler *handler;
+ DBusMessage *message;
+ DBusList *link, *filter_list_copy, *message_link;
+ DBusHandlerResult result;
+ ReplyHandlerData *reply_handler_data;
+ const char *name;
+ dbus_int32_t reply_serial;
+
+ /* Preallocate link so we can put the message back on failure */
+ message_link = _dbus_list_alloc_link (NULL);
+ if (message_link)
+ return FALSE;
+
+ dbus_mutex_lock (connection->mutex);
+
+ /* We need to ref the connection since the callback could potentially
+ * drop the last ref to it */
+ _dbus_connection_ref_unlocked (connection);
+
+ _dbus_connection_acquire_dispatch (connection);
+
+ /* This call may drop the lock during the execution (if waiting
+ for borrowed messages to be returned) but the order of message
+ dispatch if several threads call dispatch_message is still
+ protected by the lock, since only one will get the lock, and that
+ one will finish the message dispatching */
+ message = _dbus_connection_pop_message_unlocked (connection);
+ if (message == NULL)
+ {
+ _dbus_connection_release_dispatch (connection);
+ dbus_mutex_unlock (connection->mutex);
+ dbus_connection_unref (connection);
+ return FALSE;
+ }
+
+ message_link->data = message;
+
+ result = DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
+
+ reply_serial = _dbus_message_get_reply_serial (message);
+ reply_handler_data = _dbus_hash_table_lookup_int (connection->pending_replies,
+ reply_serial);
+
+ if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
+ {
+ _dbus_connection_release_dispatch (connection);
+ dbus_mutex_unlock (connection->mutex);
+ _dbus_connection_failed_pop (connection, message_link);
+ dbus_connection_unref (connection);
+ return FALSE;
+ }
+
+ _dbus_list_foreach (&filter_list_copy,
+ (DBusForeachFunction)dbus_message_handler_ref,
+ NULL);
+
+ /* We're still protected from dispatch_message reentrancy here
+ * since we acquired the dispatcher */
+ dbus_mutex_unlock (connection->mutex);
+
+ link = _dbus_list_get_first_link (&filter_list_copy);
+ while (link != NULL)
+ {
+ DBusMessageHandler *handler = link->data;
+ DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
+
+ result = _dbus_message_handler_handle_message (handler, connection,
+ message);
+
+ if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
+ break;
+
+ link = next;
+ }
+
+ _dbus_list_foreach (&filter_list_copy,
+ (DBusForeachFunction)dbus_message_handler_unref,
+ NULL);
+ _dbus_list_clear (&filter_list_copy);
+
+ dbus_mutex_lock (connection->mutex);
+
+ /* Did a reply we were waiting on get filtered? */
+ if (reply_handler_data && result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
+ {
+ /* Queue the timeout immediately! */
+ if (reply_handler_data->timeout_link)
+ {
+ _dbus_connection_queue_synthesized_message_link (connection,
+ reply_handler_data->timeout_link);
+ reply_handler_data->timeout_link = NULL;
+ }
+ else
+ {
+ /* We already queued the timeout? Then it was filtered! */
+ _dbus_warn ("The timeout for the reply to %d was filtered\n", reply_serial);
+ }
+ }
+
+ if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
+ goto out;
+
+ if (reply_handler_data)
+ {
+ dbus_mutex_unlock (connection->mutex);
+ result = _dbus_message_handler_handle_message (reply_handler_data->handler,
+ connection, message);
+ reply_handler_data_free (reply_handler_data);
+ dbus_mutex_lock (connection->mutex);
+ goto out;
+ }
+
+ name = dbus_message_get_name (message);
+ if (name != NULL)
+ {
+ handler = _dbus_hash_table_lookup_string (connection->handler_table,
+ name);
+ if (handler != NULL)
+ {
+ /* We're still protected from dispatch_message reentrancy here
+ * since we acquired the dispatcher */
+ dbus_mutex_unlock (connection->mutex);
+ result = _dbus_message_handler_handle_message (handler, connection,
+ message);
+ dbus_mutex_lock (connection->mutex);
+ if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
+ goto out;
+ }
+ }
+
+ out:
+ _dbus_connection_release_dispatch (connection);
+ dbus_mutex_unlock (connection->mutex);
+ _dbus_list_free_link (message_link);
+ dbus_connection_unref (connection);
+ dbus_message_unref (message);
+
+ return connection->n_incoming > 0;
}
/**
void *data,
DBusFreeFunction free_data_function)
{
+ dbus_mutex_lock (connection->mutex);
/* ref connection for slightly better reentrancy */
- dbus_connection_ref (connection);
+ _dbus_connection_ref_unlocked (connection);
_dbus_watch_list_set_functions (connection->watches,
add_function, remove_function,
data, free_data_function);
+ dbus_mutex_unlock (connection->mutex);
/* drop our paranoid refcount */
dbus_connection_unref (connection);
}
/**
+ * Sets the timeout functions for the connection. These functions are
+ * responsible for making the application's main loop aware of timeouts.
+ * When using Qt, typically the DBusAddTimeoutFunction would create a
+ * QTimer. When using GLib, the DBusAddTimeoutFunction would call
+ * g_timeout_add.
+ *
+ * The DBusTimeout can be queried for the timer interval using
+ * dbus_timeout_get_interval.
+ *
+ * Once a timeout occurs, dbus_timeout_handle should be called to invoke
+ * the timeout's callback.
+ *
+ * @param connection the connection.
+ * @param add_function function to add a timeout.
+ * @param remove_function function to remove a timeout.
+ * @param data data to pass to add_function and remove_function.
+ * @param free_data_function function to be called to free the data.
+ */
+void
+dbus_connection_set_timeout_functions (DBusConnection *connection,
+ DBusAddTimeoutFunction add_function,
+ DBusRemoveTimeoutFunction remove_function,
+ void *data,
+ DBusFreeFunction free_data_function)
+{
+ dbus_mutex_lock (connection->mutex);
+ /* ref connection for slightly better reentrancy */
+ _dbus_connection_ref_unlocked (connection);
+
+ _dbus_timeout_list_set_functions (connection->timeouts,
+ add_function, remove_function,
+ data, free_data_function);
+
+ dbus_mutex_unlock (connection->mutex);
+ /* drop our paranoid refcount */
+ dbus_connection_unref (connection);
+}
+
+/**
* Called to notify the connection when a previously-added watch
* is ready for reading or writing, or has an exception such
* as a hangup.
DBusWatch *watch,
unsigned int condition)
{
+ dbus_mutex_lock (connection->mutex);
+ _dbus_connection_acquire_io_path (connection, -1);
_dbus_transport_handle_watch (connection->transport,
- watch, condition);
+ watch, condition);
+ _dbus_connection_release_io_path (connection);
+ dbus_mutex_unlock (connection->mutex);
+}
+
+/**
+ * Adds a message filter. Filters are handlers that are run on
+ * all incoming messages, prior to the normal handlers
+ * registered with dbus_connection_register_handler().
+ * Filters are run in the order that they were added.
+ * The same handler can be added as a filter more than once, in
+ * which case it will be run more than once.
+ * Filters added during a filter callback won't be run on the
+ * message being processed.
+ *
+ * @param connection the connection
+ * @param handler the handler
+ * @returns #TRUE on success, #FALSE if not enough memory.
+ */
+dbus_bool_t
+dbus_connection_add_filter (DBusConnection *connection,
+ DBusMessageHandler *handler)
+{
+ dbus_mutex_lock (connection->mutex);
+ if (!_dbus_message_handler_add_connection (handler, connection))
+ {
+ dbus_mutex_unlock (connection->mutex);
+ return FALSE;
+ }
+
+ if (!_dbus_list_append (&connection->filter_list,
+ handler))
+ {
+ _dbus_message_handler_remove_connection (handler, connection);
+ dbus_mutex_unlock (connection->mutex);
+ return FALSE;
+ }
+
+ dbus_mutex_unlock (connection->mutex);
+ return TRUE;
+}
+
+/**
+ * Removes a previously-added message filter. It is a programming
+ * error to call this function for a handler that has not
+ * been added as a filter. If the given handler was added
+ * more than once, only one instance of it will be removed
+ * (the most recently-added instance).
+ *
+ * @param connection the connection
+ * @param handler the handler to remove
+ *
+ */
+void
+dbus_connection_remove_filter (DBusConnection *connection,
+ DBusMessageHandler *handler)
+{
+ dbus_mutex_lock (connection->mutex);
+ if (!_dbus_list_remove_last (&connection->filter_list, handler))
+ {
+ _dbus_warn ("Tried to remove a DBusConnection filter that had not been added\n");
+ dbus_mutex_unlock (connection->mutex);
+ return;
+ }
+
+ _dbus_message_handler_remove_connection (handler, connection);
+
+ dbus_mutex_unlock (connection->mutex);
+}
+
+/**
+ * Registers a handler for a list of message names. A single handler
+ * can be registered for any number of message names, but each message
+ * name can only have one handler at a time. It's not allowed to call
+ * this function with the name of a message that already has a
+ * handler. If the function returns #FALSE, the handlers were not
+ * registered due to lack of memory.
+ *
+ * @param connection the connection
+ * @param handler the handler
+ * @param messages_to_handle the messages to handle
+ * @param n_messages the number of message names in messages_to_handle
+ * @returns #TRUE on success, #FALSE if no memory or another handler already exists
+ *
+ **/
+dbus_bool_t
+dbus_connection_register_handler (DBusConnection *connection,
+ DBusMessageHandler *handler,
+ const char **messages_to_handle,
+ int n_messages)
+{
+ int i;
+
+ dbus_mutex_lock (connection->mutex);
+ i = 0;
+ while (i < n_messages)
+ {
+ DBusHashIter iter;
+ char *key;
+
+ key = _dbus_strdup (messages_to_handle[i]);
+ if (key == NULL)
+ goto failed;
+
+ if (!_dbus_hash_iter_lookup (connection->handler_table,
+ key, TRUE,
+ &iter))
+ {
+ dbus_free (key);
+ goto failed;
+ }
+
+ if (_dbus_hash_iter_get_value (&iter) != NULL)
+ {
+ _dbus_warn ("Bug in application: attempted to register a second handler for %s\n",
+ messages_to_handle[i]);
+ dbus_free (key); /* won't have replaced the old key with the new one */
+ goto failed;
+ }
+
+ if (!_dbus_message_handler_add_connection (handler, connection))
+ {
+ _dbus_hash_iter_remove_entry (&iter);
+ /* key has freed on nuking the entry */
+ goto failed;
+ }
+
+ _dbus_hash_iter_set_value (&iter, handler);
+
+ ++i;
+ }
+
+ dbus_mutex_unlock (connection->mutex);
+ return TRUE;
+
+ failed:
+ /* unregister everything registered so far,
+ * so we don't fail partially
+ */
+ dbus_connection_unregister_handler (connection,
+ handler,
+ messages_to_handle,
+ i);
+
+ dbus_mutex_unlock (connection->mutex);
+ return FALSE;
+}
+
+/**
+ * Unregisters a handler for a list of message names. The handlers
+ * must have been previously registered.
+ *
+ * @param connection the connection
+ * @param handler the handler
+ * @param messages_to_handle the messages to handle
+ * @param n_messages the number of message names in messages_to_handle
+ *
+ **/
+void
+dbus_connection_unregister_handler (DBusConnection *connection,
+ DBusMessageHandler *handler,
+ const char **messages_to_handle,
+ int n_messages)
+{
+ int i;
+
+ dbus_mutex_lock (connection->mutex);
+ i = 0;
+ while (i < n_messages)
+ {
+ DBusHashIter iter;
+
+ if (!_dbus_hash_iter_lookup (connection->handler_table,
+ (char*) messages_to_handle[i], FALSE,
+ &iter))
+ {
+ _dbus_warn ("Bug in application: attempted to unregister handler for %s which was not registered\n",
+ messages_to_handle[i]);
+ }
+ else if (_dbus_hash_iter_get_value (&iter) != handler)
+ {
+ _dbus_warn ("Bug in application: attempted to unregister handler for %s which was registered by a different handler\n",
+ messages_to_handle[i]);
+ }
+ else
+ {
+ _dbus_hash_iter_remove_entry (&iter);
+ _dbus_message_handler_remove_connection (handler, connection);
+ }
+
+ ++i;
+ }
+
+ dbus_mutex_unlock (connection->mutex);
+}
+
+static int *allocated_slots = NULL;
+static int n_allocated_slots = 0;
+static int n_used_slots = 0;
+static DBusMutex *allocated_slots_lock = NULL;
+
+DBusMutex *_dbus_allocated_slots_init_lock (void);
+DBusMutex *
+_dbus_allocated_slots_init_lock (void)
+{
+ allocated_slots_lock = dbus_mutex_new ();
+ return allocated_slots_lock;
+}
+
+
+/**
+ * Allocates an integer ID to be used for storing application-specific
+ * data on any DBusConnection. The allocated ID may then be used
+ * with dbus_connection_set_data() and dbus_connection_get_data().
+ * If allocation fails, -1 is returned. Again, the allocated
+ * slot is global, i.e. all DBusConnection objects will
+ * have a slot with the given integer ID reserved.
+ *
+ * @returns -1 on failure, otherwise the data slot ID
+ */
+int
+dbus_connection_allocate_data_slot (void)
+{
+ int slot;
+
+ if (!dbus_mutex_lock (allocated_slots_lock))
+ return -1;
+
+ if (n_used_slots < n_allocated_slots)
+ {
+ slot = 0;
+ while (slot < n_allocated_slots)
+ {
+ if (allocated_slots[slot] < 0)
+ {
+ allocated_slots[slot] = slot;
+ n_used_slots += 1;
+ break;
+ }
+ ++slot;
+ }
+
+ _dbus_assert (slot < n_allocated_slots);
+ }
+ else
+ {
+ int *tmp;
+
+ slot = -1;
+ tmp = dbus_realloc (allocated_slots,
+ sizeof (int) * (n_allocated_slots + 1));
+ if (tmp == NULL)
+ goto out;
+
+ allocated_slots = tmp;
+ slot = n_allocated_slots;
+ n_allocated_slots += 1;
+ n_used_slots += 1;
+ allocated_slots[slot] = slot;
+ }
+
+ _dbus_assert (slot >= 0);
+ _dbus_assert (slot < n_allocated_slots);
+
+ out:
+ dbus_mutex_unlock (allocated_slots_lock);
+ return slot;
+}
+
+/**
+ * Deallocates a global ID for connection data slots.
+ * dbus_connection_get_data() and dbus_connection_set_data()
+ * may no longer be used with this slot.
+ * Existing data stored on existing DBusConnection objects
+ * will be freed when the connection is finalized,
+ * but may not be retrieved (and may only be replaced
+ * if someone else reallocates the slot).
+ *
+ * @param slot the slot to deallocate
+ */
+void
+dbus_connection_free_data_slot (int slot)
+{
+ dbus_mutex_lock (allocated_slots_lock);
+
+ _dbus_assert (slot < n_allocated_slots);
+ _dbus_assert (allocated_slots[slot] == slot);
+
+ allocated_slots[slot] = -1;
+ n_used_slots -= 1;
+
+ if (n_used_slots == 0)
+ {
+ dbus_free (allocated_slots);
+ allocated_slots = NULL;
+ n_allocated_slots = 0;
+ }
+
+ dbus_mutex_unlock (allocated_slots_lock);
+}
+
+/**
+ * Stores a pointer on a DBusConnection, along
+ * with an optional function to be used for freeing
+ * the data when the data is set again, or when
+ * the connection is finalized. The slot number
+ * must have been allocated with dbus_connection_allocate_data_slot().
+ *
+ * @param connection the connection
+ * @param slot the slot number
+ * @param data the data to store
+ * @param free_data_func finalizer function for the data
+ * @returns #TRUE if there was enough memory to store the data
+ */
+dbus_bool_t
+dbus_connection_set_data (DBusConnection *connection,
+ int slot,
+ void *data,
+ DBusFreeFunction free_data_func)
+{
+ DBusFreeFunction old_free_func;
+ void *old_data;
+
+ dbus_mutex_lock (connection->mutex);
+ _dbus_assert (slot < n_allocated_slots);
+ _dbus_assert (allocated_slots[slot] == slot);
+
+ if (slot >= connection->n_slots)
+ {
+ DBusDataSlot *tmp;
+ int i;
+
+ tmp = dbus_realloc (connection->data_slots,
+ sizeof (DBusDataSlot) * (slot + 1));
+ if (tmp == NULL)
+ {
+ dbus_mutex_unlock (connection->mutex);
+ return FALSE;
+ }
+
+ connection->data_slots = tmp;
+ i = connection->n_slots;
+ connection->n_slots = slot + 1;
+ while (i < connection->n_slots)
+ {
+ connection->data_slots[i].data = NULL;
+ connection->data_slots[i].free_data_func = NULL;
+ ++i;
+ }
+ }
+
+ _dbus_assert (slot < connection->n_slots);
+
+ old_data = connection->data_slots[slot].data;
+ old_free_func = connection->data_slots[slot].free_data_func;
+
+ connection->data_slots[slot].data = data;
+ connection->data_slots[slot].free_data_func = free_data_func;
+
+ dbus_mutex_unlock (connection->mutex);
+
+ /* Do the actual free outside the connection lock */
+ if (old_free_func)
+ (* old_free_func) (old_data);
+
+ return TRUE;
+}
+
+/**
+ * Retrieves data previously set with dbus_connection_set_data().
+ * The slot must still be allocated (must not have been freed).
+ *
+ * @param connection the connection
+ * @param slot the slot to get data from
+ * @returns the data, or #NULL if not found
+ */
+void*
+dbus_connection_get_data (DBusConnection *connection,
+ int slot)
+{
+ void *res;
+
+ dbus_mutex_lock (connection->mutex);
+
+ _dbus_assert (slot < n_allocated_slots);
+ _dbus_assert (allocated_slots[slot] == slot);
+
+ if (slot >= connection->n_slots)
+ res = NULL;
+ else
+ res = connection->data_slots[slot].data;
+
+ dbus_mutex_unlock (connection->mutex);
+
+ return res;
+}
+
+/**
+ * This function sets a global flag for whether dbus_connection_new()
+ * will set SIGPIPE behavior to SIG_IGN.
+ *
+ * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
+ */
+void
+dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
+{
+ _dbus_modify_sigpipe = will_modify_sigpipe;
+}
+
+/* This must be called with the connection lock not held to avoid
+ * holding it over the free_data callbacks, so it can basically
+ * only be called at last unref
+ */
+static void
+_dbus_connection_free_data_slots_nolock (DBusConnection *connection)
+{
+ int i;
+
+ i = 0;
+ while (i < connection->n_slots)
+ {
+ if (connection->data_slots[i].free_data_func)
+ (* connection->data_slots[i].free_data_func) (connection->data_slots[i].data);
+ connection->data_slots[i].data = NULL;
+ connection->data_slots[i].free_data_func = NULL;
+ ++i;
+ }
+
+ dbus_free (connection->data_slots);
+ connection->data_slots = NULL;
+ connection->n_slots = 0;
+}
+
+/**
+ * Specifies the maximum size message this connection is allowed to
+ * receive. Larger messages will result in disconnecting the
+ * connection.
+ *
+ * @param connection a #DBusConnection
+ * @param size maximum message size the connection can receive, in bytes
+ */
+void
+dbus_connection_set_max_message_size (DBusConnection *connection,
+ long size)
+{
+ dbus_mutex_lock (connection->mutex);
+ _dbus_transport_set_max_message_size (connection->transport,
+ size);
+ dbus_mutex_unlock (connection->mutex);
+}
+
+/**
+ * Gets the value set by dbus_connection_set_max_message_size().
+ *
+ * @param connection the connection
+ * @returns the max size of a single message
+ */
+long
+dbus_connection_get_max_message_size (DBusConnection *connection)
+{
+ long res;
+ dbus_mutex_lock (connection->mutex);
+ res = _dbus_transport_get_max_message_size (connection->transport);
+ dbus_mutex_unlock (connection->mutex);
+ return res;
+}
+
+/**
+ * Sets the maximum total number of bytes that can be used for all messages
+ * received on this connection. Messages count toward the maximum until
+ * they are finalized. When the maximum is reached, the connection will
+ * not read more data until some messages are finalized.
+ *
+ * The semantics of the maximum are: if outstanding messages are
+ * already above the maximum, additional messages will not be read.
+ * The semantics are not: if the next message would cause us to exceed
+ * the maximum, we don't read it. The reason is that we don't know the
+ * size of a message until after we read it.
+ *
+ * Thus, the max live messages size can actually be exceeded
+ * by up to the maximum size of a single message.
+ *
+ * Also, if we read say 1024 bytes off the wire in a single read(),
+ * and that contains a half-dozen small messages, we may exceed the
+ * size max by that amount. But this should be inconsequential.
+ *
+ * @param connection the connection
+ * @param size the maximum size in bytes of all outstanding messages
+ */
+void
+dbus_connection_set_max_live_messages_size (DBusConnection *connection,
+ long size)
+{
+ dbus_mutex_lock (connection->mutex);
+ _dbus_transport_set_max_live_messages_size (connection->transport,
+ size);
+ dbus_mutex_unlock (connection->mutex);
+}
+
+/**
+ * Gets the value set by dbus_connection_set_max_live_messages_size().
+ *
+ * @param connection the connection
+ * @returns the max size of all live messages
+ */
+long
+dbus_connection_get_max_live_messages_size (DBusConnection *connection)
+{
+ long res;
+ dbus_mutex_lock (connection->mutex);
+ res = _dbus_transport_get_max_live_messages_size (connection->transport);
+ dbus_mutex_unlock (connection->mutex);
+ return res;
}
/** @} */
projects / platform / upstream / dbus.git / blobdiff