1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-connection.c DBusConnection object
4 * Copyright (C) 2002, 2003 Red Hat Inc.
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
25 #include "dbus-connection.h"
26 #include "dbus-list.h"
27 #include "dbus-timeout.h"
28 #include "dbus-transport.h"
29 #include "dbus-watch.h"
30 #include "dbus-connection-internal.h"
31 #include "dbus-list.h"
32 #include "dbus-hash.h"
33 #include "dbus-message-internal.h"
34 #include "dbus-message-handler.h"
35 #include "dbus-threads.h"
36 #include "dbus-protocol.h"
37 #include "dbus-dataslot.h"
40 #define CONNECTION_LOCK(connection) do { \
41 _dbus_verbose (" LOCK: %s\n", _DBUS_FUNCTION_NAME); \
42 dbus_mutex_lock ((connection)->mutex); \
44 #define CONNECTION_UNLOCK(connection) do { \
45 _dbus_verbose (" UNLOCK: %s\n", _DBUS_FUNCTION_NAME); \
46 dbus_mutex_unlock ((connection)->mutex); \
49 #define CONNECTION_LOCK(connection) dbus_mutex_lock ((connection)->mutex)
50 #define CONNECTION_UNLOCK(connection) dbus_mutex_unlock ((connection)->mutex)
54 * @defgroup DBusConnection DBusConnection
56 * @brief Connection to another application
58 * A DBusConnection represents a connection to another
59 * application. Messages can be sent and received via this connection.
60 * The other application may be a message bus; for convenience, the
61 * function dbus_bus_get() is provided to automatically open a
62 * connection to the well-known message buses.
64 * In brief a DBusConnection is a message queue associated with some
65 * message transport mechanism such as a socket. The connection
66 * maintains a queue of incoming messages and a queue of outgoing
69 * Incoming messages are normally processed by calling
70 * dbus_connection_dispatch(). dbus_connection_dispatch() runs any
71 * handlers registered for the topmost message in the message queue,
72 * then discards the message, then returns.
74 * dbus_connection_get_dispatch_status() indicates whether
75 * messages are currently in the queue that need dispatching.
76 * dbus_connection_set_dispatch_status_function() allows
77 * you to set a function to be used to monitor the dispatch status.
79 * If you're using GLib or Qt add-on libraries for D-BUS, there are
80 * special convenience functions in those libraries that hide
81 * all the details of dispatch and watch/timeout monitoring.
82 * For example, dbus_connection_setup_with_g_main().
84 * If you aren't using these add-on libraries, you have to manually
85 * call dbus_connection_set_dispatch_status_function(),
86 * dbus_connection_set_watch_functions(),
87 * dbus_connection_set_timeout_functions() providing appropriate
88 * functions to integrate the connection with your application's main
91 * When you use dbus_connection_send() or one of its variants to send
92 * a message, the message is added to the outgoing queue. It's
93 * actually written to the network later; either in
94 * dbus_watch_handle() invoked by your main loop, or in
95 * dbus_connection_flush() which blocks until it can write out the
96 * entire outgoing queue. The GLib/Qt add-on libraries again
97 * handle the details here for you by setting up watch functions.
99 * When a connection is disconnected, you are guaranteed to get a
100 * message with the name #DBUS_MESSAGE_LOCAL_DISCONNECT.
102 * You may not drop the last reference to a #DBusConnection
103 * until that connection has been disconnected.
105 * You may dispatch the unprocessed incoming message queue even if the
106 * connection is disconnected. However, #DBUS_MESSAGE_LOCAL_DISCONNECT
107 * will always be the last message in the queue (obviously no messages
108 * are received after disconnection).
110 * #DBusConnection has thread locks and drops them when invoking user
111 * callbacks, so in general is transparently threadsafe. However,
112 * #DBusMessage does NOT have thread locks; you must not send the same
113 * message to multiple #DBusConnection that will be used from
118 * @defgroup DBusConnectionInternals DBusConnection implementation details
119 * @ingroup DBusInternals
120 * @brief Implementation details of DBusConnection
125 /** default timeout value when waiting for a message reply */
126 #define DEFAULT_TIMEOUT_VALUE (15 * 1000)
128 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
131 * Implementation details of DBusConnection. All fields are private.
133 struct DBusConnection
135 dbus_atomic_t refcount; /**< Reference count. */
137 DBusMutex *mutex; /**< Lock on the entire DBusConnection */
139 dbus_bool_t dispatch_acquired; /**< Protects dispatch() */
140 DBusCondVar *dispatch_cond; /**< Protects dispatch() */
142 dbus_bool_t io_path_acquired; /**< Protects transport io path */
143 DBusCondVar *io_path_cond; /**< Protects transport io path */
145 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
146 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
148 DBusMessage *message_borrowed; /**< True if the first incoming message has been borrowed */
149 DBusCondVar *message_returned_cond; /**< Used with dbus_connection_borrow_message() */
151 int n_outgoing; /**< Length of outgoing queue. */
152 int n_incoming; /**< Length of incoming queue. */
154 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
156 DBusTransport *transport; /**< Object that sends/receives messages over network. */
157 DBusWatchList *watches; /**< Stores active watches. */
158 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
160 DBusHashTable *handler_table; /**< Table of registered DBusMessageHandler */
161 DBusList *filter_list; /**< List of filters. */
163 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
165 DBusHashTable *pending_replies; /**< Hash of message serials and their message handlers. */
167 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
168 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
170 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
171 void *wakeup_main_data; /**< Application data for wakeup_main_function */
172 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
174 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
175 void *dispatch_status_data; /**< Application data for dispatch_status_function */
176 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
178 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
183 DBusConnection *connection;
184 DBusMessageHandler *handler;
185 DBusTimeout *timeout;
188 DBusList *timeout_link; /* Preallocated timeout response */
190 dbus_bool_t timeout_added;
191 dbus_bool_t connection_added;
194 static void reply_handler_data_free (ReplyHandlerData *data);
196 static void _dbus_connection_remove_timeout_locked (DBusConnection *connection,
197 DBusTimeout *timeout);
198 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
199 static void _dbus_connection_update_dispatch_status_locked (DBusConnection *connection,
200 DBusDispatchStatus new_status);
204 * Acquires the connection lock.
206 * @param connection the connection.
209 _dbus_connection_lock (DBusConnection *connection)
211 CONNECTION_LOCK (connection);
215 * Releases the connection lock.
217 * @param connection the connection.
220 _dbus_connection_unlock (DBusConnection *connection)
222 CONNECTION_UNLOCK (connection);
226 * Wakes up the main loop if it is sleeping
227 * Needed if we're e.g. queueing outgoing messages
228 * on a thread while the mainloop sleeps.
230 * @param connection the connection.
233 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
235 if (connection->wakeup_main_function)
236 (*connection->wakeup_main_function) (connection->wakeup_main_data);
239 #ifdef DBUS_BUILD_TESTS
240 /* For now this function isn't used */
242 * Adds a message to the incoming message queue, returning #FALSE
243 * if there's insufficient memory to queue the message.
244 * Does not take over refcount of the message.
246 * @param connection the connection.
247 * @param message the message to queue.
248 * @returns #TRUE on success.
251 _dbus_connection_queue_received_message (DBusConnection *connection,
252 DBusMessage *message)
256 link = _dbus_list_alloc_link (message);
260 dbus_message_ref (message);
261 _dbus_connection_queue_received_message_link (connection, link);
268 * Adds a message-containing list link to the incoming message queue,
269 * taking ownership of the link and the message's current refcount.
270 * Cannot fail due to lack of memory.
272 * @param connection the connection.
273 * @param link the message link to queue.
276 _dbus_connection_queue_received_message_link (DBusConnection *connection,
279 ReplyHandlerData *reply_handler_data;
280 dbus_int32_t reply_serial;
281 DBusMessage *message;
283 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
285 _dbus_list_append_link (&connection->incoming_messages,
287 message = link->data;
289 /* If this is a reply we're waiting on, remove timeout for it */
290 reply_serial = dbus_message_get_reply_serial (message);
291 if (reply_serial != -1)
293 reply_handler_data = _dbus_hash_table_lookup_int (connection->pending_replies,
295 if (reply_handler_data != NULL)
297 if (reply_handler_data->timeout_added)
298 _dbus_connection_remove_timeout_locked (connection,
299 reply_handler_data->timeout);
300 reply_handler_data->timeout_added = FALSE;
304 connection->n_incoming += 1;
306 _dbus_connection_wakeup_mainloop (connection);
308 _dbus_assert (dbus_message_get_name (message) != NULL);
309 _dbus_verbose ("Message %p (%s) added to incoming queue %p, %d incoming\n",
310 message, dbus_message_get_name (message),
312 connection->n_incoming);
316 * Adds a link + message to the incoming message queue.
317 * Can't fail. Takes ownership of both link and message.
319 * @param connection the connection.
320 * @param link the list node and message to queue.
322 * @todo This needs to wake up the mainloop if it is in
323 * a poll/select and this is a multithreaded app.
326 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
329 _dbus_list_append_link (&connection->incoming_messages, link);
331 connection->n_incoming += 1;
333 _dbus_connection_wakeup_mainloop (connection);
335 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
336 link->data, connection, connection->n_incoming);
341 * Checks whether there are messages in the outgoing message queue.
343 * @param connection the connection.
344 * @returns #TRUE if the outgoing queue is non-empty.
347 _dbus_connection_have_messages_to_send (DBusConnection *connection)
349 return connection->outgoing_messages != NULL;
353 * Gets the next outgoing message. The message remains in the
354 * queue, and the caller does not own a reference to it.
356 * @param connection the connection.
357 * @returns the message to be sent.
360 _dbus_connection_get_message_to_send (DBusConnection *connection)
362 return _dbus_list_get_last (&connection->outgoing_messages);
366 * Notifies the connection that a message has been sent, so the
367 * message can be removed from the outgoing queue.
369 * @param connection the connection.
370 * @param message the message that was sent.
373 _dbus_connection_message_sent (DBusConnection *connection,
374 DBusMessage *message)
376 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
377 _dbus_assert (message == _dbus_list_get_last (&connection->outgoing_messages));
379 _dbus_list_pop_last (&connection->outgoing_messages);
381 connection->n_outgoing -= 1;
383 _dbus_verbose ("Message %p (%s) removed from outgoing queue %p, %d left to send\n",
384 message, dbus_message_get_name (message),
385 connection, connection->n_outgoing);
387 _dbus_message_remove_size_counter (message, connection->outgoing_counter);
389 dbus_message_unref (message);
391 if (connection->n_outgoing == 0)
392 _dbus_transport_messages_pending (connection->transport,
393 connection->n_outgoing);
397 * Adds a watch using the connection's DBusAddWatchFunction if
398 * available. Otherwise records the watch to be added when said
399 * function is available. Also re-adds the watch if the
400 * DBusAddWatchFunction changes. May fail due to lack of memory.
402 * @param connection the connection.
403 * @param watch the watch to add.
404 * @returns #TRUE on success.
407 _dbus_connection_add_watch (DBusConnection *connection,
410 if (connection->watches) /* null during finalize */
411 return _dbus_watch_list_add_watch (connection->watches,
418 * Removes a watch using the connection's DBusRemoveWatchFunction
419 * if available. It's an error to call this function on a watch
420 * that was not previously added.
422 * @param connection the connection.
423 * @param watch the watch to remove.
426 _dbus_connection_remove_watch (DBusConnection *connection,
429 if (connection->watches) /* null during finalize */
430 _dbus_watch_list_remove_watch (connection->watches,
435 * Toggles a watch and notifies app via connection's
436 * DBusWatchToggledFunction if available. It's an error to call this
437 * function on a watch that was not previously added.
439 * @param connection the connection.
440 * @param watch the watch to toggle.
441 * @param enabled whether to enable or disable
444 _dbus_connection_toggle_watch (DBusConnection *connection,
448 if (connection->watches) /* null during finalize */
449 _dbus_watch_list_toggle_watch (connection->watches,
454 * Adds a timeout using the connection's DBusAddTimeoutFunction if
455 * available. Otherwise records the timeout to be added when said
456 * function is available. Also re-adds the timeout if the
457 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
458 * The timeout will fire repeatedly until removed.
460 * @param connection the connection.
461 * @param timeout the timeout to add.
462 * @returns #TRUE on success.
465 _dbus_connection_add_timeout (DBusConnection *connection,
466 DBusTimeout *timeout)
468 if (connection->timeouts) /* null during finalize */
469 return _dbus_timeout_list_add_timeout (connection->timeouts,
476 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
477 * if available. It's an error to call this function on a timeout
478 * that was not previously added.
480 * @param connection the connection.
481 * @param timeout the timeout to remove.
484 _dbus_connection_remove_timeout (DBusConnection *connection,
485 DBusTimeout *timeout)
487 if (connection->timeouts) /* null during finalize */
488 _dbus_timeout_list_remove_timeout (connection->timeouts,
493 _dbus_connection_remove_timeout_locked (DBusConnection *connection,
494 DBusTimeout *timeout)
496 CONNECTION_LOCK (connection);
497 _dbus_connection_remove_timeout (connection, timeout);
498 CONNECTION_UNLOCK (connection);
502 * Toggles a timeout and notifies app via connection's
503 * DBusTimeoutToggledFunction if available. It's an error to call this
504 * function on a timeout that was not previously added.
506 * @param connection the connection.
507 * @param timeout the timeout to toggle.
508 * @param enabled whether to enable or disable
511 _dbus_connection_toggle_timeout (DBusConnection *connection,
512 DBusTimeout *timeout,
515 if (connection->timeouts) /* null during finalize */
516 _dbus_timeout_list_toggle_timeout (connection->timeouts,
521 * Tells the connection that the transport has been disconnected.
522 * Results in posting a disconnect message on the incoming message
523 * queue. Only has an effect the first time it's called.
525 * @param connection the connection
528 _dbus_connection_notify_disconnected (DBusConnection *connection)
530 if (connection->disconnect_message_link)
532 /* We haven't sent the disconnect message already */
533 _dbus_connection_queue_synthesized_message_link (connection,
534 connection->disconnect_message_link);
535 connection->disconnect_message_link = NULL;
541 * Acquire the transporter I/O path. This must be done before
542 * doing any I/O in the transporter. May sleep and drop the
543 * connection mutex while waiting for the I/O path.
545 * @param connection the connection.
546 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
547 * @returns TRUE if the I/O path was acquired.
550 _dbus_connection_acquire_io_path (DBusConnection *connection,
551 int timeout_milliseconds)
553 dbus_bool_t res = TRUE;
555 if (connection->io_path_acquired)
557 if (timeout_milliseconds != -1)
558 res = dbus_condvar_wait_timeout (connection->io_path_cond,
560 timeout_milliseconds);
562 dbus_condvar_wait (connection->io_path_cond, connection->mutex);
567 _dbus_assert (!connection->io_path_acquired);
569 connection->io_path_acquired = TRUE;
576 * Release the I/O path when you're done with it. Only call
577 * after you've acquired the I/O. Wakes up at most one thread
578 * currently waiting to acquire the I/O path.
580 * @param connection the connection.
583 _dbus_connection_release_io_path (DBusConnection *connection)
585 _dbus_assert (connection->io_path_acquired);
587 connection->io_path_acquired = FALSE;
588 dbus_condvar_wake_one (connection->io_path_cond);
593 * Queues incoming messages and sends outgoing messages for this
594 * connection, optionally blocking in the process. Each call to
595 * _dbus_connection_do_iteration() will call select() or poll() one
596 * time and then read or write data if possible.
598 * The purpose of this function is to be able to flush outgoing
599 * messages or queue up incoming messages without returning
600 * control to the application and causing reentrancy weirdness.
602 * The flags parameter allows you to specify whether to
603 * read incoming messages, write outgoing messages, or both,
604 * and whether to block if no immediate action is possible.
606 * The timeout_milliseconds parameter does nothing unless the
607 * iteration is blocking.
609 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
610 * wasn't specified, then it's impossible to block, even if
611 * you specify DBUS_ITERATION_BLOCK; in that case the function
612 * returns immediately.
614 * @param connection the connection.
615 * @param flags iteration flags.
616 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
619 _dbus_connection_do_iteration (DBusConnection *connection,
621 int timeout_milliseconds)
623 if (connection->n_outgoing == 0)
624 flags &= ~DBUS_ITERATION_DO_WRITING;
626 if (_dbus_connection_acquire_io_path (connection,
627 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
629 _dbus_transport_do_iteration (connection->transport,
630 flags, timeout_milliseconds);
631 _dbus_connection_release_io_path (connection);
636 * Creates a new connection for the given transport. A transport
637 * represents a message stream that uses some concrete mechanism, such
638 * as UNIX domain sockets. May return #NULL if insufficient
639 * memory exists to create the connection.
641 * @param transport the transport.
642 * @returns the new connection, or #NULL on failure.
645 _dbus_connection_new_for_transport (DBusTransport *transport)
647 DBusConnection *connection;
648 DBusWatchList *watch_list;
649 DBusTimeoutList *timeout_list;
650 DBusHashTable *handler_table, *pending_replies;
652 DBusCondVar *message_returned_cond;
653 DBusCondVar *dispatch_cond;
654 DBusCondVar *io_path_cond;
655 DBusList *disconnect_link;
656 DBusMessage *disconnect_message;
657 DBusCounter *outgoing_counter;
661 handler_table = NULL;
662 pending_replies = NULL;
665 message_returned_cond = NULL;
666 dispatch_cond = NULL;
668 disconnect_link = NULL;
669 disconnect_message = NULL;
670 outgoing_counter = NULL;
672 watch_list = _dbus_watch_list_new ();
673 if (watch_list == NULL)
676 timeout_list = _dbus_timeout_list_new ();
677 if (timeout_list == NULL)
681 _dbus_hash_table_new (DBUS_HASH_STRING,
683 if (handler_table == NULL)
687 _dbus_hash_table_new (DBUS_HASH_INT,
688 NULL, (DBusFreeFunction)reply_handler_data_free);
689 if (pending_replies == NULL)
692 connection = dbus_new0 (DBusConnection, 1);
693 if (connection == NULL)
696 mutex = dbus_mutex_new ();
700 message_returned_cond = dbus_condvar_new ();
701 if (message_returned_cond == NULL)
704 dispatch_cond = dbus_condvar_new ();
705 if (dispatch_cond == NULL)
708 io_path_cond = dbus_condvar_new ();
709 if (io_path_cond == NULL)
712 disconnect_message = dbus_message_new (DBUS_MESSAGE_LOCAL_DISCONNECT, NULL);
713 if (disconnect_message == NULL)
716 disconnect_link = _dbus_list_alloc_link (disconnect_message);
717 if (disconnect_link == NULL)
720 outgoing_counter = _dbus_counter_new ();
721 if (outgoing_counter == NULL)
724 if (_dbus_modify_sigpipe)
725 _dbus_disable_sigpipe ();
727 connection->refcount = 1;
728 connection->mutex = mutex;
729 connection->dispatch_cond = dispatch_cond;
730 connection->io_path_cond = io_path_cond;
731 connection->message_returned_cond = message_returned_cond;
732 connection->transport = transport;
733 connection->watches = watch_list;
734 connection->timeouts = timeout_list;
735 connection->handler_table = handler_table;
736 connection->pending_replies = pending_replies;
737 connection->outgoing_counter = outgoing_counter;
738 connection->filter_list = NULL;
739 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
741 _dbus_data_slot_list_init (&connection->slot_list);
743 connection->client_serial = 1;
745 connection->disconnect_message_link = disconnect_link;
747 if (!_dbus_transport_set_connection (transport, connection))
750 _dbus_transport_ref (transport);
755 if (disconnect_message != NULL)
756 dbus_message_unref (disconnect_message);
758 if (disconnect_link != NULL)
759 _dbus_list_free_link (disconnect_link);
761 if (io_path_cond != NULL)
762 dbus_condvar_free (io_path_cond);
764 if (dispatch_cond != NULL)
765 dbus_condvar_free (dispatch_cond);
767 if (message_returned_cond != NULL)
768 dbus_condvar_free (message_returned_cond);
771 dbus_mutex_free (mutex);
773 if (connection != NULL)
774 dbus_free (connection);
777 _dbus_hash_table_unref (handler_table);
780 _dbus_hash_table_unref (pending_replies);
783 _dbus_watch_list_free (watch_list);
786 _dbus_timeout_list_free (timeout_list);
788 if (outgoing_counter)
789 _dbus_counter_unref (outgoing_counter);
795 * Increments the reference count of a DBusConnection.
796 * Requires that the caller already holds the connection lock.
798 * @param connection the connection.
801 _dbus_connection_ref_unlocked (DBusConnection *connection)
803 _dbus_assert (connection->refcount > 0);
804 connection->refcount += 1;
808 _dbus_connection_get_next_client_serial (DBusConnection *connection)
812 serial = connection->client_serial++;
814 if (connection->client_serial < 0)
815 connection->client_serial = 1;
821 * Used to notify a connection when a DBusMessageHandler is
822 * destroyed, so the connection can drop any reference
823 * to the handler. This is a private function, but still
824 * takes the connection lock. Don't call it with the lock held.
826 * @todo needs to check in pending_replies too.
828 * @param connection the connection
829 * @param handler the handler
832 _dbus_connection_handler_destroyed_locked (DBusConnection *connection,
833 DBusMessageHandler *handler)
838 CONNECTION_LOCK (connection);
840 _dbus_hash_iter_init (connection->handler_table, &iter);
841 while (_dbus_hash_iter_next (&iter))
843 DBusMessageHandler *h = _dbus_hash_iter_get_value (&iter);
846 _dbus_hash_iter_remove_entry (&iter);
849 link = _dbus_list_get_first_link (&connection->filter_list);
852 DBusMessageHandler *h = link->data;
853 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
856 _dbus_list_remove_link (&connection->filter_list,
861 CONNECTION_UNLOCK (connection);
865 * A callback for use with dbus_watch_new() to create a DBusWatch.
867 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
868 * and the virtual handle_watch in DBusTransport if we got rid of it.
869 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
872 * @param watch the watch.
873 * @param condition the current condition of the file descriptors being watched.
874 * @param data must be a pointer to a #DBusConnection
875 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
878 _dbus_connection_handle_watch (DBusWatch *watch,
879 unsigned int condition,
882 DBusConnection *connection;
884 DBusDispatchStatus status;
888 CONNECTION_LOCK (connection);
889 _dbus_connection_acquire_io_path (connection, -1);
890 retval = _dbus_transport_handle_watch (connection->transport,
892 _dbus_connection_release_io_path (connection);
894 status = _dbus_connection_get_dispatch_status_unlocked (connection);
896 CONNECTION_UNLOCK (connection);
898 _dbus_connection_update_dispatch_status_locked (connection, status);
906 * @addtogroup DBusConnection
912 * Opens a new connection to a remote address.
914 * @todo specify what the address parameter is. Right now
915 * it's just the name of a UNIX domain socket. It should be
916 * something more complex that encodes which transport to use.
918 * If the open fails, the function returns #NULL, and provides
919 * a reason for the failure in the result parameter. Pass
920 * #NULL for the result parameter if you aren't interested
921 * in the reason for failure.
923 * @param address the address.
924 * @param error address where an error can be returned.
925 * @returns new connection, or #NULL on failure.
928 dbus_connection_open (const char *address,
931 DBusConnection *connection;
932 DBusTransport *transport;
934 _dbus_return_val_if_fail (address != NULL, NULL);
935 _dbus_return_val_if_error_is_set (error, NULL);
937 transport = _dbus_transport_open (address, error);
938 if (transport == NULL)
940 _DBUS_ASSERT_ERROR_IS_SET (error);
944 connection = _dbus_connection_new_for_transport (transport);
946 _dbus_transport_unref (transport);
948 if (connection == NULL)
950 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
958 * Increments the reference count of a DBusConnection.
960 * @param connection the connection.
963 dbus_connection_ref (DBusConnection *connection)
965 _dbus_return_if_fail (connection != NULL);
967 /* The connection lock is better than the global
968 * lock in the atomic increment fallback
971 #ifdef DBUS_HAVE_ATOMIC_INT
972 _dbus_atomic_inc (&connection->refcount);
974 CONNECTION_LOCK (connection);
975 _dbus_assert (connection->refcount > 0);
977 connection->refcount += 1;
978 CONNECTION_UNLOCK (connection);
983 free_outgoing_message (void *element,
986 DBusMessage *message = element;
987 DBusConnection *connection = data;
989 _dbus_message_remove_size_counter (message,
990 connection->outgoing_counter);
991 dbus_message_unref (message);
994 /* This is run without the mutex held, but after the last reference
995 * to the connection has been dropped we should have no thread-related
999 _dbus_connection_last_unref (DBusConnection *connection)
1004 _dbus_verbose ("Finalizing connection %p\n", connection);
1006 _dbus_assert (connection->refcount == 0);
1008 /* You have to disconnect the connection before unref:ing it. Otherwise
1009 * you won't get the disconnected message.
1011 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
1013 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
1014 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
1015 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
1016 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
1018 _dbus_watch_list_free (connection->watches);
1019 connection->watches = NULL;
1021 _dbus_timeout_list_free (connection->timeouts);
1022 connection->timeouts = NULL;
1024 _dbus_data_slot_list_free (&connection->slot_list);
1025 /* ---- Done with stuff that invokes application callbacks */
1027 _dbus_hash_iter_init (connection->handler_table, &iter);
1028 while (_dbus_hash_iter_next (&iter))
1030 DBusMessageHandler *h = _dbus_hash_iter_get_value (&iter);
1032 _dbus_message_handler_remove_connection (h, connection);
1035 link = _dbus_list_get_first_link (&connection->filter_list);
1036 while (link != NULL)
1038 DBusMessageHandler *h = link->data;
1039 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
1041 _dbus_message_handler_remove_connection (h, connection);
1046 _dbus_hash_table_unref (connection->handler_table);
1047 connection->handler_table = NULL;
1049 _dbus_hash_table_unref (connection->pending_replies);
1050 connection->pending_replies = NULL;
1052 _dbus_list_clear (&connection->filter_list);
1054 _dbus_list_foreach (&connection->outgoing_messages,
1055 free_outgoing_message,
1057 _dbus_list_clear (&connection->outgoing_messages);
1059 _dbus_list_foreach (&connection->incoming_messages,
1060 (DBusForeachFunction) dbus_message_unref,
1062 _dbus_list_clear (&connection->incoming_messages);
1064 _dbus_counter_unref (connection->outgoing_counter);
1066 _dbus_transport_unref (connection->transport);
1068 if (connection->disconnect_message_link)
1070 DBusMessage *message = connection->disconnect_message_link->data;
1071 dbus_message_unref (message);
1072 _dbus_list_free_link (connection->disconnect_message_link);
1075 dbus_condvar_free (connection->dispatch_cond);
1076 dbus_condvar_free (connection->io_path_cond);
1077 dbus_condvar_free (connection->message_returned_cond);
1079 dbus_mutex_free (connection->mutex);
1081 dbus_free (connection);
1085 * Decrements the reference count of a DBusConnection, and finalizes
1086 * it if the count reaches zero. It is a bug to drop the last reference
1087 * to a connection that has not been disconnected.
1089 * @todo in practice it can be quite tricky to never unref a connection
1090 * that's still connected; maybe there's some way we could avoid
1093 * @param connection the connection.
1096 dbus_connection_unref (DBusConnection *connection)
1098 dbus_bool_t last_unref;
1100 _dbus_return_if_fail (connection != NULL);
1102 /* The connection lock is better than the global
1103 * lock in the atomic increment fallback
1106 #ifdef DBUS_HAVE_ATOMIC_INT
1107 last_unref = (_dbus_atomic_dec (&connection->refcount) == 0);
1109 CONNECTION_LOCK (connection);
1111 _dbus_assert (connection->refcount > 0);
1113 connection->refcount -= 1;
1114 last_unref = (connection->refcount == 0);
1117 printf ("unref() connection %p count = %d\n", connection, connection->refcount);
1120 CONNECTION_UNLOCK (connection);
1124 _dbus_connection_last_unref (connection);
1128 * Closes the connection, so no further data can be sent or received.
1129 * Any further attempts to send data will result in errors. This
1130 * function does not affect the connection's reference count. It's
1131 * safe to disconnect a connection more than once; all calls after the
1132 * first do nothing. It's impossible to "reconnect" a connection, a
1133 * new connection must be created.
1135 * @param connection the connection.
1138 dbus_connection_disconnect (DBusConnection *connection)
1140 _dbus_return_if_fail (connection != NULL);
1142 CONNECTION_LOCK (connection);
1143 _dbus_transport_disconnect (connection->transport);
1144 CONNECTION_UNLOCK (connection);
1148 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
1150 return _dbus_transport_get_is_connected (connection->transport);
1154 * Gets whether the connection is currently connected. All
1155 * connections are connected when they are opened. A connection may
1156 * become disconnected when the remote application closes its end, or
1157 * exits; a connection may also be disconnected with
1158 * dbus_connection_disconnect().
1160 * @param connection the connection.
1161 * @returns #TRUE if the connection is still alive.
1164 dbus_connection_get_is_connected (DBusConnection *connection)
1168 _dbus_return_val_if_fail (connection != NULL, FALSE);
1170 CONNECTION_LOCK (connection);
1171 res = _dbus_connection_get_is_connected_unlocked (connection);
1172 CONNECTION_UNLOCK (connection);
1178 * Gets whether the connection was authenticated. (Note that
1179 * if the connection was authenticated then disconnected,
1180 * this function still returns #TRUE)
1182 * @param connection the connection
1183 * @returns #TRUE if the connection was ever authenticated
1186 dbus_connection_get_is_authenticated (DBusConnection *connection)
1190 _dbus_return_val_if_fail (connection != NULL, FALSE);
1192 CONNECTION_LOCK (connection);
1193 res = _dbus_transport_get_is_authenticated (connection->transport);
1194 CONNECTION_UNLOCK (connection);
1199 struct DBusPreallocatedSend
1201 DBusConnection *connection;
1202 DBusList *queue_link;
1203 DBusList *counter_link;
1208 * Preallocates resources needed to send a message, allowing the message
1209 * to be sent without the possibility of memory allocation failure.
1210 * Allows apps to create a future guarantee that they can send
1211 * a message regardless of memory shortages.
1213 * @param connection the connection we're preallocating for.
1214 * @returns the preallocated resources, or #NULL
1216 DBusPreallocatedSend*
1217 dbus_connection_preallocate_send (DBusConnection *connection)
1219 DBusPreallocatedSend *preallocated;
1221 _dbus_return_val_if_fail (connection != NULL, NULL);
1223 preallocated = dbus_new (DBusPreallocatedSend, 1);
1224 if (preallocated == NULL)
1227 CONNECTION_LOCK (connection);
1229 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1230 if (preallocated->queue_link == NULL)
1233 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1234 if (preallocated->counter_link == NULL)
1237 _dbus_counter_ref (preallocated->counter_link->data);
1239 preallocated->connection = connection;
1241 CONNECTION_UNLOCK (connection);
1243 return preallocated;
1246 _dbus_list_free_link (preallocated->queue_link);
1248 dbus_free (preallocated);
1250 CONNECTION_UNLOCK (connection);
1256 * Frees preallocated message-sending resources from
1257 * dbus_connection_preallocate_send(). Should only
1258 * be called if the preallocated resources are not used
1259 * to send a message.
1261 * @param connection the connection
1262 * @param preallocated the resources
1265 dbus_connection_free_preallocated_send (DBusConnection *connection,
1266 DBusPreallocatedSend *preallocated)
1268 _dbus_return_if_fail (connection != NULL);
1269 _dbus_return_if_fail (preallocated != NULL);
1270 _dbus_return_if_fail (connection == preallocated->connection);
1272 _dbus_list_free_link (preallocated->queue_link);
1273 _dbus_counter_unref (preallocated->counter_link->data);
1274 _dbus_list_free_link (preallocated->counter_link);
1275 dbus_free (preallocated);
1279 * Sends a message using preallocated resources. This function cannot fail.
1280 * It works identically to dbus_connection_send() in other respects.
1281 * Preallocated resources comes from dbus_connection_preallocate_send().
1282 * This function "consumes" the preallocated resources, they need not
1283 * be freed separately.
1285 * @param connection the connection
1286 * @param preallocated the preallocated resources
1287 * @param message the message to send
1288 * @param client_serial return location for client serial assigned to the message
1291 dbus_connection_send_preallocated (DBusConnection *connection,
1292 DBusPreallocatedSend *preallocated,
1293 DBusMessage *message,
1294 dbus_uint32_t *client_serial)
1296 dbus_uint32_t serial;
1298 _dbus_return_if_fail (connection != NULL);
1299 _dbus_return_if_fail (preallocated != NULL);
1300 _dbus_return_if_fail (message != NULL);
1301 _dbus_return_if_fail (preallocated->connection == connection);
1302 _dbus_return_if_fail (dbus_message_get_name (message) != NULL);
1304 CONNECTION_LOCK (connection);
1306 preallocated->queue_link->data = message;
1307 _dbus_list_prepend_link (&connection->outgoing_messages,
1308 preallocated->queue_link);
1310 _dbus_message_add_size_counter_link (message,
1311 preallocated->counter_link);
1313 dbus_free (preallocated);
1314 preallocated = NULL;
1316 dbus_message_ref (message);
1318 connection->n_outgoing += 1;
1320 _dbus_verbose ("Message %p (%s) added to outgoing queue %p, %d pending to send\n",
1322 dbus_message_get_name (message),
1324 connection->n_outgoing);
1326 if (dbus_message_get_serial (message) == 0)
1328 serial = _dbus_connection_get_next_client_serial (connection);
1329 _dbus_message_set_serial (message, serial);
1331 *client_serial = serial;
1336 *client_serial = dbus_message_get_serial (message);
1339 _dbus_message_lock (message);
1341 if (connection->n_outgoing == 1)
1342 _dbus_transport_messages_pending (connection->transport,
1343 connection->n_outgoing);
1345 _dbus_connection_wakeup_mainloop (connection);
1347 CONNECTION_UNLOCK (connection);
1351 * Adds a message to the outgoing message queue. Does not block to
1352 * write the message to the network; that happens asynchronously. To
1353 * force the message to be written, call dbus_connection_flush().
1354 * Because this only queues the message, the only reason it can
1355 * fail is lack of memory. Even if the connection is disconnected,
1356 * no error will be returned.
1358 * If the function fails due to lack of memory, it returns #FALSE.
1359 * The function will never fail for other reasons; even if the
1360 * connection is disconnected, you can queue an outgoing message,
1361 * though obviously it won't be sent.
1363 * @param connection the connection.
1364 * @param message the message to write.
1365 * @param client_serial return location for client serial.
1366 * @returns #TRUE on success.
1369 dbus_connection_send (DBusConnection *connection,
1370 DBusMessage *message,
1371 dbus_uint32_t *client_serial)
1373 DBusPreallocatedSend *preallocated;
1375 _dbus_return_val_if_fail (connection != NULL, FALSE);
1376 _dbus_return_val_if_fail (message != NULL, FALSE);
1378 preallocated = dbus_connection_preallocate_send (connection);
1379 if (preallocated == NULL)
1385 dbus_connection_send_preallocated (connection, preallocated, message, client_serial);
1391 reply_handler_timeout (void *data)
1393 DBusConnection *connection;
1394 ReplyHandlerData *reply_handler_data = data;
1395 DBusDispatchStatus status;
1397 connection = reply_handler_data->connection;
1399 CONNECTION_LOCK (connection);
1400 if (reply_handler_data->timeout_link)
1402 _dbus_connection_queue_synthesized_message_link (connection,
1403 reply_handler_data->timeout_link);
1404 reply_handler_data->timeout_link = NULL;
1407 _dbus_connection_remove_timeout (connection,
1408 reply_handler_data->timeout);
1409 reply_handler_data->timeout_added = FALSE;
1411 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1413 CONNECTION_UNLOCK (connection);
1415 _dbus_connection_update_dispatch_status_locked (connection, status);
1421 reply_handler_data_free (ReplyHandlerData *data)
1426 if (data->timeout_added)
1427 _dbus_connection_remove_timeout_locked (data->connection,
1430 if (data->connection_added)
1431 _dbus_message_handler_remove_connection (data->handler,
1434 if (data->timeout_link)
1436 dbus_message_unref ((DBusMessage *)data->timeout_link->data);
1437 _dbus_list_free_link (data->timeout_link);
1440 dbus_message_handler_unref (data->handler);
1446 * Queues a message to send, as with dbus_connection_send_message(),
1447 * but also sets up a DBusMessageHandler to receive a reply to the
1448 * message. If no reply is received in the given timeout_milliseconds,
1449 * expires the pending reply and sends the DBusMessageHandler a
1450 * synthetic error reply (generated in-process, not by the remote
1451 * application) indicating that a timeout occurred.
1453 * Reply handlers see their replies after message filters see them,
1454 * but before message handlers added with
1455 * dbus_connection_register_handler() see them, regardless of the
1456 * reply message's name. Reply handlers are only handed a single
1457 * message as a reply, after one reply has been seen the handler is
1458 * removed. If a filter filters out the reply before the handler sees
1459 * it, the reply is immediately timed out and a timeout error reply is
1460 * generated. If a filter removes the timeout error reply then the
1461 * reply handler will never be called. Filters should not do this.
1463 * If #NULL is passed for the reply_handler, the timeout reply will
1464 * still be generated and placed into the message queue, but no
1465 * specific message handler will receive the reply.
1467 * If -1 is passed for the timeout, a sane default timeout is used. -1
1468 * is typically the best value for the timeout for this reason, unless
1469 * you want a very short or very long timeout. There is no way to
1470 * avoid a timeout entirely, other than passing INT_MAX for the
1471 * timeout to postpone it indefinitely.
1473 * @param connection the connection
1474 * @param message the message to send
1475 * @param reply_handler message handler expecting the reply, or #NULL
1476 * @param timeout_milliseconds timeout in milliseconds or -1 for default
1477 * @returns #TRUE if the message is successfully queued, #FALSE if no memory.
1481 dbus_connection_send_with_reply (DBusConnection *connection,
1482 DBusMessage *message,
1483 DBusMessageHandler *reply_handler,
1484 int timeout_milliseconds)
1486 DBusTimeout *timeout;
1487 ReplyHandlerData *data;
1489 DBusList *reply_link;
1490 dbus_int32_t serial = -1;
1492 _dbus_return_val_if_fail (connection != NULL, FALSE);
1493 _dbus_return_val_if_fail (message != NULL, FALSE);
1494 _dbus_return_val_if_fail (reply_handler != NULL, FALSE);
1495 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
1497 if (timeout_milliseconds == -1)
1498 timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
1500 data = dbus_new0 (ReplyHandlerData, 1);
1505 timeout = _dbus_timeout_new (timeout_milliseconds, reply_handler_timeout,
1510 reply_handler_data_free (data);
1514 CONNECTION_LOCK (connection);
1517 if (!_dbus_connection_add_timeout (connection, timeout))
1519 reply_handler_data_free (data);
1520 _dbus_timeout_unref (timeout);
1521 CONNECTION_UNLOCK (connection);
1525 /* The connection now owns the reference to the timeout. */
1526 _dbus_timeout_unref (timeout);
1528 data->timeout_added = TRUE;
1529 data->timeout = timeout;
1530 data->connection = connection;
1532 if (!_dbus_message_handler_add_connection (reply_handler, connection))
1534 CONNECTION_UNLOCK (connection);
1535 reply_handler_data_free (data);
1538 data->connection_added = TRUE;
1540 /* Assign a serial to the message */
1541 if (dbus_message_get_serial (message) == 0)
1543 serial = _dbus_connection_get_next_client_serial (connection);
1544 _dbus_message_set_serial (message, serial);
1547 data->handler = reply_handler;
1548 data->serial = serial;
1550 dbus_message_handler_ref (reply_handler);
1552 reply = dbus_message_new_error_reply (message, DBUS_ERROR_NO_REPLY,
1553 "No reply within specified time");
1556 CONNECTION_UNLOCK (connection);
1557 reply_handler_data_free (data);
1561 reply_link = _dbus_list_alloc_link (reply);
1564 CONNECTION_UNLOCK (connection);
1565 dbus_message_unref (reply);
1566 reply_handler_data_free (data);
1570 data->timeout_link = reply_link;
1572 /* Insert the serial in the pending replies hash. */
1573 if (!_dbus_hash_table_insert_int (connection->pending_replies, serial, data))
1575 CONNECTION_UNLOCK (connection);
1576 reply_handler_data_free (data);
1580 CONNECTION_UNLOCK (connection);
1582 if (!dbus_connection_send (connection, message, NULL))
1584 /* This will free the handler data too */
1585 _dbus_hash_table_remove_int (connection->pending_replies, serial);
1594 check_for_reply_unlocked (DBusConnection *connection,
1595 dbus_uint32_t client_serial)
1599 link = _dbus_list_get_first_link (&connection->incoming_messages);
1601 while (link != NULL)
1603 DBusMessage *reply = link->data;
1605 if (dbus_message_get_reply_serial (reply) == client_serial)
1607 _dbus_list_remove_link (&connection->incoming_messages, link);
1608 connection->n_incoming -= 1;
1609 dbus_message_ref (reply);
1612 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
1619 * Sends a message and blocks a certain time period while waiting for a reply.
1620 * This function does not dispatch any message handlers until the main loop
1621 * has been reached. This function is used to do non-reentrant "method calls."
1622 * If a reply is received, it is returned, and removed from the incoming
1623 * message queue. If it is not received, #NULL is returned and the
1624 * error is set to #DBUS_ERROR_NO_REPLY. If something else goes
1625 * wrong, result is set to whatever is appropriate, such as
1626 * #DBUS_ERROR_NO_MEMORY or #DBUS_ERROR_DISCONNECTED.
1628 * @todo could use performance improvements (it keeps scanning
1629 * the whole message queue for example) and has thread issues,
1630 * see comments in source
1632 * @param connection the connection
1633 * @param message the message to send
1634 * @param timeout_milliseconds timeout in milliseconds or -1 for default
1635 * @param error return location for error message
1636 * @returns the message that is the reply or #NULL with an error code if the
1640 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
1641 DBusMessage *message,
1642 int timeout_milliseconds,
1645 dbus_uint32_t client_serial;
1646 long start_tv_sec, start_tv_usec;
1647 long end_tv_sec, end_tv_usec;
1648 long tv_sec, tv_usec;
1649 DBusDispatchStatus status;
1651 _dbus_return_val_if_fail (connection != NULL, NULL);
1652 _dbus_return_val_if_fail (message != NULL, NULL);
1653 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
1654 _dbus_return_val_if_error_is_set (error, NULL);
1656 if (timeout_milliseconds == -1)
1657 timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
1659 /* it would probably seem logical to pass in _DBUS_INT_MAX
1660 * for infinite timeout, but then math below would get
1661 * all overflow-prone, so smack that down.
1663 if (timeout_milliseconds > _DBUS_ONE_HOUR_IN_MILLISECONDS * 6)
1664 timeout_milliseconds = _DBUS_ONE_HOUR_IN_MILLISECONDS * 6;
1666 if (!dbus_connection_send (connection, message, &client_serial))
1668 _DBUS_SET_OOM (error);
1674 /* Flush message queue */
1675 dbus_connection_flush (connection);
1677 CONNECTION_LOCK (connection);
1679 _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
1680 end_tv_sec = start_tv_sec + timeout_milliseconds / 1000;
1681 end_tv_usec = start_tv_usec + (timeout_milliseconds % 1000) * 1000;
1682 end_tv_sec += end_tv_usec / _DBUS_USEC_PER_SECOND;
1683 end_tv_usec = end_tv_usec % _DBUS_USEC_PER_SECOND;
1685 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec to %ld sec %ld usec\n",
1686 timeout_milliseconds,
1688 start_tv_sec, start_tv_usec,
1689 end_tv_sec, end_tv_usec);
1691 /* Now we wait... */
1692 /* THREAD TODO: This is busted. What if a dispatch() or pop_message
1693 * gets the message before we do?
1695 /* always block at least once as we know we don't have the reply yet */
1696 _dbus_connection_do_iteration (connection,
1697 DBUS_ITERATION_DO_READING |
1698 DBUS_ITERATION_BLOCK,
1699 timeout_milliseconds);
1703 /* queue messages and get status */
1704 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1706 if (status == DBUS_DISPATCH_DATA_REMAINS)
1710 reply = check_for_reply_unlocked (connection, client_serial);
1713 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1715 CONNECTION_UNLOCK (connection);
1717 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply %s\n",
1718 dbus_message_get_name (reply));
1720 _dbus_connection_update_dispatch_status_locked (connection, status);
1726 _dbus_get_current_time (&tv_sec, &tv_usec);
1728 if (tv_sec < start_tv_sec)
1729 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
1730 else if (connection->disconnect_message_link == NULL)
1731 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
1732 else if (tv_sec < end_tv_sec ||
1733 (tv_sec == end_tv_sec && tv_usec < end_tv_usec))
1735 timeout_milliseconds = (end_tv_sec - tv_sec) * 1000 +
1736 (end_tv_usec - tv_usec) / 1000;
1737 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds);
1738 _dbus_assert (timeout_milliseconds >= 0);
1740 if (status == DBUS_DISPATCH_NEED_MEMORY)
1742 /* Try sleeping a bit, as we aren't sure we need to block for reading,
1743 * we may already have a reply in the buffer and just can't process
1746 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
1748 if (timeout_milliseconds < 100)
1749 ; /* just busy loop */
1750 else if (timeout_milliseconds <= 1000)
1751 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
1753 _dbus_sleep_milliseconds (1000);
1757 /* block again, we don't have the reply buffered yet. */
1758 _dbus_connection_do_iteration (connection,
1759 DBUS_ITERATION_DO_READING |
1760 DBUS_ITERATION_BLOCK,
1761 timeout_milliseconds);
1764 goto recheck_status;
1767 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %ld milliseconds and got no reply\n",
1768 (tv_sec - start_tv_sec) * 1000 + (tv_usec - start_tv_usec) / 1000);
1770 if (dbus_connection_get_is_connected (connection))
1771 dbus_set_error (error, DBUS_ERROR_NO_REPLY, "Message did not receive a reply");
1773 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Disconnected prior to receiving a reply");
1775 CONNECTION_UNLOCK (connection);
1777 _dbus_connection_update_dispatch_status_locked (connection, status);
1783 * Blocks until the outgoing message queue is empty.
1785 * @param connection the connection.
1788 dbus_connection_flush (DBusConnection *connection)
1790 /* We have to specify DBUS_ITERATION_DO_READING here because
1791 * otherwise we could have two apps deadlock if they are both doing
1792 * a flush(), and the kernel buffers fill up. This could change the
1795 DBusDispatchStatus status;
1797 _dbus_return_if_fail (connection != NULL);
1799 CONNECTION_LOCK (connection);
1800 while (connection->n_outgoing > 0 &&
1801 _dbus_connection_get_is_connected_unlocked (connection))
1802 _dbus_connection_do_iteration (connection,
1803 DBUS_ITERATION_DO_READING |
1804 DBUS_ITERATION_DO_WRITING |
1805 DBUS_ITERATION_BLOCK,
1808 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1810 CONNECTION_UNLOCK (connection);
1812 _dbus_connection_update_dispatch_status_locked (connection, status);
1815 /* Call with mutex held. Will drop it while waiting and re-acquire
1819 _dbus_connection_wait_for_borrowed (DBusConnection *connection)
1821 _dbus_assert (connection->message_borrowed != NULL);
1823 while (connection->message_borrowed != NULL)
1824 dbus_condvar_wait (connection->message_returned_cond, connection->mutex);
1828 * Returns the first-received message from the incoming message queue,
1829 * leaving it in the queue. If the queue is empty, returns #NULL.
1831 * The caller does not own a reference to the returned message, and
1832 * must either return it using dbus_connection_return_message() or
1833 * keep it after calling dbus_connection_steal_borrowed_message(). No
1834 * one can get at the message while its borrowed, so return it as
1835 * quickly as possible and don't keep a reference to it after
1836 * returning it. If you need to keep the message, make a copy of it.
1838 * @param connection the connection.
1839 * @returns next message in the incoming queue.
1842 dbus_connection_borrow_message (DBusConnection *connection)
1844 DBusMessage *message;
1845 DBusDispatchStatus status;
1847 _dbus_return_val_if_fail (connection != NULL, NULL);
1849 /* this is called for the side effect that it queues
1850 * up any messages from the transport
1852 status = dbus_connection_get_dispatch_status (connection);
1853 if (status != DBUS_DISPATCH_DATA_REMAINS)
1856 CONNECTION_LOCK (connection);
1858 if (connection->message_borrowed != NULL)
1859 _dbus_connection_wait_for_borrowed (connection);
1861 message = _dbus_list_get_first (&connection->incoming_messages);
1864 connection->message_borrowed = message;
1866 CONNECTION_UNLOCK (connection);
1871 * Used to return a message after peeking at it using
1872 * dbus_connection_borrow_message().
1874 * @param connection the connection
1875 * @param message the message from dbus_connection_borrow_message()
1878 dbus_connection_return_message (DBusConnection *connection,
1879 DBusMessage *message)
1881 _dbus_return_if_fail (connection != NULL);
1882 _dbus_return_if_fail (message != NULL);
1884 CONNECTION_LOCK (connection);
1886 _dbus_assert (message == connection->message_borrowed);
1888 connection->message_borrowed = NULL;
1889 dbus_condvar_wake_all (connection->message_returned_cond);
1891 CONNECTION_UNLOCK (connection);
1895 * Used to keep a message after peeking at it using
1896 * dbus_connection_borrow_message(). Before using this function, see
1897 * the caveats/warnings in the documentation for
1898 * dbus_connection_pop_message().
1900 * @param connection the connection
1901 * @param message the message from dbus_connection_borrow_message()
1904 dbus_connection_steal_borrowed_message (DBusConnection *connection,
1905 DBusMessage *message)
1907 DBusMessage *pop_message;
1909 _dbus_return_if_fail (connection != NULL);
1910 _dbus_return_if_fail (message != NULL);
1912 CONNECTION_LOCK (connection);
1914 _dbus_assert (message == connection->message_borrowed);
1916 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
1917 _dbus_assert (message == pop_message);
1919 connection->n_incoming -= 1;
1921 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
1922 message, connection->n_incoming);
1924 connection->message_borrowed = NULL;
1925 dbus_condvar_wake_all (connection->message_returned_cond);
1927 CONNECTION_UNLOCK (connection);
1930 /* See dbus_connection_pop_message, but requires the caller to own
1931 * the lock before calling. May drop the lock while running.
1934 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
1936 if (connection->message_borrowed != NULL)
1937 _dbus_connection_wait_for_borrowed (connection);
1939 if (connection->n_incoming > 0)
1943 link = _dbus_list_pop_first_link (&connection->incoming_messages);
1944 connection->n_incoming -= 1;
1946 _dbus_verbose ("Message %p (%s) removed from incoming queue %p, %d incoming\n",
1947 link->data, dbus_message_get_name (link->data),
1948 connection, connection->n_incoming);
1956 /* See dbus_connection_pop_message, but requires the caller to own
1957 * the lock before calling. May drop the lock while running.
1960 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
1964 link = _dbus_connection_pop_message_link_unlocked (connection);
1968 DBusMessage *message;
1970 message = link->data;
1972 _dbus_list_free_link (link);
1982 * Returns the first-received message from the incoming message queue,
1983 * removing it from the queue. The caller owns a reference to the
1984 * returned message. If the queue is empty, returns #NULL.
1986 * This function bypasses any message handlers that are registered,
1987 * and so using it is usually wrong. Instead, let the main loop invoke
1988 * dbus_connection_dispatch(). Popping messages manually is only
1989 * useful in very simple programs that don't share a #DBusConnection
1990 * with any libraries or other modules.
1992 * @param connection the connection.
1993 * @returns next message in the incoming queue.
1996 dbus_connection_pop_message (DBusConnection *connection)
1998 DBusMessage *message;
1999 DBusDispatchStatus status;
2001 /* this is called for the side effect that it queues
2002 * up any messages from the transport
2004 status = dbus_connection_get_dispatch_status (connection);
2005 if (status != DBUS_DISPATCH_DATA_REMAINS)
2008 CONNECTION_LOCK (connection);
2010 message = _dbus_connection_pop_message_unlocked (connection);
2012 _dbus_verbose ("Returning popped message %p\n", message);
2014 CONNECTION_UNLOCK (connection);
2020 * Acquire the dispatcher. This must be done before dispatching
2021 * messages in order to guarantee the right order of
2022 * message delivery. May sleep and drop the connection mutex
2023 * while waiting for the dispatcher.
2025 * @param connection the connection.
2028 _dbus_connection_acquire_dispatch (DBusConnection *connection)
2030 if (connection->dispatch_acquired)
2031 dbus_condvar_wait (connection->dispatch_cond, connection->mutex);
2032 _dbus_assert (!connection->dispatch_acquired);
2034 connection->dispatch_acquired = TRUE;
2038 * Release the dispatcher when you're done with it. Only call
2039 * after you've acquired the dispatcher. Wakes up at most one
2040 * thread currently waiting to acquire the dispatcher.
2042 * @param connection the connection.
2045 _dbus_connection_release_dispatch (DBusConnection *connection)
2047 _dbus_assert (connection->dispatch_acquired);
2049 connection->dispatch_acquired = FALSE;
2050 dbus_condvar_wake_one (connection->dispatch_cond);
2054 _dbus_connection_failed_pop (DBusConnection *connection,
2055 DBusList *message_link)
2057 _dbus_list_prepend_link (&connection->incoming_messages,
2059 connection->n_incoming += 1;
2062 static DBusDispatchStatus
2063 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
2065 if (connection->n_incoming > 0)
2066 return DBUS_DISPATCH_DATA_REMAINS;
2067 else if (!_dbus_transport_queue_messages (connection->transport))
2068 return DBUS_DISPATCH_NEED_MEMORY;
2071 DBusDispatchStatus status;
2073 status = _dbus_transport_get_dispatch_status (connection->transport);
2075 if (status != DBUS_DISPATCH_COMPLETE)
2077 else if (connection->n_incoming > 0)
2078 return DBUS_DISPATCH_DATA_REMAINS;
2080 return DBUS_DISPATCH_COMPLETE;
2085 _dbus_connection_update_dispatch_status_locked (DBusConnection *connection,
2086 DBusDispatchStatus new_status)
2088 dbus_bool_t changed;
2089 DBusDispatchStatusFunction function;
2092 CONNECTION_LOCK (connection);
2093 _dbus_connection_ref_unlocked (connection);
2095 changed = new_status != connection->last_dispatch_status;
2097 connection->last_dispatch_status = new_status;
2099 function = connection->dispatch_status_function;
2100 data = connection->dispatch_status_data;
2102 CONNECTION_UNLOCK (connection);
2104 if (changed && function)
2106 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
2107 connection, new_status,
2108 new_status == DBUS_DISPATCH_COMPLETE ? "complete" :
2109 new_status == DBUS_DISPATCH_DATA_REMAINS ? "data remains" :
2110 new_status == DBUS_DISPATCH_NEED_MEMORY ? "need memory" :
2112 (* function) (connection, new_status, data);
2115 dbus_connection_unref (connection);
2119 * Gets the current state (what we would currently return
2120 * from dbus_connection_dispatch()) but doesn't actually
2121 * dispatch any messages.
2123 * @param connection the connection.
2124 * @returns current dispatch status
2127 dbus_connection_get_dispatch_status (DBusConnection *connection)
2129 DBusDispatchStatus status;
2131 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
2133 CONNECTION_LOCK (connection);
2135 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2137 CONNECTION_UNLOCK (connection);
2143 * Processes data buffered while handling watches, queueing zero or
2144 * more incoming messages. Then pops the first-received message from
2145 * the current incoming message queue, runs any handlers for it, and
2146 * unrefs the message. Returns a status indicating whether messages/data
2147 * remain, more memory is needed, or all data has been processed.
2149 * Even if the dispatch status is #DBUS_DISPATCH_DATA_REMAINS,
2150 * does not necessarily dispatch a message, as the data may
2151 * be part of authentication or the like.
2153 * @param connection the connection
2154 * @returns dispatch status
2157 dbus_connection_dispatch (DBusConnection *connection)
2159 DBusMessageHandler *handler;
2160 DBusMessage *message;
2161 DBusList *link, *filter_list_copy, *message_link;
2162 DBusHandlerResult result;
2163 ReplyHandlerData *reply_handler_data;
2165 dbus_int32_t reply_serial;
2166 DBusDispatchStatus status;
2168 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
2170 status = dbus_connection_get_dispatch_status (connection);
2171 if (status != DBUS_DISPATCH_DATA_REMAINS)
2173 _dbus_connection_update_dispatch_status_locked (connection, status);
2177 CONNECTION_LOCK (connection);
2179 /* We need to ref the connection since the callback could potentially
2180 * drop the last ref to it
2182 _dbus_connection_ref_unlocked (connection);
2184 _dbus_connection_acquire_dispatch (connection);
2186 /* This call may drop the lock during the execution (if waiting for
2187 * borrowed messages to be returned) but the order of message
2188 * dispatch if several threads call dispatch() is still
2189 * protected by the lock, since only one will get the lock, and that
2190 * one will finish the message dispatching
2192 message_link = _dbus_connection_pop_message_link_unlocked (connection);
2193 if (message_link == NULL)
2195 /* another thread dispatched our stuff */
2197 _dbus_connection_release_dispatch (connection);
2198 CONNECTION_UNLOCK (connection);
2200 status = dbus_connection_get_dispatch_status (connection);
2202 _dbus_connection_update_dispatch_status_locked (connection, status);
2204 dbus_connection_unref (connection);
2209 message = message_link->data;
2211 result = DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
2213 reply_serial = dbus_message_get_reply_serial (message);
2214 reply_handler_data = _dbus_hash_table_lookup_int (connection->pending_replies,
2217 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
2219 _dbus_connection_release_dispatch (connection);
2220 CONNECTION_UNLOCK (connection);
2221 _dbus_connection_failed_pop (connection, message_link);
2223 _dbus_connection_update_dispatch_status_locked (connection, DBUS_DISPATCH_NEED_MEMORY);
2225 dbus_connection_unref (connection);
2227 return DBUS_DISPATCH_NEED_MEMORY;
2230 _dbus_list_foreach (&filter_list_copy,
2231 (DBusForeachFunction)dbus_message_handler_ref,
2234 /* We're still protected from dispatch() reentrancy here
2235 * since we acquired the dispatcher
2237 CONNECTION_UNLOCK (connection);
2239 link = _dbus_list_get_first_link (&filter_list_copy);
2240 while (link != NULL)
2242 DBusMessageHandler *handler = link->data;
2243 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
2245 _dbus_verbose (" running filter on message %p\n", message);
2246 result = _dbus_message_handler_handle_message (handler, connection,
2249 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2255 _dbus_list_foreach (&filter_list_copy,
2256 (DBusForeachFunction)dbus_message_handler_unref,
2258 _dbus_list_clear (&filter_list_copy);
2260 CONNECTION_LOCK (connection);
2262 /* Did a reply we were waiting on get filtered? */
2263 if (reply_handler_data && result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2265 /* Queue the timeout immediately! */
2266 if (reply_handler_data->timeout_link)
2268 _dbus_connection_queue_synthesized_message_link (connection,
2269 reply_handler_data->timeout_link);
2270 reply_handler_data->timeout_link = NULL;
2274 /* We already queued the timeout? Then it was filtered! */
2275 _dbus_warn ("The timeout error with reply serial %d was filtered, so the reply handler will never be called.\n", reply_serial);
2279 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2282 if (reply_handler_data)
2284 CONNECTION_UNLOCK (connection);
2286 _dbus_verbose (" running reply handler on message %p\n", message);
2288 result = _dbus_message_handler_handle_message (reply_handler_data->handler,
2289 connection, message);
2290 reply_handler_data_free (reply_handler_data);
2291 CONNECTION_LOCK (connection);
2295 name = dbus_message_get_name (message);
2298 handler = _dbus_hash_table_lookup_string (connection->handler_table,
2300 if (handler != NULL)
2302 /* We're still protected from dispatch() reentrancy here
2303 * since we acquired the dispatcher
2305 CONNECTION_UNLOCK (connection);
2307 _dbus_verbose (" running app handler on message %p (%s)\n",
2308 message, dbus_message_get_name (message));
2310 result = _dbus_message_handler_handle_message (handler, connection,
2312 CONNECTION_LOCK (connection);
2313 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2318 _dbus_verbose (" done dispatching %p (%s) on connection %p\n", message,
2319 dbus_message_get_name (message), connection);
2322 _dbus_connection_release_dispatch (connection);
2323 CONNECTION_UNLOCK (connection);
2324 _dbus_list_free_link (message_link);
2325 dbus_message_unref (message); /* don't want the message to count in max message limits
2326 * in computing dispatch status
2329 status = dbus_connection_get_dispatch_status (connection);
2331 _dbus_connection_update_dispatch_status_locked (connection, status);
2333 dbus_connection_unref (connection);
2339 * Sets the watch functions for the connection. These functions are
2340 * responsible for making the application's main loop aware of file
2341 * descriptors that need to be monitored for events, using select() or
2342 * poll(). When using Qt, typically the DBusAddWatchFunction would
2343 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
2344 * could call g_io_add_watch(), or could be used as part of a more
2345 * elaborate GSource. Note that when a watch is added, it may
2348 * The DBusWatchToggledFunction notifies the application that the
2349 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
2350 * to check this. A disabled watch should have no effect, and enabled
2351 * watch should be added to the main loop. This feature is used
2352 * instead of simply adding/removing the watch because
2353 * enabling/disabling can be done without memory allocation. The
2354 * toggled function may be NULL if a main loop re-queries
2355 * dbus_watch_get_enabled() every time anyway.
2357 * The DBusWatch can be queried for the file descriptor to watch using
2358 * dbus_watch_get_fd(), and for the events to watch for using
2359 * dbus_watch_get_flags(). The flags returned by
2360 * dbus_watch_get_flags() will only contain DBUS_WATCH_READABLE and
2361 * DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR;
2362 * all watches implicitly include a watch for hangups, errors, and
2363 * other exceptional conditions.
2365 * Once a file descriptor becomes readable or writable, or an exception
2366 * occurs, dbus_watch_handle() should be called to
2367 * notify the connection of the file descriptor's condition.
2369 * dbus_watch_handle() cannot be called during the
2370 * DBusAddWatchFunction, as the connection will not be ready to handle
2373 * It is not allowed to reference a DBusWatch after it has been passed
2374 * to remove_function.
2376 * If #FALSE is returned due to lack of memory, the failure may be due
2377 * to a #FALSE return from the new add_function. If so, the
2378 * add_function may have been called successfully one or more times,
2379 * but the remove_function will also have been called to remove any
2380 * successful adds. i.e. if #FALSE is returned the net result
2381 * should be that dbus_connection_set_watch_functions() has no effect,
2382 * but the add_function and remove_function may have been called.
2384 * @todo We need to drop the lock when we call the
2385 * add/remove/toggled functions which can be a side effect
2386 * of setting the watch functions.
2388 * @param connection the connection.
2389 * @param add_function function to begin monitoring a new descriptor.
2390 * @param remove_function function to stop monitoring a descriptor.
2391 * @param toggled_function function to notify of enable/disable
2392 * @param data data to pass to add_function and remove_function.
2393 * @param free_data_function function to be called to free the data.
2394 * @returns #FALSE on failure (no memory)
2397 dbus_connection_set_watch_functions (DBusConnection *connection,
2398 DBusAddWatchFunction add_function,
2399 DBusRemoveWatchFunction remove_function,
2400 DBusWatchToggledFunction toggled_function,
2402 DBusFreeFunction free_data_function)
2406 _dbus_return_val_if_fail (connection != NULL, FALSE);
2408 CONNECTION_LOCK (connection);
2409 /* ref connection for slightly better reentrancy */
2410 _dbus_connection_ref_unlocked (connection);
2412 /* FIXME this can call back into user code, and we need to drop the
2413 * connection lock when it does.
2415 retval = _dbus_watch_list_set_functions (connection->watches,
2416 add_function, remove_function,
2418 data, free_data_function);
2420 CONNECTION_UNLOCK (connection);
2421 /* drop our paranoid refcount */
2422 dbus_connection_unref (connection);
2428 * Sets the timeout functions for the connection. These functions are
2429 * responsible for making the application's main loop aware of timeouts.
2430 * When using Qt, typically the DBusAddTimeoutFunction would create a
2431 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
2434 * The DBusTimeoutToggledFunction notifies the application that the
2435 * timeout has been enabled or disabled. Call
2436 * dbus_timeout_get_enabled() to check this. A disabled timeout should
2437 * have no effect, and enabled timeout should be added to the main
2438 * loop. This feature is used instead of simply adding/removing the
2439 * timeout because enabling/disabling can be done without memory
2440 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
2441 * to enable and disable. The toggled function may be NULL if a main
2442 * loop re-queries dbus_timeout_get_enabled() every time anyway.
2443 * Whenever a timeout is toggled, its interval may change.
2445 * The DBusTimeout can be queried for the timer interval using
2446 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
2447 * repeatedly, each time the interval elapses, starting after it has
2448 * elapsed once. The timeout stops firing when it is removed with the
2449 * given remove_function. The timer interval may change whenever the
2450 * timeout is added, removed, or toggled.
2452 * @param connection the connection.
2453 * @param add_function function to add a timeout.
2454 * @param remove_function function to remove a timeout.
2455 * @param toggled_function function to notify of enable/disable
2456 * @param data data to pass to add_function and remove_function.
2457 * @param free_data_function function to be called to free the data.
2458 * @returns #FALSE on failure (no memory)
2461 dbus_connection_set_timeout_functions (DBusConnection *connection,
2462 DBusAddTimeoutFunction add_function,
2463 DBusRemoveTimeoutFunction remove_function,
2464 DBusTimeoutToggledFunction toggled_function,
2466 DBusFreeFunction free_data_function)
2470 _dbus_return_val_if_fail (connection != NULL, FALSE);
2472 CONNECTION_LOCK (connection);
2473 /* ref connection for slightly better reentrancy */
2474 _dbus_connection_ref_unlocked (connection);
2476 retval = _dbus_timeout_list_set_functions (connection->timeouts,
2477 add_function, remove_function,
2479 data, free_data_function);
2481 CONNECTION_UNLOCK (connection);
2482 /* drop our paranoid refcount */
2483 dbus_connection_unref (connection);
2489 * Sets the mainloop wakeup function for the connection. Thi function is
2490 * responsible for waking up the main loop (if its sleeping) when some some
2491 * change has happened to the connection that the mainloop needs to reconsiders
2492 * (e.g. a message has been queued for writing).
2493 * When using Qt, this typically results in a call to QEventLoop::wakeUp().
2494 * When using GLib, it would call g_main_context_wakeup().
2497 * @param connection the connection.
2498 * @param wakeup_main_function function to wake up the mainloop
2499 * @param data data to pass wakeup_main_function
2500 * @param free_data_function function to be called to free the data.
2503 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
2504 DBusWakeupMainFunction wakeup_main_function,
2506 DBusFreeFunction free_data_function)
2509 DBusFreeFunction old_free_data;
2511 _dbus_return_if_fail (connection != NULL);
2513 CONNECTION_LOCK (connection);
2514 old_data = connection->wakeup_main_data;
2515 old_free_data = connection->free_wakeup_main_data;
2517 connection->wakeup_main_function = wakeup_main_function;
2518 connection->wakeup_main_data = data;
2519 connection->free_wakeup_main_data = free_data_function;
2521 CONNECTION_UNLOCK (connection);
2523 /* Callback outside the lock */
2525 (*old_free_data) (old_data);
2529 * Set a function to be invoked when the dispatch status changes.
2530 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
2531 * dbus_connection_dispatch() needs to be called to process incoming
2532 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
2533 * from inside the DBusDispatchStatusFunction. Indeed, almost
2534 * any reentrancy in this function is a bad idea. Instead,
2535 * the DBusDispatchStatusFunction should simply save an indication
2536 * that messages should be dispatched later, when the main loop
2539 * @param connection the connection
2540 * @param function function to call on dispatch status changes
2541 * @param data data for function
2542 * @param free_data_function free the function data
2545 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
2546 DBusDispatchStatusFunction function,
2548 DBusFreeFunction free_data_function)
2551 DBusFreeFunction old_free_data;
2553 _dbus_return_if_fail (connection != NULL);
2555 CONNECTION_LOCK (connection);
2556 old_data = connection->dispatch_status_data;
2557 old_free_data = connection->free_dispatch_status_data;
2559 connection->dispatch_status_function = function;
2560 connection->dispatch_status_data = data;
2561 connection->free_dispatch_status_data = free_data_function;
2563 CONNECTION_UNLOCK (connection);
2565 /* Callback outside the lock */
2567 (*old_free_data) (old_data);
2571 * Gets the UNIX user ID of the connection if any.
2572 * Returns #TRUE if the uid is filled in.
2573 * Always returns #FALSE on non-UNIX platforms.
2574 * Always returns #FALSE prior to authenticating the
2577 * @param connection the connection
2578 * @param uid return location for the user ID
2579 * @returns #TRUE if uid is filled in with a valid user ID
2582 dbus_connection_get_unix_user (DBusConnection *connection,
2587 _dbus_return_val_if_fail (connection != NULL, FALSE);
2588 _dbus_return_val_if_fail (uid != NULL, FALSE);
2590 CONNECTION_LOCK (connection);
2592 if (!_dbus_transport_get_is_authenticated (connection->transport))
2595 result = _dbus_transport_get_unix_user (connection->transport,
2597 CONNECTION_UNLOCK (connection);
2603 * Sets a predicate function used to determine whether a given user ID
2604 * is allowed to connect. When an incoming connection has
2605 * authenticated with a particular user ID, this function is called;
2606 * if it returns #TRUE, the connection is allowed to proceed,
2607 * otherwise the connection is disconnected.
2609 * If the function is set to #NULL (as it is by default), then
2610 * only the same UID as the server process will be allowed to
2613 * @param connection the connection
2614 * @param function the predicate
2615 * @param data data to pass to the predicate
2616 * @param free_data_function function to free the data
2619 dbus_connection_set_unix_user_function (DBusConnection *connection,
2620 DBusAllowUnixUserFunction function,
2622 DBusFreeFunction free_data_function)
2624 void *old_data = NULL;
2625 DBusFreeFunction old_free_function = NULL;
2627 _dbus_return_if_fail (connection != NULL);
2629 CONNECTION_LOCK (connection);
2630 _dbus_transport_set_unix_user_function (connection->transport,
2631 function, data, free_data_function,
2632 &old_data, &old_free_function);
2633 CONNECTION_UNLOCK (connection);
2635 if (old_free_function != NULL)
2636 (* old_free_function) (old_data);
2640 * Adds a message filter. Filters are handlers that are run on
2641 * all incoming messages, prior to the normal handlers
2642 * registered with dbus_connection_register_handler().
2643 * Filters are run in the order that they were added.
2644 * The same handler can be added as a filter more than once, in
2645 * which case it will be run more than once.
2646 * Filters added during a filter callback won't be run on the
2647 * message being processed.
2649 * The connection does NOT add a reference to the message handler;
2650 * instead, if the message handler is finalized, the connection simply
2651 * forgets about it. Thus the caller of this function must keep a
2652 * reference to the message handler.
2654 * @param connection the connection
2655 * @param handler the handler
2656 * @returns #TRUE on success, #FALSE if not enough memory.
2659 dbus_connection_add_filter (DBusConnection *connection,
2660 DBusMessageHandler *handler)
2662 _dbus_return_val_if_fail (connection != NULL, FALSE);
2663 _dbus_return_val_if_fail (handler != NULL, FALSE);
2665 CONNECTION_LOCK (connection);
2666 if (!_dbus_message_handler_add_connection (handler, connection))
2668 CONNECTION_UNLOCK (connection);
2672 if (!_dbus_list_append (&connection->filter_list,
2675 _dbus_message_handler_remove_connection (handler, connection);
2676 CONNECTION_UNLOCK (connection);
2680 CONNECTION_UNLOCK (connection);
2685 * Removes a previously-added message filter. It is a programming
2686 * error to call this function for a handler that has not
2687 * been added as a filter. If the given handler was added
2688 * more than once, only one instance of it will be removed
2689 * (the most recently-added instance).
2691 * @param connection the connection
2692 * @param handler the handler to remove
2696 dbus_connection_remove_filter (DBusConnection *connection,
2697 DBusMessageHandler *handler)
2699 _dbus_return_if_fail (connection != NULL);
2700 _dbus_return_if_fail (handler != NULL);
2702 CONNECTION_LOCK (connection);
2703 if (!_dbus_list_remove_last (&connection->filter_list, handler))
2705 _dbus_warn ("Tried to remove a DBusConnection filter that had not been added\n");
2706 CONNECTION_UNLOCK (connection);
2710 _dbus_message_handler_remove_connection (handler, connection);
2712 CONNECTION_UNLOCK (connection);
2716 * Registers a handler for a list of message names. A single handler
2717 * can be registered for any number of message names, but each message
2718 * name can only have one handler at a time. It's not allowed to call
2719 * this function with the name of a message that already has a
2720 * handler. If the function returns #FALSE, the handlers were not
2721 * registered due to lack of memory.
2723 * The connection does NOT add a reference to the message handler;
2724 * instead, if the message handler is finalized, the connection simply
2725 * forgets about it. Thus the caller of this function must keep a
2726 * reference to the message handler.
2728 * @todo the messages_to_handle arg may be more convenient if it's a
2729 * single string instead of an array. Though right now MessageHandler
2730 * is sort of designed to say be associated with an entire object with
2731 * multiple methods, that's why for example the connection only
2732 * weakrefs it. So maybe the "manual" API should be different.
2734 * @param connection the connection
2735 * @param handler the handler
2736 * @param messages_to_handle the messages to handle
2737 * @param n_messages the number of message names in messages_to_handle
2738 * @returns #TRUE on success, #FALSE if no memory or another handler already exists
2742 dbus_connection_register_handler (DBusConnection *connection,
2743 DBusMessageHandler *handler,
2744 const char **messages_to_handle,
2749 _dbus_return_val_if_fail (connection != NULL, FALSE);
2750 _dbus_return_val_if_fail (handler != NULL, FALSE);
2751 _dbus_return_val_if_fail (n_messages >= 0, FALSE);
2752 _dbus_return_val_if_fail (n_messages == 0 || messages_to_handle != NULL, FALSE);
2754 CONNECTION_LOCK (connection);
2756 while (i < n_messages)
2761 key = _dbus_strdup (messages_to_handle[i]);
2765 if (!_dbus_hash_iter_lookup (connection->handler_table,
2773 if (_dbus_hash_iter_get_value (&iter) != NULL)
2775 _dbus_warn ("Bug in application: attempted to register a second handler for %s\n",
2776 messages_to_handle[i]);
2777 dbus_free (key); /* won't have replaced the old key with the new one */
2781 if (!_dbus_message_handler_add_connection (handler, connection))
2783 _dbus_hash_iter_remove_entry (&iter);
2784 /* key has freed on nuking the entry */
2788 _dbus_hash_iter_set_value (&iter, handler);
2793 CONNECTION_UNLOCK (connection);
2797 /* unregister everything registered so far,
2798 * so we don't fail partially
2800 dbus_connection_unregister_handler (connection,
2805 CONNECTION_UNLOCK (connection);
2810 * Unregisters a handler for a list of message names. The handlers
2811 * must have been previously registered.
2813 * @param connection the connection
2814 * @param handler the handler
2815 * @param messages_to_handle the messages to handle
2816 * @param n_messages the number of message names in messages_to_handle
2820 dbus_connection_unregister_handler (DBusConnection *connection,
2821 DBusMessageHandler *handler,
2822 const char **messages_to_handle,
2827 _dbus_return_if_fail (connection != NULL);
2828 _dbus_return_if_fail (handler != NULL);
2829 _dbus_return_if_fail (n_messages >= 0);
2830 _dbus_return_if_fail (n_messages == 0 || messages_to_handle != NULL);
2832 CONNECTION_LOCK (connection);
2834 while (i < n_messages)
2838 if (!_dbus_hash_iter_lookup (connection->handler_table,
2839 (char*) messages_to_handle[i], FALSE,
2842 _dbus_warn ("Bug in application: attempted to unregister handler for %s which was not registered\n",
2843 messages_to_handle[i]);
2845 else if (_dbus_hash_iter_get_value (&iter) != handler)
2847 _dbus_warn ("Bug in application: attempted to unregister handler for %s which was registered by a different handler\n",
2848 messages_to_handle[i]);
2852 _dbus_hash_iter_remove_entry (&iter);
2853 _dbus_message_handler_remove_connection (handler, connection);
2859 CONNECTION_UNLOCK (connection);
2862 static DBusDataSlotAllocator slot_allocator;
2863 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
2866 * Allocates an integer ID to be used for storing application-specific
2867 * data on any DBusConnection. The allocated ID may then be used
2868 * with dbus_connection_set_data() and dbus_connection_get_data().
2869 * If allocation fails, -1 is returned. Again, the allocated
2870 * slot is global, i.e. all DBusConnection objects will
2871 * have a slot with the given integer ID reserved.
2873 * @returns -1 on failure, otherwise the data slot ID
2876 dbus_connection_allocate_data_slot (void)
2878 return _dbus_data_slot_allocator_alloc (&slot_allocator,
2879 _DBUS_LOCK_NAME (connection_slots));
2883 * Deallocates a global ID for connection data slots.
2884 * dbus_connection_get_data() and dbus_connection_set_data()
2885 * may no longer be used with this slot.
2886 * Existing data stored on existing DBusConnection objects
2887 * will be freed when the connection is finalized,
2888 * but may not be retrieved (and may only be replaced
2889 * if someone else reallocates the slot).
2891 * @param slot the slot to deallocate
2894 dbus_connection_free_data_slot (int slot)
2896 _dbus_data_slot_allocator_free (&slot_allocator, slot);
2900 * Stores a pointer on a DBusConnection, along
2901 * with an optional function to be used for freeing
2902 * the data when the data is set again, or when
2903 * the connection is finalized. The slot number
2904 * must have been allocated with dbus_connection_allocate_data_slot().
2906 * @param connection the connection
2907 * @param slot the slot number
2908 * @param data the data to store
2909 * @param free_data_func finalizer function for the data
2910 * @returns #TRUE if there was enough memory to store the data
2913 dbus_connection_set_data (DBusConnection *connection,
2916 DBusFreeFunction free_data_func)
2918 DBusFreeFunction old_free_func;
2922 _dbus_return_val_if_fail (connection != NULL, FALSE);
2923 _dbus_return_val_if_fail (slot >= 0, FALSE);
2925 CONNECTION_LOCK (connection);
2927 retval = _dbus_data_slot_list_set (&slot_allocator,
2928 &connection->slot_list,
2929 slot, data, free_data_func,
2930 &old_free_func, &old_data);
2932 CONNECTION_UNLOCK (connection);
2936 /* Do the actual free outside the connection lock */
2938 (* old_free_func) (old_data);
2945 * Retrieves data previously set with dbus_connection_set_data().
2946 * The slot must still be allocated (must not have been freed).
2948 * @param connection the connection
2949 * @param slot the slot to get data from
2950 * @returns the data, or #NULL if not found
2953 dbus_connection_get_data (DBusConnection *connection,
2958 _dbus_return_val_if_fail (connection != NULL, NULL);
2960 CONNECTION_LOCK (connection);
2962 res = _dbus_data_slot_list_get (&slot_allocator,
2963 &connection->slot_list,
2966 CONNECTION_UNLOCK (connection);
2972 * This function sets a global flag for whether dbus_connection_new()
2973 * will set SIGPIPE behavior to SIG_IGN.
2975 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
2978 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
2980 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
2984 * Specifies the maximum size message this connection is allowed to
2985 * receive. Larger messages will result in disconnecting the
2988 * @param connection a #DBusConnection
2989 * @param size maximum message size the connection can receive, in bytes
2992 dbus_connection_set_max_message_size (DBusConnection *connection,
2995 _dbus_return_if_fail (connection != NULL);
2997 CONNECTION_LOCK (connection);
2998 _dbus_transport_set_max_message_size (connection->transport,
3000 CONNECTION_UNLOCK (connection);
3004 * Gets the value set by dbus_connection_set_max_message_size().
3006 * @param connection the connection
3007 * @returns the max size of a single message
3010 dbus_connection_get_max_message_size (DBusConnection *connection)
3014 _dbus_return_val_if_fail (connection != NULL, 0);
3016 CONNECTION_LOCK (connection);
3017 res = _dbus_transport_get_max_message_size (connection->transport);
3018 CONNECTION_UNLOCK (connection);
3023 * Sets the maximum total number of bytes that can be used for all messages
3024 * received on this connection. Messages count toward the maximum until
3025 * they are finalized. When the maximum is reached, the connection will
3026 * not read more data until some messages are finalized.
3028 * The semantics of the maximum are: if outstanding messages are
3029 * already above the maximum, additional messages will not be read.
3030 * The semantics are not: if the next message would cause us to exceed
3031 * the maximum, we don't read it. The reason is that we don't know the
3032 * size of a message until after we read it.
3034 * Thus, the max live messages size can actually be exceeded
3035 * by up to the maximum size of a single message.
3037 * Also, if we read say 1024 bytes off the wire in a single read(),
3038 * and that contains a half-dozen small messages, we may exceed the
3039 * size max by that amount. But this should be inconsequential.
3041 * This does imply that we can't call read() with a buffer larger
3042 * than we're willing to exceed this limit by.
3044 * @param connection the connection
3045 * @param size the maximum size in bytes of all outstanding messages
3048 dbus_connection_set_max_received_size (DBusConnection *connection,
3051 _dbus_return_if_fail (connection != NULL);
3053 CONNECTION_LOCK (connection);
3054 _dbus_transport_set_max_received_size (connection->transport,
3056 CONNECTION_UNLOCK (connection);
3060 * Gets the value set by dbus_connection_set_max_received_size().
3062 * @param connection the connection
3063 * @returns the max size of all live messages
3066 dbus_connection_get_max_received_size (DBusConnection *connection)
3070 _dbus_return_val_if_fail (connection != NULL, 0);
3072 CONNECTION_LOCK (connection);
3073 res = _dbus_transport_get_max_received_size (connection->transport);
3074 CONNECTION_UNLOCK (connection);
3079 * Gets the approximate size in bytes of all messages in the outgoing
3080 * message queue. The size is approximate in that you shouldn't use
3081 * it to decide how many bytes to read off the network or anything
3082 * of that nature, as optimizations may choose to tell small white lies
3083 * to avoid performance overhead.
3085 * @param connection the connection
3086 * @returns the number of bytes that have been queued up but not sent
3089 dbus_connection_get_outgoing_size (DBusConnection *connection)
3093 _dbus_return_val_if_fail (connection != NULL, 0);
3095 CONNECTION_LOCK (connection);
3096 res = _dbus_counter_get_value (connection->outgoing_counter);
3097 CONNECTION_UNLOCK (connection);