1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-connection.c DBusConnection object
4 * Copyright (C) 2002-2006 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-shared.h"
26 #include "dbus-connection.h"
27 #include "dbus-list.h"
28 #include "dbus-timeout.h"
29 #include "dbus-transport.h"
30 #include "dbus-watch.h"
31 #include "dbus-connection-internal.h"
32 #include "dbus-pending-call-internal.h"
33 #include "dbus-list.h"
34 #include "dbus-hash.h"
35 #include "dbus-message-internal.h"
36 #include "dbus-message-private.h"
37 #include "dbus-threads.h"
38 #include "dbus-protocol.h"
39 #include "dbus-dataslot.h"
40 #include "dbus-string.h"
41 #include "dbus-signature.h"
42 #include "dbus-pending-call.h"
43 #include "dbus-object-tree.h"
44 #include "dbus-threads-internal.h"
46 #include "dbus-marshal-basic.h"
47 #include "dbus-transport-kdbus.h"
50 #ifdef DBUS_DISABLE_CHECKS
51 #define TOOK_LOCK_CHECK(connection)
52 #define RELEASING_LOCK_CHECK(connection)
53 #define HAVE_LOCK_CHECK(connection)
55 #define TOOK_LOCK_CHECK(connection) do { \
56 _dbus_assert (!(connection)->have_connection_lock); \
57 (connection)->have_connection_lock = TRUE; \
59 #define RELEASING_LOCK_CHECK(connection) do { \
60 _dbus_assert ((connection)->have_connection_lock); \
61 (connection)->have_connection_lock = FALSE; \
63 #define HAVE_LOCK_CHECK(connection) _dbus_assert ((connection)->have_connection_lock)
64 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
69 #define CONNECTION_LOCK(connection) do { \
70 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
71 _dbus_rmutex_lock ((connection)->mutex); \
72 TOOK_LOCK_CHECK (connection); \
75 #define CONNECTION_UNLOCK(connection) _dbus_connection_unlock (connection)
77 #define SLOTS_LOCK(connection) do { \
78 _dbus_rmutex_lock ((connection)->slot_mutex); \
81 #define SLOTS_UNLOCK(connection) do { \
82 _dbus_rmutex_unlock ((connection)->slot_mutex); \
85 #define DISPATCH_STATUS_NAME(s) \
86 ((s) == DBUS_DISPATCH_COMPLETE ? "complete" : \
87 (s) == DBUS_DISPATCH_DATA_REMAINS ? "data remains" : \
88 (s) == DBUS_DISPATCH_NEED_MEMORY ? "need memory" : \
92 * @defgroup DBusConnection DBusConnection
94 * @brief Connection to another application
96 * A DBusConnection represents a connection to another
97 * application. Messages can be sent and received via this connection.
98 * The other application may be a message bus; for convenience, the
99 * function dbus_bus_get() is provided to automatically open a
100 * connection to the well-known message buses.
102 * In brief a DBusConnection is a message queue associated with some
103 * message transport mechanism such as a socket. The connection
104 * maintains a queue of incoming messages and a queue of outgoing
107 * Several functions use the following terms:
109 * <li><b>read</b> means to fill the incoming message queue by reading from the socket</li>
110 * <li><b>write</b> means to drain the outgoing queue by writing to the socket</li>
111 * <li><b>dispatch</b> means to drain the incoming queue by invoking application-provided message handlers</li>
114 * The function dbus_connection_read_write_dispatch() for example does all
115 * three of these things, offering a simple alternative to a main loop.
117 * In an application with a main loop, the read/write/dispatch
118 * operations are usually separate.
120 * The connection provides #DBusWatch and #DBusTimeout objects to
121 * the main loop. These are used to know when reading, writing, or
122 * dispatching should be performed.
124 * Incoming messages are processed
125 * by calling dbus_connection_dispatch(). dbus_connection_dispatch()
126 * runs any handlers registered for the topmost message in the message
127 * queue, then discards the message, then returns.
129 * dbus_connection_get_dispatch_status() indicates whether
130 * messages are currently in the queue that need dispatching.
131 * dbus_connection_set_dispatch_status_function() allows
132 * you to set a function to be used to monitor the dispatch status.
134 * If you're using GLib or Qt add-on libraries for D-Bus, there are
135 * special convenience APIs in those libraries that hide
136 * all the details of dispatch and watch/timeout monitoring.
137 * For example, dbus_connection_setup_with_g_main().
139 * If you aren't using these add-on libraries, but want to process
140 * messages asynchronously, you must manually call
141 * dbus_connection_set_dispatch_status_function(),
142 * dbus_connection_set_watch_functions(),
143 * dbus_connection_set_timeout_functions() providing appropriate
144 * functions to integrate the connection with your application's main
145 * loop. This can be tricky to get right; main loops are not simple.
147 * If you don't need to be asynchronous, you can ignore #DBusWatch,
148 * #DBusTimeout, and dbus_connection_dispatch(). Instead,
149 * dbus_connection_read_write_dispatch() can be used.
151 * Or, in <em>very</em> simple applications,
152 * dbus_connection_pop_message() may be all you need, allowing you to
153 * avoid setting up any handler functions (see
154 * dbus_connection_add_filter(),
155 * dbus_connection_register_object_path() for more on handlers).
157 * When you use dbus_connection_send() or one of its variants to send
158 * a message, the message is added to the outgoing queue. It's
159 * actually written to the network later; either in
160 * dbus_watch_handle() invoked by your main loop, or in
161 * dbus_connection_flush() which blocks until it can write out the
162 * entire outgoing queue. The GLib/Qt add-on libraries again
163 * handle the details here for you by setting up watch functions.
165 * When a connection is disconnected, you are guaranteed to get a
166 * signal "Disconnected" from the interface
167 * #DBUS_INTERFACE_LOCAL, path
170 * You may not drop the last reference to a #DBusConnection
171 * until that connection has been disconnected.
173 * You may dispatch the unprocessed incoming message queue even if the
174 * connection is disconnected. However, "Disconnected" will always be
175 * the last message in the queue (obviously no messages are received
176 * after disconnection).
178 * After calling dbus_threads_init(), #DBusConnection has thread
179 * locks and drops them when invoking user callbacks, so in general is
180 * transparently threadsafe. However, #DBusMessage does NOT have
181 * thread locks; you must not send the same message to multiple
182 * #DBusConnection if those connections will be used from different threads,
185 * Also, if you dispatch or pop messages from multiple threads, it
186 * may work in the sense that it won't crash, but it's tough to imagine
187 * sane results; it will be completely unpredictable which messages
188 * go to which threads.
190 * It's recommended to dispatch from a single thread.
192 * The most useful function to call from multiple threads at once
193 * is dbus_connection_send_with_reply_and_block(). That is,
194 * multiple threads can make method calls at the same time.
196 * If you aren't using threads, you can use a main loop and
197 * dbus_pending_call_set_notify() to achieve a similar result.
201 * @defgroup DBusConnectionInternals DBusConnection implementation details
202 * @ingroup DBusInternals
203 * @brief Implementation details of DBusConnection
209 _dbus_connection_trace_ref (DBusConnection *connection,
214 #ifdef DBUS_ENABLE_VERBOSE_MODE
215 static int enabled = -1;
217 _dbus_trace_ref ("DBusConnection", connection, old_refcount, new_refcount,
218 why, "DBUS_CONNECTION_TRACE", &enabled);
223 * Internal struct representing a message filter function
225 typedef struct DBusMessageFilter DBusMessageFilter;
228 * Internal struct representing a message filter function
230 struct DBusMessageFilter
232 DBusAtomic refcount; /**< Reference count */
233 DBusHandleMessageFunction function; /**< Function to call to filter */
234 void *user_data; /**< User data for the function */
235 DBusFreeFunction free_user_data_function; /**< Function to free the user data */
240 * Internals of DBusPreallocatedSend
242 struct DBusPreallocatedSend
244 DBusConnection *connection; /**< Connection we'd send the message to */
245 DBusList *queue_link; /**< Preallocated link in the queue */
246 DBusList *counter_link; /**< Preallocated link in the resource counter */
249 #if HAVE_DECL_MSG_NOSIGNAL
250 static dbus_bool_t _dbus_modify_sigpipe = FALSE;
252 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
256 * Implementation details of DBusConnection. All fields are private.
258 struct DBusConnection
260 DBusAtomic refcount; /**< Reference count. */
262 DBusRMutex *mutex; /**< Lock on the entire DBusConnection */
264 DBusCMutex *dispatch_mutex; /**< Protects dispatch_acquired */
265 DBusCondVar *dispatch_cond; /**< Notify when dispatch_acquired is available */
266 DBusCMutex *io_path_mutex; /**< Protects io_path_acquired */
267 DBusCondVar *io_path_cond; /**< Notify when io_path_acquired is available */
269 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
270 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
271 DBusList *expired_messages; /**< Messages that will be released when we next unlock. */
273 DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
274 * dispatch_acquired will be set by the borrower
277 int n_outgoing; /**< Length of outgoing queue. */
278 int n_incoming; /**< Length of incoming queue. */
280 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
282 DBusTransport *transport; /**< Object that sends/receives messages over network. */
283 DBusWatchList *watches; /**< Stores active watches. */
284 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
286 DBusList *filter_list; /**< List of filters. */
288 DBusRMutex *slot_mutex; /**< Lock on slot_list so overall connection lock need not be taken */
289 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
291 DBusHashTable *pending_replies; /**< Hash of message serials to #DBusPendingCall. */
293 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
294 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
296 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
297 void *wakeup_main_data; /**< Application data for wakeup_main_function */
298 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
300 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
301 void *dispatch_status_data; /**< Application data for dispatch_status_function */
302 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
304 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
306 DBusObjectTree *objects; /**< Object path handlers registered with this connection */
308 char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
310 /* These two MUST be bools and not bitfields, because they are protected by a separate lock
311 * from connection->mutex and all bitfields in a word have to be read/written together.
312 * So you can't have a different lock for different bitfields in the same word.
314 dbus_bool_t dispatch_acquired; /**< Someone has dispatch path (can drain incoming queue) */
315 dbus_bool_t io_path_acquired; /**< Someone has transport io path (can use the transport to read/write messages) */
317 unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
319 unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
321 unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
323 unsigned int disconnected_message_arrived : 1; /**< We popped or are dispatching the disconnected message.
324 * if the disconnect_message_link is NULL then we queued it, but
325 * this flag is whether it got to the head of the queue.
327 unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
328 * such as closing the connection.
331 #ifndef DBUS_DISABLE_CHECKS
332 unsigned int have_connection_lock : 1; /**< Used to check locking */
335 #if defined(DBUS_ENABLE_CHECKS) || defined(DBUS_ENABLE_ASSERT)
336 int generation; /**< _dbus_current_generation that should correspond to this connection */
340 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
341 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
342 DBusDispatchStatus new_status);
343 static void _dbus_connection_last_unref (DBusConnection *connection);
344 static void _dbus_connection_acquire_dispatch (DBusConnection *connection);
345 static void _dbus_connection_release_dispatch (DBusConnection *connection);
346 static DBusDispatchStatus _dbus_connection_flush_unlocked (DBusConnection *connection);
347 static void _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection);
348 static dbus_bool_t _dbus_connection_get_is_connected_unlocked (DBusConnection *connection);
349 static dbus_bool_t _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
350 dbus_uint32_t client_serial);
352 static DBusMessageFilter *
353 _dbus_message_filter_ref (DBusMessageFilter *filter)
355 #ifdef DBUS_DISABLE_ASSERT
356 _dbus_atomic_inc (&filter->refcount);
358 dbus_int32_t old_value;
360 old_value = _dbus_atomic_inc (&filter->refcount);
361 _dbus_assert (old_value > 0);
368 _dbus_message_filter_unref (DBusMessageFilter *filter)
370 dbus_int32_t old_value;
372 old_value = _dbus_atomic_dec (&filter->refcount);
373 _dbus_assert (old_value > 0);
377 if (filter->free_user_data_function)
378 (* filter->free_user_data_function) (filter->user_data);
385 * Acquires the connection lock.
387 * @param connection the connection.
390 _dbus_connection_lock (DBusConnection *connection)
392 CONNECTION_LOCK (connection);
396 * Releases the connection lock.
398 * @param connection the connection.
401 _dbus_connection_unlock (DBusConnection *connection)
403 DBusList *expired_messages;
408 _dbus_verbose ("UNLOCK\n");
411 /* If we had messages that expired (fell off the incoming or outgoing
412 * queues) while we were locked, actually release them now */
413 expired_messages = connection->expired_messages;
414 connection->expired_messages = NULL;
416 RELEASING_LOCK_CHECK (connection);
417 _dbus_rmutex_unlock (connection->mutex);
419 for (iter = _dbus_list_pop_first_link (&expired_messages);
421 iter = _dbus_list_pop_first_link (&expired_messages))
423 DBusMessage *message = iter->data;
425 dbus_message_unref (message);
426 _dbus_list_free_link (iter);
431 * Wakes up the main loop if it is sleeping
432 * Needed if we're e.g. queueing outgoing messages
433 * on a thread while the mainloop sleeps.
435 * @param connection the connection.
438 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
440 if (connection->wakeup_main_function)
441 (*connection->wakeup_main_function) (connection->wakeup_main_data);
444 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
446 * Gets the locks so we can examine them
448 * @param connection the connection.
449 * @param mutex_loc return for the location of the main mutex pointer
450 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
451 * @param io_path_mutex_loc return location of the io_path mutex pointer
452 * @param dispatch_cond_loc return location of the dispatch conditional
454 * @param io_path_cond_loc return location of the io_path conditional
458 _dbus_connection_test_get_locks (DBusConnection *connection,
459 DBusMutex **mutex_loc,
460 DBusMutex **dispatch_mutex_loc,
461 DBusMutex **io_path_mutex_loc,
462 DBusCondVar **dispatch_cond_loc,
463 DBusCondVar **io_path_cond_loc)
465 *mutex_loc = (DBusMutex *) connection->mutex;
466 *dispatch_mutex_loc = (DBusMutex *) connection->dispatch_mutex;
467 *io_path_mutex_loc = (DBusMutex *) connection->io_path_mutex;
468 *dispatch_cond_loc = connection->dispatch_cond;
469 *io_path_cond_loc = connection->io_path_cond;
474 * Adds a message-containing list link to the incoming message queue,
475 * taking ownership of the link and the message's current refcount.
476 * Cannot fail due to lack of memory.
478 * @param connection the connection.
479 * @param link the message link to queue.
482 _dbus_connection_queue_received_message_link (DBusConnection *connection,
485 DBusPendingCall *pending;
486 dbus_uint32_t reply_serial;
487 DBusMessage *message;
489 _dbus_assert (_dbus_transport_peek_is_authenticated (connection->transport));
491 _dbus_list_append_link (&connection->incoming_messages,
493 message = link->data;
495 /* If this is a reply we're waiting on, remove timeout for it */
496 reply_serial = dbus_message_get_reply_serial (message);
497 if (reply_serial != 0)
499 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
503 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
504 _dbus_connection_remove_timeout_unlocked (connection,
505 _dbus_pending_call_get_timeout_unlocked (pending));
507 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
513 connection->n_incoming += 1;
515 _dbus_connection_wakeup_mainloop (connection);
517 _dbus_verbose ("Message %p (%s %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
519 dbus_message_type_to_string (dbus_message_get_type (message)),
520 dbus_message_get_path (message) ?
521 dbus_message_get_path (message) :
523 dbus_message_get_interface (message) ?
524 dbus_message_get_interface (message) :
526 dbus_message_get_member (message) ?
527 dbus_message_get_member (message) :
529 dbus_message_get_signature (message),
530 dbus_message_get_reply_serial (message),
532 connection->n_incoming);
534 _dbus_message_trace_ref (message, -1, -1,
535 "_dbus_conection_queue_received_message_link");
539 * Adds a link + message to the incoming message queue.
540 * Can't fail. Takes ownership of both link and message.
542 * @param connection the connection.
543 * @param link the list node and message to queue.
547 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
550 HAVE_LOCK_CHECK (connection);
552 _dbus_list_append_link (&connection->incoming_messages, link);
554 connection->n_incoming += 1;
556 _dbus_connection_wakeup_mainloop (connection);
558 _dbus_message_trace_ref (link->data, -1, -1,
559 "_dbus_connection_queue_synthesized_message_link");
561 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
562 link->data, connection, connection->n_incoming);
567 * Checks whether there are messages in the outgoing message queue.
568 * Called with connection lock held.
570 * @param connection the connection.
571 * @returns #TRUE if the outgoing queue is non-empty.
574 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
576 HAVE_LOCK_CHECK (connection);
577 return connection->outgoing_messages != NULL;
581 * Checks whether there are messages in the outgoing message queue.
582 * Use dbus_connection_flush() to block until all outgoing
583 * messages have been written to the underlying transport
584 * (such as a socket).
586 * @param connection the connection.
587 * @returns #TRUE if the outgoing queue is non-empty.
590 dbus_connection_has_messages_to_send (DBusConnection *connection)
594 _dbus_return_val_if_fail (connection != NULL, FALSE);
596 CONNECTION_LOCK (connection);
597 v = _dbus_connection_has_messages_to_send_unlocked (connection);
598 CONNECTION_UNLOCK (connection);
604 * Gets the next outgoing message. The message remains in the
605 * queue, and the caller does not own a reference to it.
607 * @param connection the connection.
608 * @returns the message to be sent.
611 _dbus_connection_get_message_to_send (DBusConnection *connection)
613 HAVE_LOCK_CHECK (connection);
615 return _dbus_list_get_last (&connection->outgoing_messages);
619 * Notifies the connection that a message has been sent, so the
620 * message can be removed from the outgoing queue.
621 * Called with the connection lock held.
623 * @param connection the connection.
624 * @param message the message that was sent.
627 _dbus_connection_message_sent_unlocked (DBusConnection *connection,
628 DBusMessage *message)
632 HAVE_LOCK_CHECK (connection);
634 /* This can be called before we even complete authentication, since
635 * it's called on disconnect to clean up the outgoing queue.
636 * It's also called as we successfully send each message.
639 link = _dbus_list_get_last_link (&connection->outgoing_messages);
640 _dbus_assert (link != NULL);
641 _dbus_assert (link->data == message);
643 _dbus_list_unlink (&connection->outgoing_messages,
645 _dbus_list_prepend_link (&connection->expired_messages, link);
647 connection->n_outgoing -= 1;
649 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
651 dbus_message_type_to_string (dbus_message_get_type (message)),
652 dbus_message_get_path (message) ?
653 dbus_message_get_path (message) :
655 dbus_message_get_interface (message) ?
656 dbus_message_get_interface (message) :
658 dbus_message_get_member (message) ?
659 dbus_message_get_member (message) :
661 dbus_message_get_signature (message),
662 connection, connection->n_outgoing);
664 /* It's OK that in principle we call the notify function, because for the
665 * outgoing limit, there isn't one */
666 _dbus_message_remove_counter (message, connection->outgoing_counter);
668 /* The message will actually be unreffed when we unlock */
671 /** Function to be called in protected_change_watch() with refcount held */
672 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
674 /** Function to be called in protected_change_watch() with refcount held */
675 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
677 /** Function to be called in protected_change_watch() with refcount held */
678 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
680 dbus_bool_t enabled);
683 protected_change_watch (DBusConnection *connection,
685 DBusWatchAddFunction add_function,
686 DBusWatchRemoveFunction remove_function,
687 DBusWatchToggleFunction toggle_function,
692 HAVE_LOCK_CHECK (connection);
694 /* The original purpose of protected_change_watch() was to hold a
695 * ref on the connection while dropping the connection lock, then
696 * calling out to the app. This was a broken hack that did not
697 * work, since the connection was in a hosed state (no WatchList
698 * field) while calling out.
700 * So for now we'll just keep the lock while calling out. This means
701 * apps are not allowed to call DBusConnection methods inside a
702 * watch function or they will deadlock.
704 * The "real fix" is to use the _and_unlock() pattern found
705 * elsewhere in the code, to defer calling out to the app until
706 * we're about to drop locks and return flow of control to the app
709 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
712 if (connection->watches)
715 retval = (* add_function) (connection->watches, watch);
716 else if (remove_function)
719 (* remove_function) (connection->watches, watch);
724 (* toggle_function) (connection->watches, watch, enabled);
734 * Adds a watch using the connection's DBusAddWatchFunction if
735 * available. Otherwise records the watch to be added when said
736 * function is available. Also re-adds the watch if the
737 * DBusAddWatchFunction changes. May fail due to lack of memory.
738 * Connection lock should be held when calling this.
740 * @param connection the connection.
741 * @param watch the watch to add.
742 * @returns #TRUE on success.
745 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
748 return protected_change_watch (connection, watch,
749 _dbus_watch_list_add_watch,
754 * Removes a watch using the connection's DBusRemoveWatchFunction
755 * if available. It's an error to call this function on a watch
756 * that was not previously added.
757 * Connection lock should be held when calling this.
759 * @param connection the connection.
760 * @param watch the watch to remove.
763 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
766 protected_change_watch (connection, watch,
768 _dbus_watch_list_remove_watch,
773 * Toggles a watch and notifies app via connection's
774 * DBusWatchToggledFunction if available. It's an error to call this
775 * function on a watch that was not previously added.
776 * Connection lock should be held when calling this.
778 * @param connection the connection.
779 * @param watch the watch to toggle.
780 * @param enabled whether to enable or disable
783 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
787 _dbus_assert (watch != NULL);
789 protected_change_watch (connection, watch,
791 _dbus_watch_list_toggle_watch,
795 /** Function to be called in protected_change_timeout() with refcount held */
796 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
797 DBusTimeout *timeout);
798 /** Function to be called in protected_change_timeout() with refcount held */
799 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
800 DBusTimeout *timeout);
801 /** Function to be called in protected_change_timeout() with refcount held */
802 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
803 DBusTimeout *timeout,
804 dbus_bool_t enabled);
807 protected_change_timeout (DBusConnection *connection,
808 DBusTimeout *timeout,
809 DBusTimeoutAddFunction add_function,
810 DBusTimeoutRemoveFunction remove_function,
811 DBusTimeoutToggleFunction toggle_function,
816 HAVE_LOCK_CHECK (connection);
818 /* The original purpose of protected_change_timeout() was to hold a
819 * ref on the connection while dropping the connection lock, then
820 * calling out to the app. This was a broken hack that did not
821 * work, since the connection was in a hosed state (no TimeoutList
822 * field) while calling out.
824 * So for now we'll just keep the lock while calling out. This means
825 * apps are not allowed to call DBusConnection methods inside a
826 * timeout function or they will deadlock.
828 * The "real fix" is to use the _and_unlock() pattern found
829 * elsewhere in the code, to defer calling out to the app until
830 * we're about to drop locks and return flow of control to the app
833 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
836 if (connection->timeouts)
839 retval = (* add_function) (connection->timeouts, timeout);
840 else if (remove_function)
843 (* remove_function) (connection->timeouts, timeout);
848 (* toggle_function) (connection->timeouts, timeout, enabled);
857 * Adds a timeout using the connection's DBusAddTimeoutFunction if
858 * available. Otherwise records the timeout to be added when said
859 * function is available. Also re-adds the timeout if the
860 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
861 * The timeout will fire repeatedly until removed.
862 * Connection lock should be held when calling this.
864 * @param connection the connection.
865 * @param timeout the timeout to add.
866 * @returns #TRUE on success.
869 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
870 DBusTimeout *timeout)
872 return protected_change_timeout (connection, timeout,
873 _dbus_timeout_list_add_timeout,
878 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
879 * if available. It's an error to call this function on a timeout
880 * that was not previously added.
881 * Connection lock should be held when calling this.
883 * @param connection the connection.
884 * @param timeout the timeout to remove.
887 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
888 DBusTimeout *timeout)
890 protected_change_timeout (connection, timeout,
892 _dbus_timeout_list_remove_timeout,
897 * Toggles a timeout and notifies app via connection's
898 * DBusTimeoutToggledFunction if available. It's an error to call this
899 * function on a timeout that was not previously added.
900 * Connection lock should be held when calling this.
902 * @param connection the connection.
903 * @param timeout the timeout to toggle.
904 * @param enabled whether to enable or disable
907 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
908 DBusTimeout *timeout,
911 protected_change_timeout (connection, timeout,
913 _dbus_timeout_list_toggle_timeout,
918 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
919 DBusPendingCall *pending)
921 dbus_uint32_t reply_serial;
922 DBusTimeout *timeout;
924 HAVE_LOCK_CHECK (connection);
926 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
928 _dbus_assert (reply_serial != 0);
930 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
934 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
937 if (!_dbus_hash_table_insert_int (connection->pending_replies,
941 _dbus_connection_remove_timeout_unlocked (connection, timeout);
943 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
944 HAVE_LOCK_CHECK (connection);
948 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
952 if (!_dbus_hash_table_insert_int (connection->pending_replies,
956 HAVE_LOCK_CHECK (connection);
961 _dbus_pending_call_ref_unlocked (pending);
963 HAVE_LOCK_CHECK (connection);
969 free_pending_call_on_hash_removal (void *data)
971 DBusPendingCall *pending;
972 DBusConnection *connection;
979 connection = _dbus_pending_call_get_connection_unlocked (pending);
981 HAVE_LOCK_CHECK (connection);
983 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
985 _dbus_connection_remove_timeout_unlocked (connection,
986 _dbus_pending_call_get_timeout_unlocked (pending));
988 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
991 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
992 * here, but the pending call finalizer could in principle call out to
993 * application code so we pretty much have to... some larger code reorg
996 _dbus_connection_ref_unlocked (connection);
997 _dbus_pending_call_unref_and_unlock (pending);
998 CONNECTION_LOCK (connection);
999 _dbus_connection_unref_unlocked (connection);
1003 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
1004 DBusPendingCall *pending)
1006 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
1009 _dbus_hash_table_remove_int (connection->pending_replies,
1010 _dbus_pending_call_get_reply_serial_unlocked (pending));
1014 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
1015 DBusPendingCall *pending)
1017 /* The idea here is to avoid finalizing the pending call
1018 * with the lock held, since there's a destroy notifier
1019 * in pending call that goes out to application code.
1021 * There's an extra unlock inside the hash table
1022 * "free pending call" function FIXME...
1024 _dbus_pending_call_ref_unlocked (pending);
1025 _dbus_hash_table_remove_int (connection->pending_replies,
1026 _dbus_pending_call_get_reply_serial_unlocked (pending));
1028 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
1029 _dbus_connection_remove_timeout_unlocked (connection,
1030 _dbus_pending_call_get_timeout_unlocked (pending));
1032 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
1034 _dbus_pending_call_unref_and_unlock (pending);
1038 * Removes a pending call from the connection, such that
1039 * the pending reply will be ignored. May drop the last
1040 * reference to the pending call.
1042 * @param connection the connection
1043 * @param pending the pending call
1046 _dbus_connection_remove_pending_call (DBusConnection *connection,
1047 DBusPendingCall *pending)
1049 CONNECTION_LOCK (connection);
1050 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
1054 * Acquire the transporter I/O path. This must be done before
1055 * doing any I/O in the transporter. May sleep and drop the
1056 * IO path mutex while waiting for the I/O path.
1058 * @param connection the connection.
1059 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1060 * @returns TRUE if the I/O path was acquired.
1063 _dbus_connection_acquire_io_path (DBusConnection *connection,
1064 int timeout_milliseconds)
1066 dbus_bool_t we_acquired;
1068 HAVE_LOCK_CHECK (connection);
1070 /* We don't want the connection to vanish */
1071 _dbus_connection_ref_unlocked (connection);
1073 /* We will only touch io_path_acquired which is protected by our mutex */
1074 CONNECTION_UNLOCK (connection);
1076 _dbus_verbose ("locking io_path_mutex\n");
1077 _dbus_cmutex_lock (connection->io_path_mutex);
1079 _dbus_verbose ("start connection->io_path_acquired = %d timeout = %d\n",
1080 connection->io_path_acquired, timeout_milliseconds);
1082 we_acquired = FALSE;
1084 if (connection->io_path_acquired)
1086 if (timeout_milliseconds != -1)
1088 _dbus_verbose ("waiting %d for IO path to be acquirable\n",
1089 timeout_milliseconds);
1091 if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1092 connection->io_path_mutex,
1093 timeout_milliseconds))
1095 /* We timed out before anyone signaled. */
1096 /* (writing the loop to handle the !timedout case by
1097 * waiting longer if needed is a pain since dbus
1098 * wraps pthread_cond_timedwait to take a relative
1099 * time instead of absolute, something kind of stupid
1100 * on our part. for now it doesn't matter, we will just
1101 * end up back here eventually.)
1107 while (connection->io_path_acquired)
1109 _dbus_verbose ("waiting for IO path to be acquirable\n");
1110 _dbus_condvar_wait (connection->io_path_cond,
1111 connection->io_path_mutex);
1116 if (!connection->io_path_acquired)
1119 connection->io_path_acquired = TRUE;
1122 _dbus_verbose ("end connection->io_path_acquired = %d we_acquired = %d\n",
1123 connection->io_path_acquired, we_acquired);
1125 _dbus_verbose ("unlocking io_path_mutex\n");
1126 _dbus_cmutex_unlock (connection->io_path_mutex);
1128 CONNECTION_LOCK (connection);
1130 HAVE_LOCK_CHECK (connection);
1132 _dbus_connection_unref_unlocked (connection);
1138 * Release the I/O path when you're done with it. Only call
1139 * after you've acquired the I/O. Wakes up at most one thread
1140 * currently waiting to acquire the I/O path.
1142 * @param connection the connection.
1145 _dbus_connection_release_io_path (DBusConnection *connection)
1147 HAVE_LOCK_CHECK (connection);
1149 _dbus_verbose ("locking io_path_mutex\n");
1150 _dbus_cmutex_lock (connection->io_path_mutex);
1152 _dbus_assert (connection->io_path_acquired);
1154 _dbus_verbose ("start connection->io_path_acquired = %d\n",
1155 connection->io_path_acquired);
1157 connection->io_path_acquired = FALSE;
1158 _dbus_condvar_wake_one (connection->io_path_cond);
1160 _dbus_verbose ("unlocking io_path_mutex\n");
1161 _dbus_cmutex_unlock (connection->io_path_mutex);
1165 * Queues incoming messages and sends outgoing messages for this
1166 * connection, optionally blocking in the process. Each call to
1167 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1168 * time and then read or write data if possible.
1170 * The purpose of this function is to be able to flush outgoing
1171 * messages or queue up incoming messages without returning
1172 * control to the application and causing reentrancy weirdness.
1174 * The flags parameter allows you to specify whether to
1175 * read incoming messages, write outgoing messages, or both,
1176 * and whether to block if no immediate action is possible.
1178 * The timeout_milliseconds parameter does nothing unless the
1179 * iteration is blocking.
1181 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1182 * wasn't specified, then it's impossible to block, even if
1183 * you specify DBUS_ITERATION_BLOCK; in that case the function
1184 * returns immediately.
1186 * If pending is not NULL then a check is made if the pending call
1187 * is completed after the io path has been required. If the call
1188 * has been completed nothing is done. This must be done since
1189 * the _dbus_connection_acquire_io_path releases the connection
1192 * Called with connection lock held.
1194 * @param connection the connection.
1195 * @param pending the pending call that should be checked or NULL
1196 * @param flags iteration flags.
1197 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1200 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1201 DBusPendingCall *pending,
1203 int timeout_milliseconds)
1205 _dbus_verbose ("start\n");
1207 HAVE_LOCK_CHECK (connection);
1209 if (connection->n_outgoing == 0)
1210 flags &= ~DBUS_ITERATION_DO_WRITING;
1212 if (_dbus_connection_acquire_io_path (connection,
1213 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1215 HAVE_LOCK_CHECK (connection);
1217 if ( (pending != NULL) && _dbus_pending_call_get_completed_unlocked(pending))
1219 _dbus_verbose ("pending call completed while acquiring I/O path");
1221 else if ( (pending != NULL) &&
1222 _dbus_connection_peek_for_reply_unlocked (connection,
1223 _dbus_pending_call_get_reply_serial_unlocked (pending)))
1225 _dbus_verbose ("pending call completed while acquiring I/O path (reply found in queue)");
1229 _dbus_transport_do_iteration (connection->transport,
1230 flags, timeout_milliseconds);
1233 _dbus_connection_release_io_path (connection);
1236 HAVE_LOCK_CHECK (connection);
1238 _dbus_verbose ("end\n");
1242 * Creates a new connection for the given transport. A transport
1243 * represents a message stream that uses some concrete mechanism, such
1244 * as UNIX domain sockets. May return #NULL if insufficient
1245 * memory exists to create the connection.
1247 * @param transport the transport.
1248 * @returns the new connection, or #NULL on failure.
1251 _dbus_connection_new_for_transport (DBusTransport *transport)
1253 DBusConnection *connection;
1254 DBusWatchList *watch_list;
1255 DBusTimeoutList *timeout_list;
1256 DBusHashTable *pending_replies;
1257 DBusList *disconnect_link;
1258 DBusMessage *disconnect_message;
1259 DBusCounter *outgoing_counter;
1260 DBusObjectTree *objects;
1264 pending_replies = NULL;
1265 timeout_list = NULL;
1266 disconnect_link = NULL;
1267 disconnect_message = NULL;
1268 outgoing_counter = NULL;
1271 watch_list = _dbus_watch_list_new ();
1272 if (watch_list == NULL)
1275 timeout_list = _dbus_timeout_list_new ();
1276 if (timeout_list == NULL)
1280 _dbus_hash_table_new (DBUS_HASH_INT,
1282 (DBusFreeFunction)free_pending_call_on_hash_removal);
1283 if (pending_replies == NULL)
1286 connection = dbus_new0 (DBusConnection, 1);
1287 if (connection == NULL)
1290 _dbus_rmutex_new_at_location (&connection->mutex);
1291 if (connection->mutex == NULL)
1294 _dbus_cmutex_new_at_location (&connection->io_path_mutex);
1295 if (connection->io_path_mutex == NULL)
1298 _dbus_cmutex_new_at_location (&connection->dispatch_mutex);
1299 if (connection->dispatch_mutex == NULL)
1302 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1303 if (connection->dispatch_cond == NULL)
1306 _dbus_condvar_new_at_location (&connection->io_path_cond);
1307 if (connection->io_path_cond == NULL)
1310 _dbus_rmutex_new_at_location (&connection->slot_mutex);
1311 if (connection->slot_mutex == NULL)
1314 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1315 DBUS_INTERFACE_LOCAL,
1318 if (disconnect_message == NULL)
1321 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1322 if (disconnect_link == NULL)
1325 outgoing_counter = _dbus_counter_new ();
1326 if (outgoing_counter == NULL)
1329 objects = _dbus_object_tree_new (connection);
1330 if (objects == NULL)
1333 if (_dbus_modify_sigpipe)
1334 _dbus_disable_sigpipe ();
1336 /* initialized to 0: use atomic op to avoid mixing atomic and non-atomic */
1337 _dbus_atomic_inc (&connection->refcount);
1338 connection->transport = transport;
1339 connection->watches = watch_list;
1340 connection->timeouts = timeout_list;
1341 connection->pending_replies = pending_replies;
1342 connection->outgoing_counter = outgoing_counter;
1343 connection->filter_list = NULL;
1344 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1345 connection->objects = objects;
1346 connection->exit_on_disconnect = FALSE;
1347 connection->shareable = FALSE;
1348 connection->route_peer_messages = FALSE;
1349 connection->disconnected_message_arrived = FALSE;
1350 connection->disconnected_message_processed = FALSE;
1352 #if defined(DBUS_ENABLE_CHECKS) || defined(DBUS_ENABLE_ASSERT)
1353 connection->generation = _dbus_current_generation;
1356 _dbus_data_slot_list_init (&connection->slot_list);
1358 connection->client_serial = 1;
1360 connection->disconnect_message_link = disconnect_link;
1362 CONNECTION_LOCK (connection);
1364 if (!_dbus_transport_set_connection (transport, connection))
1366 CONNECTION_UNLOCK (connection);
1371 _dbus_transport_ref (transport);
1373 CONNECTION_UNLOCK (connection);
1375 _dbus_connection_trace_ref (connection, 0, 1, "new_for_transport");
1379 if (disconnect_message != NULL)
1380 dbus_message_unref (disconnect_message);
1382 if (disconnect_link != NULL)
1383 _dbus_list_free_link (disconnect_link);
1385 if (connection != NULL)
1387 _dbus_condvar_free_at_location (&connection->io_path_cond);
1388 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1389 _dbus_rmutex_free_at_location (&connection->mutex);
1390 _dbus_cmutex_free_at_location (&connection->io_path_mutex);
1391 _dbus_cmutex_free_at_location (&connection->dispatch_mutex);
1392 _dbus_rmutex_free_at_location (&connection->slot_mutex);
1393 dbus_free (connection);
1395 if (pending_replies)
1396 _dbus_hash_table_unref (pending_replies);
1399 _dbus_watch_list_free (watch_list);
1402 _dbus_timeout_list_free (timeout_list);
1404 if (outgoing_counter)
1405 _dbus_counter_unref (outgoing_counter);
1408 _dbus_object_tree_unref (objects);
1414 * Increments the reference count of a DBusConnection.
1415 * Requires that the caller already holds the connection lock.
1417 * @param connection the connection.
1418 * @returns the connection.
1421 _dbus_connection_ref_unlocked (DBusConnection *connection)
1423 dbus_int32_t old_refcount;
1425 _dbus_assert (connection != NULL);
1426 _dbus_assert (connection->generation == _dbus_current_generation);
1428 HAVE_LOCK_CHECK (connection);
1430 old_refcount = _dbus_atomic_inc (&connection->refcount);
1431 _dbus_connection_trace_ref (connection, old_refcount, old_refcount + 1,
1438 * Decrements the reference count of a DBusConnection.
1439 * Requires that the caller already holds the connection lock.
1441 * @param connection the connection.
1444 _dbus_connection_unref_unlocked (DBusConnection *connection)
1446 dbus_int32_t old_refcount;
1448 HAVE_LOCK_CHECK (connection);
1450 _dbus_assert (connection != NULL);
1452 old_refcount = _dbus_atomic_dec (&connection->refcount);
1454 _dbus_connection_trace_ref (connection, old_refcount, old_refcount - 1,
1457 if (old_refcount == 1)
1458 _dbus_connection_last_unref (connection);
1461 static dbus_uint32_t
1462 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1464 dbus_uint32_t serial;
1466 serial = connection->client_serial++;
1468 if (connection->client_serial == 0)
1469 connection->client_serial = 1;
1475 * A callback for use with dbus_watch_new() to create a DBusWatch.
1477 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1478 * and the virtual handle_watch in DBusTransport if we got rid of it.
1479 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1482 * @param watch the watch.
1483 * @param condition the current condition of the file descriptors being watched.
1484 * @param data must be a pointer to a #DBusConnection
1485 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1488 _dbus_connection_handle_watch (DBusWatch *watch,
1489 unsigned int condition,
1492 DBusConnection *connection;
1494 DBusDispatchStatus status;
1498 _dbus_verbose ("start\n");
1500 CONNECTION_LOCK (connection);
1502 if (!_dbus_connection_acquire_io_path (connection, 1))
1504 /* another thread is handling the message */
1505 CONNECTION_UNLOCK (connection);
1509 HAVE_LOCK_CHECK (connection);
1510 retval = _dbus_transport_handle_watch (connection->transport,
1513 _dbus_connection_release_io_path (connection);
1515 HAVE_LOCK_CHECK (connection);
1517 _dbus_verbose ("middle\n");
1519 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1521 /* this calls out to user code */
1522 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1524 _dbus_verbose ("end\n");
1529 /* Protected by _DBUS_LOCK (shared_connections) */
1530 static DBusHashTable *shared_connections = NULL;
1531 static DBusList *shared_connections_no_guid = NULL;
1534 close_connection_on_shutdown (DBusConnection *connection)
1536 DBusMessage *message;
1538 dbus_connection_ref (connection);
1539 _dbus_connection_close_possibly_shared (connection);
1541 /* Churn through to the Disconnected message */
1542 while ((message = dbus_connection_pop_message (connection)))
1544 dbus_message_unref (message);
1546 dbus_connection_unref (connection);
1550 shared_connections_shutdown (void *data)
1554 if (!_DBUS_LOCK (shared_connections))
1556 /* We'd have initialized locks before adding anything, so there
1557 * can't be anything there. */
1561 /* This is a little bit unpleasant... better ideas? */
1562 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1564 DBusConnection *connection;
1567 _dbus_hash_iter_init (shared_connections, &iter);
1568 _dbus_hash_iter_next (&iter);
1570 connection = _dbus_hash_iter_get_value (&iter);
1572 _DBUS_UNLOCK (shared_connections);
1573 close_connection_on_shutdown (connection);
1574 if (!_DBUS_LOCK (shared_connections))
1575 _dbus_assert_not_reached ("global locks were already initialized");
1577 /* The connection should now be dead and not in our hash ... */
1578 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1581 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1583 _dbus_hash_table_unref (shared_connections);
1584 shared_connections = NULL;
1586 if (shared_connections_no_guid != NULL)
1588 DBusConnection *connection;
1589 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1590 while (connection != NULL)
1592 _DBUS_UNLOCK (shared_connections);
1593 close_connection_on_shutdown (connection);
1594 if (!_DBUS_LOCK (shared_connections))
1595 _dbus_assert_not_reached ("global locks were already initialized");
1596 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1600 shared_connections_no_guid = NULL;
1602 _DBUS_UNLOCK (shared_connections);
1606 connection_lookup_shared (DBusAddressEntry *entry,
1607 DBusConnection **result)
1609 _dbus_verbose ("checking for existing connection\n");
1613 if (!_DBUS_LOCK (shared_connections))
1615 /* If it was shared, we'd have initialized global locks when we put
1616 * it in shared_connections. */
1620 if (shared_connections == NULL)
1622 _dbus_verbose ("creating shared_connections hash table\n");
1624 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1627 if (shared_connections == NULL)
1629 _DBUS_UNLOCK (shared_connections);
1633 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1635 _dbus_hash_table_unref (shared_connections);
1636 shared_connections = NULL;
1637 _DBUS_UNLOCK (shared_connections);
1641 _dbus_verbose (" successfully created shared_connections\n");
1643 _DBUS_UNLOCK (shared_connections);
1644 return TRUE; /* no point looking up in the hash we just made */
1650 guid = dbus_address_entry_get_value (entry, "guid");
1654 DBusConnection *connection;
1656 connection = _dbus_hash_table_lookup_string (shared_connections,
1661 /* The DBusConnection can't be finalized without taking
1662 * the shared_connections lock to remove it from the
1663 * hash. So it's safe to ref the connection here.
1664 * However, it may be disconnected if the Disconnected
1665 * message hasn't been processed yet, in which case we
1666 * want to pretend it isn't in the hash and avoid
1669 * The idea is to avoid ever returning a disconnected connection
1670 * from dbus_connection_open(). We could just synchronously
1671 * drop our shared ref to the connection on connection disconnect,
1672 * and then assert here that the connection is connected, but
1673 * that causes reentrancy headaches.
1675 CONNECTION_LOCK (connection);
1676 if (_dbus_connection_get_is_connected_unlocked (connection))
1678 _dbus_connection_ref_unlocked (connection);
1679 *result = connection;
1680 _dbus_verbose ("looked up existing connection to server guid %s\n",
1685 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1688 CONNECTION_UNLOCK (connection);
1692 _DBUS_UNLOCK (shared_connections);
1698 connection_record_shared_unlocked (DBusConnection *connection,
1702 char *guid_in_connection;
1704 HAVE_LOCK_CHECK (connection);
1705 _dbus_assert (connection->server_guid == NULL);
1706 _dbus_assert (connection->shareable);
1708 /* get a hard ref on this connection, even if
1709 * we won't in fact store it in the hash, we still
1710 * need to hold a ref on it until it's disconnected.
1712 _dbus_connection_ref_unlocked (connection);
1716 if (!_DBUS_LOCK (shared_connections))
1719 if (!_dbus_list_prepend (&shared_connections_no_guid, connection))
1721 _DBUS_UNLOCK (shared_connections);
1725 _DBUS_UNLOCK (shared_connections);
1726 return TRUE; /* don't store in the hash */
1729 /* A separate copy of the key is required in the hash table, because
1730 * we don't have a lock on the connection when we are doing a hash
1734 guid_key = _dbus_strdup (guid);
1735 if (guid_key == NULL)
1738 guid_in_connection = _dbus_strdup (guid);
1739 if (guid_in_connection == NULL)
1741 dbus_free (guid_key);
1745 if (!_DBUS_LOCK (shared_connections))
1747 dbus_free (guid_in_connection);
1748 dbus_free (guid_key);
1752 _dbus_assert (shared_connections != NULL);
1754 if (!_dbus_hash_table_insert_string (shared_connections,
1755 guid_key, connection))
1757 dbus_free (guid_key);
1758 dbus_free (guid_in_connection);
1759 _DBUS_UNLOCK (shared_connections);
1763 connection->server_guid = guid_in_connection;
1765 _dbus_verbose ("stored connection to %s to be shared\n",
1766 connection->server_guid);
1768 _DBUS_UNLOCK (shared_connections);
1770 _dbus_assert (connection->server_guid != NULL);
1776 connection_forget_shared_unlocked (DBusConnection *connection)
1778 HAVE_LOCK_CHECK (connection);
1780 if (!connection->shareable)
1783 if (!_DBUS_LOCK (shared_connections))
1785 /* If it was shared, we'd have initialized global locks when we put
1786 * it in the table; so it can't be there. */
1790 if (connection->server_guid != NULL)
1792 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1793 connection->server_guid);
1795 if (!_dbus_hash_table_remove_string (shared_connections,
1796 connection->server_guid))
1797 _dbus_assert_not_reached ("connection was not in the shared table");
1799 dbus_free (connection->server_guid);
1800 connection->server_guid = NULL;
1804 _dbus_list_remove (&shared_connections_no_guid, connection);
1807 _DBUS_UNLOCK (shared_connections);
1809 /* remove our reference held on all shareable connections */
1810 _dbus_connection_unref_unlocked (connection);
1813 static DBusConnection*
1814 connection_try_from_address_entry (DBusAddressEntry *entry,
1817 DBusTransport *transport;
1818 DBusConnection *connection;
1820 transport = _dbus_transport_open (entry, error);
1822 if (transport == NULL)
1824 _DBUS_ASSERT_ERROR_IS_SET (error);
1828 connection = _dbus_connection_new_for_transport (transport);
1830 _dbus_transport_unref (transport);
1832 if (connection == NULL)
1834 _DBUS_SET_OOM (error);
1838 #ifndef DBUS_DISABLE_CHECKS
1839 _dbus_assert (!connection->have_connection_lock);
1846 * If the shared parameter is true, then any existing connection will
1847 * be used (and if a new connection is created, it will be available
1848 * for use by others). If the shared parameter is false, a new
1849 * connection will always be created, and the new connection will
1850 * never be returned to other callers.
1852 * @param address the address
1853 * @param shared whether the connection is shared or private
1854 * @param error error return
1855 * @returns the connection or #NULL on error
1857 static DBusConnection*
1858 _dbus_connection_open_internal (const char *address,
1862 DBusConnection *connection;
1863 DBusAddressEntry **entries;
1864 DBusError tmp_error = DBUS_ERROR_INIT;
1865 DBusError first_error = DBUS_ERROR_INIT;
1868 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1870 _dbus_verbose ("opening %s connection to: %s\n",
1871 shared ? "shared" : "private", address);
1873 if (!dbus_parse_address (address, &entries, &len, error))
1876 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1880 for (i = 0; i < len; i++)
1884 if (!connection_lookup_shared (entries[i], &connection))
1885 _DBUS_SET_OOM (&tmp_error);
1888 if (connection == NULL)
1890 connection = connection_try_from_address_entry (entries[i],
1893 if (connection != NULL && shared)
1897 connection->shareable = TRUE;
1899 /* guid may be NULL */
1900 guid = dbus_address_entry_get_value (entries[i], "guid");
1902 CONNECTION_LOCK (connection);
1904 if (!connection_record_shared_unlocked (connection, guid))
1906 _DBUS_SET_OOM (&tmp_error);
1907 _dbus_connection_close_possibly_shared_and_unlock (connection);
1908 dbus_connection_unref (connection);
1912 CONNECTION_UNLOCK (connection);
1919 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1922 dbus_move_error (&tmp_error, &first_error);
1924 dbus_error_free (&tmp_error);
1927 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1928 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1930 if (connection == NULL)
1932 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1933 dbus_move_error (&first_error, error);
1936 dbus_error_free (&first_error);
1938 dbus_address_entries_free (entries);
1943 * Closes a shared OR private connection, while dbus_connection_close() can
1944 * only be used on private connections. Should only be called by the
1945 * dbus code that owns the connection - an owner must be known,
1946 * the open/close state is like malloc/free, not like ref/unref.
1948 * @param connection the connection
1951 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1953 _dbus_assert (connection != NULL);
1954 _dbus_assert (connection->generation == _dbus_current_generation);
1956 CONNECTION_LOCK (connection);
1957 _dbus_connection_close_possibly_shared_and_unlock (connection);
1960 static DBusPreallocatedSend*
1961 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1963 DBusPreallocatedSend *preallocated;
1965 HAVE_LOCK_CHECK (connection);
1967 _dbus_assert (connection != NULL);
1969 preallocated = dbus_new (DBusPreallocatedSend, 1);
1970 if (preallocated == NULL)
1973 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1974 if (preallocated->queue_link == NULL)
1977 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1978 if (preallocated->counter_link == NULL)
1981 _dbus_counter_ref (preallocated->counter_link->data);
1983 preallocated->connection = connection;
1985 return preallocated;
1988 _dbus_list_free_link (preallocated->queue_link);
1990 dbus_free (preallocated);
1995 /* Called with lock held, does not update dispatch status */
1997 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
1998 DBusPreallocatedSend *preallocated,
1999 DBusMessage *message,
2000 dbus_uint32_t *client_serial)
2002 dbus_uint32_t serial;
2004 preallocated->queue_link->data = message;
2005 _dbus_list_prepend_link (&connection->outgoing_messages,
2006 preallocated->queue_link);
2008 /* It's OK that we'll never call the notify function, because for the
2009 * outgoing limit, there isn't one */
2010 _dbus_message_add_counter_link (message,
2011 preallocated->counter_link);
2013 dbus_free (preallocated);
2014 preallocated = NULL;
2016 dbus_message_ref (message);
2018 connection->n_outgoing += 1;
2020 _dbus_verbose ("Message %p (%s %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
2022 dbus_message_type_to_string (dbus_message_get_type (message)),
2023 dbus_message_get_path (message) ?
2024 dbus_message_get_path (message) :
2026 dbus_message_get_interface (message) ?
2027 dbus_message_get_interface (message) :
2029 dbus_message_get_member (message) ?
2030 dbus_message_get_member (message) :
2032 dbus_message_get_signature (message),
2033 dbus_message_get_destination (message) ?
2034 dbus_message_get_destination (message) :
2037 connection->n_outgoing);
2039 if (dbus_message_get_serial (message) == 0)
2041 serial = _dbus_connection_get_next_client_serial (connection);
2042 dbus_message_set_serial (message, serial);
2044 *client_serial = serial;
2049 *client_serial = dbus_message_get_serial (message);
2052 _dbus_verbose ("Message %p serial is %u\n",
2053 message, dbus_message_get_serial (message));
2055 dbus_message_lock (message);
2057 /* Now we need to run an iteration to hopefully just write the messages
2058 * out immediately, and otherwise get them queued up
2060 _dbus_connection_do_iteration_unlocked (connection,
2062 DBUS_ITERATION_DO_WRITING,
2065 /* If stuff is still queued up, be sure we wake up the main loop */
2066 if (connection->n_outgoing > 0)
2067 _dbus_connection_wakeup_mainloop (connection);
2071 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2072 DBusPreallocatedSend *preallocated,
2073 DBusMessage *message,
2074 dbus_uint32_t *client_serial)
2076 DBusDispatchStatus status;
2078 HAVE_LOCK_CHECK (connection);
2080 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2082 message, client_serial);
2084 _dbus_verbose ("middle\n");
2085 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2087 /* this calls out to user code */
2088 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2092 * Like dbus_connection_send(), but assumes the connection
2093 * is already locked on function entry, and unlocks before returning.
2095 * @param connection the connection
2096 * @param message the message to send
2097 * @param client_serial return location for client serial of sent message
2098 * @returns #FALSE on out-of-memory
2101 _dbus_connection_send_and_unlock (DBusConnection *connection,
2102 DBusMessage *message,
2103 dbus_uint32_t *client_serial)
2105 DBusPreallocatedSend *preallocated;
2107 _dbus_assert (connection != NULL);
2108 _dbus_assert (message != NULL);
2110 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2111 if (preallocated == NULL)
2113 CONNECTION_UNLOCK (connection);
2117 _dbus_connection_send_preallocated_and_unlock (connection,
2125 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2126 * If the new connection function does not ref the connection, we want to close it.
2128 * A bit of a hack, probably the new connection function should have returned a value
2129 * for whether to close, or should have had to close the connection itself if it
2132 * But, this works OK as long as the new connection function doesn't do anything
2133 * crazy like keep the connection around without ref'ing it.
2135 * We have to lock the connection across refcount check and close in case
2136 * the new connection function spawns a thread that closes and unrefs.
2137 * In that case, if the app thread
2138 * closes and unrefs first, we'll harmlessly close again; if the app thread
2139 * still has the ref, we'll close and then the app will close harmlessly.
2140 * If the app unrefs without closing, the app is broken since if the
2141 * app refs from the new connection function it is supposed to also close.
2143 * If we didn't atomically check the refcount and close with the lock held
2144 * though, we could screw this up.
2146 * @param connection the connection
2149 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2151 dbus_int32_t refcount;
2153 CONNECTION_LOCK (connection);
2155 refcount = _dbus_atomic_get (&connection->refcount);
2156 /* The caller should have at least one ref */
2157 _dbus_assert (refcount >= 1);
2160 _dbus_connection_close_possibly_shared_and_unlock (connection);
2162 CONNECTION_UNLOCK (connection);
2167 * When a function that blocks has been called with a timeout, and we
2168 * run out of memory, the time to wait for memory is based on the
2169 * timeout. If the caller was willing to block a long time we wait a
2170 * relatively long time for memory, if they were only willing to block
2171 * briefly then we retry for memory at a rapid rate.
2173 * @param timeout_milliseconds the timeout requested for blocking
2176 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2178 if (timeout_milliseconds == -1)
2179 _dbus_sleep_milliseconds (1000);
2180 else if (timeout_milliseconds < 100)
2181 ; /* just busy loop */
2182 else if (timeout_milliseconds <= 1000)
2183 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2185 _dbus_sleep_milliseconds (1000);
2189 generate_local_error_message (dbus_uint32_t serial,
2193 DBusMessage *message;
2194 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2198 if (!dbus_message_set_error_name (message, error_name))
2200 dbus_message_unref (message);
2205 dbus_message_set_no_reply (message, TRUE);
2207 if (!dbus_message_set_reply_serial (message,
2210 dbus_message_unref (message);
2215 if (error_msg != NULL)
2217 DBusMessageIter iter;
2219 dbus_message_iter_init_append (message, &iter);
2220 if (!dbus_message_iter_append_basic (&iter,
2224 dbus_message_unref (message);
2235 * Peek the incoming queue to see if we got reply for a specific serial
2238 _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
2239 dbus_uint32_t client_serial)
2242 HAVE_LOCK_CHECK (connection);
2244 link = _dbus_list_get_first_link (&connection->incoming_messages);
2246 while (link != NULL)
2248 DBusMessage *reply = link->data;
2250 if (dbus_message_get_reply_serial (reply) == client_serial)
2252 _dbus_verbose ("%s reply to %d found in queue\n", _DBUS_FUNCTION_NAME, client_serial);
2255 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2261 /* This is slightly strange since we can pop a message here without
2262 * the dispatch lock.
2265 check_for_reply_unlocked (DBusConnection *connection,
2266 dbus_uint32_t client_serial)
2270 HAVE_LOCK_CHECK (connection);
2272 link = _dbus_list_get_first_link (&connection->incoming_messages);
2274 while (link != NULL)
2276 DBusMessage *reply = link->data;
2278 if (dbus_message_get_reply_serial (reply) == client_serial)
2280 _dbus_list_remove_link (&connection->incoming_messages, link);
2281 connection->n_incoming -= 1;
2284 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2291 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2293 /* We can't iterate over the hash in the normal way since we'll be
2294 * dropping the lock for each item. So we restart the
2295 * iter each time as we drain the hash table.
2298 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2300 DBusPendingCall *pending;
2303 _dbus_hash_iter_init (connection->pending_replies, &iter);
2304 _dbus_hash_iter_next (&iter);
2306 pending = _dbus_hash_iter_get_value (&iter);
2307 _dbus_pending_call_ref_unlocked (pending);
2309 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2312 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
2313 _dbus_connection_remove_timeout_unlocked (connection,
2314 _dbus_pending_call_get_timeout_unlocked (pending));
2315 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2316 _dbus_hash_iter_remove_entry (&iter);
2318 _dbus_pending_call_unref_and_unlock (pending);
2319 CONNECTION_LOCK (connection);
2321 HAVE_LOCK_CHECK (connection);
2325 complete_pending_call_and_unlock (DBusConnection *connection,
2326 DBusPendingCall *pending,
2327 DBusMessage *message)
2329 _dbus_pending_call_set_reply_unlocked (pending, message);
2330 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2331 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2333 /* Must be called unlocked since it invokes app callback */
2334 _dbus_pending_call_complete (pending);
2335 dbus_pending_call_unref (pending);
2339 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2340 DBusPendingCall *pending)
2343 DBusDispatchStatus status;
2345 reply = check_for_reply_unlocked (connection,
2346 _dbus_pending_call_get_reply_serial_unlocked (pending));
2349 _dbus_verbose ("checked for reply\n");
2351 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2353 complete_pending_call_and_unlock (connection, pending, reply);
2354 dbus_message_unref (reply);
2356 CONNECTION_LOCK (connection);
2357 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2358 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2359 dbus_pending_call_unref (pending);
2368 * Blocks until a pending call times out or gets a reply.
2370 * Does not re-enter the main loop or run filter/path-registered
2371 * callbacks. The reply to the message will not be seen by
2374 * Returns immediately if pending call already got a reply.
2376 * @todo could use performance improvements (it keeps scanning
2377 * the whole message queue for example)
2379 * @param pending the pending call we block for a reply on
2382 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2384 long start_tv_sec, start_tv_usec;
2385 long tv_sec, tv_usec;
2386 DBusDispatchStatus status;
2387 DBusConnection *connection;
2388 dbus_uint32_t client_serial;
2389 DBusTimeout *timeout;
2390 int timeout_milliseconds, elapsed_milliseconds;
2392 _dbus_assert (pending != NULL);
2394 if (dbus_pending_call_get_completed (pending))
2397 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2399 connection = _dbus_pending_call_get_connection_and_lock (pending);
2401 /* Flush message queue - note, can affect dispatch status */
2402 _dbus_connection_flush_unlocked (connection);
2404 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2406 /* note that timeout_milliseconds is limited to a smallish value
2407 * in _dbus_pending_call_new() so overflows aren't possible
2410 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
2411 _dbus_get_monotonic_time (&start_tv_sec, &start_tv_usec);
2414 timeout_milliseconds = dbus_timeout_get_interval (timeout);
2416 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec\n",
2417 timeout_milliseconds,
2419 start_tv_sec, start_tv_usec);
2423 timeout_milliseconds = -1;
2425 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block for reply serial %u\n", client_serial);
2428 /* check to see if we already got the data off the socket */
2429 /* from another blocked pending call */
2430 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2433 /* Now we wait... */
2434 /* always block at least once as we know we don't have the reply yet */
2435 _dbus_connection_do_iteration_unlocked (connection,
2437 DBUS_ITERATION_DO_READING |
2438 DBUS_ITERATION_BLOCK,
2439 timeout_milliseconds);
2443 _dbus_verbose ("top of recheck\n");
2445 HAVE_LOCK_CHECK (connection);
2447 /* queue messages and get status */
2449 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2451 /* the get_completed() is in case a dispatch() while we were blocking
2452 * got the reply instead of us.
2454 if (_dbus_pending_call_get_completed_unlocked (pending))
2456 _dbus_verbose ("Pending call completed by dispatch\n");
2457 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2458 dbus_pending_call_unref (pending);
2462 if (status == DBUS_DISPATCH_DATA_REMAINS)
2464 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2468 _dbus_get_monotonic_time (&tv_sec, &tv_usec);
2469 elapsed_milliseconds = (tv_sec - start_tv_sec) * 1000 +
2470 (tv_usec - start_tv_usec) / 1000;
2472 if (!_dbus_connection_get_is_connected_unlocked (connection))
2474 DBusMessage *error_msg;
2476 error_msg = generate_local_error_message (client_serial,
2477 DBUS_ERROR_DISCONNECTED,
2478 "Connection was disconnected before a reply was received");
2480 /* on OOM error_msg is set to NULL */
2481 complete_pending_call_and_unlock (connection, pending, error_msg);
2482 dbus_pending_call_unref (pending);
2485 else if (connection->disconnect_message_link == NULL)
2486 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2487 else if (timeout == NULL)
2489 if (status == DBUS_DISPATCH_NEED_MEMORY)
2491 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2492 * we may already have a reply in the buffer and just can't process
2495 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2497 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2501 /* block again, we don't have the reply buffered yet. */
2502 _dbus_connection_do_iteration_unlocked (connection,
2504 DBUS_ITERATION_DO_READING |
2505 DBUS_ITERATION_BLOCK,
2506 timeout_milliseconds - elapsed_milliseconds);
2509 goto recheck_status;
2511 else if (tv_sec < start_tv_sec)
2512 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2513 else if (elapsed_milliseconds < timeout_milliseconds)
2515 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds - elapsed_milliseconds);
2517 if (status == DBUS_DISPATCH_NEED_MEMORY)
2519 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2520 * we may already have a reply in the buffer and just can't process
2523 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2525 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2529 /* block again, we don't have the reply buffered yet. */
2530 _dbus_connection_do_iteration_unlocked (connection,
2532 DBUS_ITERATION_DO_READING |
2533 DBUS_ITERATION_BLOCK,
2534 timeout_milliseconds - elapsed_milliseconds);
2537 goto recheck_status;
2540 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %d milliseconds and got no reply\n",
2541 elapsed_milliseconds);
2543 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2545 /* unlock and call user code */
2546 complete_pending_call_and_unlock (connection, pending, NULL);
2548 /* update user code on dispatch status */
2549 CONNECTION_LOCK (connection);
2550 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2551 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2552 dbus_pending_call_unref (pending);
2558 * @addtogroup DBusConnection
2564 * Gets a connection to a remote address. If a connection to the given
2565 * address already exists, returns the existing connection with its
2566 * reference count incremented. Otherwise, returns a new connection
2567 * and saves the new connection for possible re-use if a future call
2568 * to dbus_connection_open() asks to connect to the same server.
2570 * Use dbus_connection_open_private() to get a dedicated connection
2571 * not shared with other callers of dbus_connection_open().
2573 * If the open fails, the function returns #NULL, and provides a
2574 * reason for the failure in the error parameter. Pass #NULL for the
2575 * error parameter if you aren't interested in the reason for
2578 * Because this connection is shared, no user of the connection
2579 * may call dbus_connection_close(). However, when you are done with the
2580 * connection you should call dbus_connection_unref().
2582 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2583 * unless you have good reason; connections are expensive enough
2584 * that it's wasteful to create lots of connections to the same
2587 * @param address the address.
2588 * @param error address where an error can be returned.
2589 * @returns new connection, or #NULL on failure.
2592 dbus_connection_open (const char *address,
2595 DBusConnection *connection;
2597 _dbus_return_val_if_fail (address != NULL, NULL);
2598 _dbus_return_val_if_error_is_set (error, NULL);
2600 connection = _dbus_connection_open_internal (address,
2608 * Opens a new, dedicated connection to a remote address. Unlike
2609 * dbus_connection_open(), always creates a new connection.
2610 * This connection will not be saved or recycled by libdbus.
2612 * If the open fails, the function returns #NULL, and provides a
2613 * reason for the failure in the error parameter. Pass #NULL for the
2614 * error parameter if you aren't interested in the reason for
2617 * When you are done with this connection, you must
2618 * dbus_connection_close() to disconnect it,
2619 * and dbus_connection_unref() to free the connection object.
2621 * (The dbus_connection_close() can be skipped if the
2622 * connection is already known to be disconnected, for example
2623 * if you are inside a handler for the Disconnected signal.)
2625 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2626 * unless you have good reason; connections are expensive enough
2627 * that it's wasteful to create lots of connections to the same
2630 * @param address the address.
2631 * @param error address where an error can be returned.
2632 * @returns new connection, or #NULL on failure.
2635 dbus_connection_open_private (const char *address,
2638 DBusConnection *connection;
2640 _dbus_return_val_if_fail (address != NULL, NULL);
2641 _dbus_return_val_if_error_is_set (error, NULL);
2643 connection = _dbus_connection_open_internal (address,
2651 * Increments the reference count of a DBusConnection.
2653 * @param connection the connection.
2654 * @returns the connection.
2657 dbus_connection_ref (DBusConnection *connection)
2659 dbus_int32_t old_refcount;
2661 _dbus_return_val_if_fail (connection != NULL, NULL);
2662 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2663 old_refcount = _dbus_atomic_inc (&connection->refcount);
2664 _dbus_connection_trace_ref (connection, old_refcount, old_refcount + 1,
2671 free_outgoing_message (void *element,
2674 DBusMessage *message = element;
2675 DBusConnection *connection = data;
2677 _dbus_message_remove_counter (message, connection->outgoing_counter);
2678 dbus_message_unref (message);
2681 /* This is run without the mutex held, but after the last reference
2682 * to the connection has been dropped we should have no thread-related
2686 _dbus_connection_last_unref (DBusConnection *connection)
2690 _dbus_verbose ("Finalizing connection %p\n", connection);
2692 _dbus_assert (_dbus_atomic_get (&connection->refcount) == 0);
2694 /* You have to disconnect the connection before unref:ing it. Otherwise
2695 * you won't get the disconnected message.
2697 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2698 _dbus_assert (connection->server_guid == NULL);
2700 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2701 _dbus_object_tree_free_all_unlocked (connection->objects);
2703 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2704 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2705 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2706 dbus_connection_set_windows_user_function (connection, NULL, NULL, NULL);
2708 _dbus_watch_list_free (connection->watches);
2709 connection->watches = NULL;
2711 _dbus_timeout_list_free (connection->timeouts);
2712 connection->timeouts = NULL;
2714 _dbus_data_slot_list_free (&connection->slot_list);
2716 link = _dbus_list_get_first_link (&connection->filter_list);
2717 while (link != NULL)
2719 DBusMessageFilter *filter = link->data;
2720 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2722 filter->function = NULL;
2723 _dbus_message_filter_unref (filter); /* calls app callback */
2728 _dbus_list_clear (&connection->filter_list);
2730 /* ---- Done with stuff that invokes application callbacks */
2732 _dbus_object_tree_unref (connection->objects);
2734 _dbus_hash_table_unref (connection->pending_replies);
2735 connection->pending_replies = NULL;
2737 _dbus_list_clear (&connection->filter_list);
2739 _dbus_list_foreach (&connection->outgoing_messages,
2740 free_outgoing_message,
2742 _dbus_list_clear (&connection->outgoing_messages);
2744 _dbus_list_foreach (&connection->incoming_messages,
2745 (DBusForeachFunction) dbus_message_unref,
2747 _dbus_list_clear (&connection->incoming_messages);
2749 _dbus_counter_unref (connection->outgoing_counter);
2751 _dbus_transport_unref (connection->transport);
2753 if (connection->disconnect_message_link)
2755 DBusMessage *message = connection->disconnect_message_link->data;
2756 dbus_message_unref (message);
2757 _dbus_list_free_link (connection->disconnect_message_link);
2760 _dbus_condvar_free_at_location (&connection->dispatch_cond);
2761 _dbus_condvar_free_at_location (&connection->io_path_cond);
2763 _dbus_cmutex_free_at_location (&connection->io_path_mutex);
2764 _dbus_cmutex_free_at_location (&connection->dispatch_mutex);
2766 _dbus_rmutex_free_at_location (&connection->slot_mutex);
2768 _dbus_rmutex_free_at_location (&connection->mutex);
2770 dbus_free (connection);
2774 * Decrements the reference count of a DBusConnection, and finalizes
2775 * it if the count reaches zero.
2777 * Note: it is a bug to drop the last reference to a connection that
2778 * is still connected.
2780 * For shared connections, libdbus will own a reference
2781 * as long as the connection is connected, so you can know that either
2782 * you don't have the last reference, or it's OK to drop the last reference.
2783 * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2784 * return shared connections.
2786 * For private connections, the creator of the connection must arrange for
2787 * dbus_connection_close() to be called prior to dropping the last reference.
2788 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2790 * @param connection the connection.
2793 dbus_connection_unref (DBusConnection *connection)
2795 dbus_int32_t old_refcount;
2797 _dbus_return_if_fail (connection != NULL);
2798 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2800 old_refcount = _dbus_atomic_dec (&connection->refcount);
2802 _dbus_connection_trace_ref (connection, old_refcount, old_refcount - 1,
2805 if (old_refcount == 1)
2807 #ifndef DBUS_DISABLE_CHECKS
2808 if (_dbus_transport_get_is_connected (connection->transport))
2810 _dbus_warn_check_failed ("The last reference on a connection was dropped without closing the connection. This is a bug in an application. See dbus_connection_unref() documentation for details.\n%s",
2811 connection->shareable ?
2812 "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2813 "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2817 _dbus_connection_last_unref (connection);
2822 * Note that the transport can disconnect itself (other end drops us)
2823 * and in that case this function never runs. So this function must
2824 * not do anything more than disconnect the transport and update the
2827 * If the transport self-disconnects, then we assume someone will
2828 * dispatch the connection to cause the dispatch status update.
2831 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2833 DBusDispatchStatus status;
2835 HAVE_LOCK_CHECK (connection);
2837 _dbus_verbose ("Disconnecting %p\n", connection);
2839 /* We need to ref because update_dispatch_status_and_unlock will unref
2840 * the connection if it was shared and libdbus was the only remaining
2843 _dbus_connection_ref_unlocked (connection);
2845 _dbus_transport_disconnect (connection->transport);
2847 /* This has the side effect of queuing the disconnect message link
2848 * (unless we don't have enough memory, possibly, so don't assert it).
2849 * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2850 * should never again return the newly-disconnected connection.
2852 * However, we only unref the shared connection and exit_on_disconnect when
2853 * the disconnect message reaches the head of the message queue,
2854 * NOT when it's first queued.
2856 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2858 /* This calls out to user code */
2859 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2861 /* Could also call out to user code */
2862 dbus_connection_unref (connection);
2866 * Closes a private connection, so no further data can be sent or received.
2867 * This disconnects the transport (such as a socket) underlying the
2870 * Attempts to send messages after closing a connection are safe, but will result in
2871 * error replies generated locally in libdbus.
2873 * This function does not affect the connection's reference count. It's
2874 * safe to close a connection more than once; all calls after the
2875 * first do nothing. It's impossible to "reopen" a connection, a
2876 * new connection must be created. This function may result in a call
2877 * to the DBusDispatchStatusFunction set with
2878 * dbus_connection_set_dispatch_status_function(), as the disconnect
2879 * message it generates needs to be dispatched.
2881 * If a connection is dropped by the remote application, it will
2884 * You must close a connection prior to releasing the last reference to
2885 * the connection. If you dbus_connection_unref() for the last time
2886 * without closing the connection, the results are undefined; it
2887 * is a bug in your program and libdbus will try to print a warning.
2889 * You may not close a shared connection. Connections created with
2890 * dbus_connection_open() or dbus_bus_get() are shared.
2891 * These connections are owned by libdbus, and applications should
2892 * only unref them, never close them. Applications can know it is
2893 * safe to unref these connections because libdbus will be holding a
2894 * reference as long as the connection is open. Thus, either the
2895 * connection is closed and it is OK to drop the last reference,
2896 * or the connection is open and the app knows it does not have the
2899 * Connections created with dbus_connection_open_private() or
2900 * dbus_bus_get_private() are not kept track of or referenced by
2901 * libdbus. The creator of these connections is responsible for
2902 * calling dbus_connection_close() prior to releasing the last
2903 * reference, if the connection is not already disconnected.
2905 * @param connection the private (unshared) connection to close
2908 dbus_connection_close (DBusConnection *connection)
2910 _dbus_return_if_fail (connection != NULL);
2911 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2913 CONNECTION_LOCK (connection);
2915 #ifndef DBUS_DISABLE_CHECKS
2916 if (connection->shareable)
2918 CONNECTION_UNLOCK (connection);
2920 _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2925 _dbus_connection_close_possibly_shared_and_unlock (connection);
2929 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2931 HAVE_LOCK_CHECK (connection);
2932 return _dbus_transport_get_is_connected (connection->transport);
2936 * Gets whether the connection is currently open. A connection may
2937 * become disconnected when the remote application closes its end, or
2938 * exits; a connection may also be disconnected with
2939 * dbus_connection_close().
2941 * There are not separate states for "closed" and "disconnected," the two
2942 * terms are synonymous. This function should really be called
2943 * get_is_open() but for historical reasons is not.
2945 * @param connection the connection.
2946 * @returns #TRUE if the connection is still alive.
2949 dbus_connection_get_is_connected (DBusConnection *connection)
2953 _dbus_return_val_if_fail (connection != NULL, FALSE);
2955 CONNECTION_LOCK (connection);
2956 res = _dbus_connection_get_is_connected_unlocked (connection);
2957 CONNECTION_UNLOCK (connection);
2963 * Gets whether the connection was authenticated. (Note that
2964 * if the connection was authenticated then disconnected,
2965 * this function still returns #TRUE)
2967 * @param connection the connection
2968 * @returns #TRUE if the connection was ever authenticated
2971 dbus_connection_get_is_authenticated (DBusConnection *connection)
2975 _dbus_return_val_if_fail (connection != NULL, FALSE);
2977 CONNECTION_LOCK (connection);
2978 res = _dbus_transport_try_to_authenticate (connection->transport);
2979 CONNECTION_UNLOCK (connection);
2985 * Sets authenticated status for connection. Needed for kdbus, where authentication is
2986 * made in different manner.
2987 * LOCK commented out because called with lock already set
2988 * @param connection the connection
2991 dbus_connection_set_is_authenticated (DBusConnection *connection)
2993 _dbus_return_val_if_fail (connection != NULL, FALSE);
2995 // CONNECTION_LOCK (connection);
2996 connection->transport->authenticated = TRUE;
2997 // CONNECTION_UNLOCK (connection);
3003 * Gets whether the connection is not authenticated as a specific
3004 * user. If the connection is not authenticated, this function
3005 * returns #TRUE, and if it is authenticated but as an anonymous user,
3006 * it returns #TRUE. If it is authenticated as a specific user, then
3007 * this returns #FALSE. (Note that if the connection was authenticated
3008 * as anonymous then disconnected, this function still returns #TRUE.)
3010 * If the connection is not anonymous, you can use
3011 * dbus_connection_get_unix_user() and
3012 * dbus_connection_get_windows_user() to see who it's authorized as.
3014 * If you want to prevent non-anonymous authorization, use
3015 * dbus_server_set_auth_mechanisms() to remove the mechanisms that
3016 * allow proving user identity (i.e. only allow the ANONYMOUS
3019 * @param connection the connection
3020 * @returns #TRUE if not authenticated or authenticated as anonymous
3023 dbus_connection_get_is_anonymous (DBusConnection *connection)
3027 _dbus_return_val_if_fail (connection != NULL, FALSE);
3029 CONNECTION_LOCK (connection);
3030 res = _dbus_transport_get_is_anonymous (connection->transport);
3031 CONNECTION_UNLOCK (connection);
3037 * Gets the ID of the server address we are authenticated to, if this
3038 * connection is on the client side. If the connection is on the
3039 * server side, this will always return #NULL - use dbus_server_get_id()
3040 * to get the ID of your own server, if you are the server side.
3042 * If a client-side connection is not authenticated yet, the ID may be
3043 * available if it was included in the server address, but may not be
3044 * available. The only way to be sure the server ID is available
3045 * is to wait for authentication to complete.
3047 * In general, each mode of connecting to a given server will have
3048 * its own ID. So for example, if the session bus daemon is listening
3049 * on UNIX domain sockets and on TCP, then each of those modalities
3050 * will have its own server ID.
3052 * If you want an ID that identifies an entire session bus, look at
3053 * dbus_bus_get_id() instead (which is just a convenience wrapper
3054 * around the org.freedesktop.DBus.GetId method invoked on the bus).
3056 * You can also get a machine ID; see dbus_get_local_machine_id() to
3057 * get the machine you are on. There isn't a convenience wrapper, but
3058 * you can invoke org.freedesktop.DBus.Peer.GetMachineId on any peer
3059 * to get the machine ID on the other end.
3061 * The D-Bus specification describes the server ID and other IDs in a
3064 * @param connection the connection
3065 * @returns the server ID or #NULL if no memory or the connection is server-side
3068 dbus_connection_get_server_id (DBusConnection *connection)
3072 _dbus_return_val_if_fail (connection != NULL, NULL);
3074 CONNECTION_LOCK (connection);
3075 id = _dbus_strdup (_dbus_transport_get_server_id (connection->transport));
3076 CONNECTION_UNLOCK (connection);
3082 * Tests whether a certain type can be send via the connection. This
3083 * will always return TRUE for all types, with the exception of
3084 * DBUS_TYPE_UNIX_FD. The function will return TRUE for
3085 * DBUS_TYPE_UNIX_FD only on systems that know Unix file descriptors
3086 * and can send them via the chosen transport and when the remote side
3089 * This function can be used to do runtime checking for types that
3090 * might be unknown to the specific D-Bus client implementation
3091 * version, i.e. it will return FALSE for all types this
3092 * implementation does not know, including invalid or reserved types.
3094 * @param connection the connection
3095 * @param type the type to check
3096 * @returns TRUE if the type may be send via the connection
3099 dbus_connection_can_send_type(DBusConnection *connection,
3102 _dbus_return_val_if_fail (connection != NULL, FALSE);
3104 if (!dbus_type_is_valid (type))
3107 if (type != DBUS_TYPE_UNIX_FD)
3110 #ifdef HAVE_UNIX_FD_PASSING
3114 CONNECTION_LOCK(connection);
3115 b = _dbus_transport_can_pass_unix_fd(connection->transport);
3116 CONNECTION_UNLOCK(connection);
3126 * Set whether _exit() should be called when the connection receives a
3127 * disconnect signal. The call to _exit() comes after any handlers for
3128 * the disconnect signal run; handlers can cancel the exit by calling
3131 * By default, exit_on_disconnect is #FALSE; but for message bus
3132 * connections returned from dbus_bus_get() it will be toggled on
3135 * @param connection the connection
3136 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
3139 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
3140 dbus_bool_t exit_on_disconnect)
3142 _dbus_return_if_fail (connection != NULL);
3144 CONNECTION_LOCK (connection);
3145 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
3146 CONNECTION_UNLOCK (connection);
3150 * Preallocates resources needed to send a message, allowing the message
3151 * to be sent without the possibility of memory allocation failure.
3152 * Allows apps to create a future guarantee that they can send
3153 * a message regardless of memory shortages.
3155 * @param connection the connection we're preallocating for.
3156 * @returns the preallocated resources, or #NULL
3158 DBusPreallocatedSend*
3159 dbus_connection_preallocate_send (DBusConnection *connection)
3161 DBusPreallocatedSend *preallocated;
3163 _dbus_return_val_if_fail (connection != NULL, NULL);
3165 CONNECTION_LOCK (connection);
3168 _dbus_connection_preallocate_send_unlocked (connection);
3170 CONNECTION_UNLOCK (connection);
3172 return preallocated;
3176 * Frees preallocated message-sending resources from
3177 * dbus_connection_preallocate_send(). Should only
3178 * be called if the preallocated resources are not used
3179 * to send a message.
3181 * @param connection the connection
3182 * @param preallocated the resources
3185 dbus_connection_free_preallocated_send (DBusConnection *connection,
3186 DBusPreallocatedSend *preallocated)
3188 _dbus_return_if_fail (connection != NULL);
3189 _dbus_return_if_fail (preallocated != NULL);
3190 _dbus_return_if_fail (connection == preallocated->connection);
3192 _dbus_list_free_link (preallocated->queue_link);
3193 _dbus_counter_unref (preallocated->counter_link->data);
3194 _dbus_list_free_link (preallocated->counter_link);
3195 dbus_free (preallocated);
3199 * Sends a message using preallocated resources. This function cannot fail.
3200 * It works identically to dbus_connection_send() in other respects.
3201 * Preallocated resources comes from dbus_connection_preallocate_send().
3202 * This function "consumes" the preallocated resources, they need not
3203 * be freed separately.
3205 * @param connection the connection
3206 * @param preallocated the preallocated resources
3207 * @param message the message to send
3208 * @param client_serial return location for client serial assigned to the message
3211 dbus_connection_send_preallocated (DBusConnection *connection,
3212 DBusPreallocatedSend *preallocated,
3213 DBusMessage *message,
3214 dbus_uint32_t *client_serial)
3216 _dbus_return_if_fail (connection != NULL);
3217 _dbus_return_if_fail (preallocated != NULL);
3218 _dbus_return_if_fail (message != NULL);
3219 _dbus_return_if_fail (preallocated->connection == connection);
3220 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3221 dbus_message_get_member (message) != NULL);
3222 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
3223 (dbus_message_get_interface (message) != NULL &&
3224 dbus_message_get_member (message) != NULL));
3226 CONNECTION_LOCK (connection);
3228 #ifdef HAVE_UNIX_FD_PASSING
3230 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3231 message->n_unix_fds > 0)
3233 /* Refuse to send fds on a connection that cannot handle
3234 them. Unfortunately we cannot return a proper error here, so
3235 the best we can is just return. */
3236 CONNECTION_UNLOCK (connection);
3242 _dbus_connection_send_preallocated_and_unlock (connection,
3244 message, client_serial);
3248 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
3249 DBusMessage *message,
3250 dbus_uint32_t *client_serial)
3252 DBusPreallocatedSend *preallocated;
3254 _dbus_assert (connection != NULL);
3255 _dbus_assert (message != NULL);
3257 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
3258 if (preallocated == NULL)
3261 _dbus_connection_send_preallocated_unlocked_no_update (connection,
3269 * Adds a message to the outgoing message queue. Does not block to
3270 * write the message to the network; that happens asynchronously. To
3271 * force the message to be written, call dbus_connection_flush() however
3272 * it is not necessary to call dbus_connection_flush() by hand; the
3273 * message will be sent the next time the main loop is run.
3274 * dbus_connection_flush() should only be used, for example, if
3275 * the application was expected to exit before running the main loop.
3277 * Because this only queues the message, the only reason it can
3278 * fail is lack of memory. Even if the connection is disconnected,
3279 * no error will be returned. If the function fails due to lack of memory,
3280 * it returns #FALSE. The function will never fail for other reasons; even
3281 * if the connection is disconnected, you can queue an outgoing message,
3282 * though obviously it won't be sent.
3284 * The message serial is used by the remote application to send a
3285 * reply; see dbus_message_get_serial() or the D-Bus specification.
3287 * dbus_message_unref() can be called as soon as this method returns
3288 * as the message queue will hold its own ref until the message is sent.
3290 * @param connection the connection.
3291 * @param message the message to write.
3292 * @param serial return location for message serial, or #NULL if you don't care
3293 * @returns #TRUE on success.
3296 dbus_connection_send (DBusConnection *connection,
3297 DBusMessage *message,
3298 dbus_uint32_t *serial)
3300 _dbus_return_val_if_fail (connection != NULL, FALSE);
3301 _dbus_return_val_if_fail (message != NULL, FALSE);
3303 CONNECTION_LOCK (connection);
3305 #ifdef HAVE_UNIX_FD_PASSING
3307 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3308 message->n_unix_fds > 0)
3310 /* Refuse to send fds on a connection that cannot handle
3311 them. Unfortunately we cannot return a proper error here, so
3312 the best we can is just return. */
3313 CONNECTION_UNLOCK (connection);
3319 return _dbus_connection_send_and_unlock (connection,
3325 reply_handler_timeout (void *data)
3327 DBusConnection *connection;
3328 DBusDispatchStatus status;
3329 DBusPendingCall *pending = data;
3331 connection = _dbus_pending_call_get_connection_and_lock (pending);
3332 _dbus_connection_ref_unlocked (connection);
3334 _dbus_pending_call_queue_timeout_error_unlocked (pending,
3336 _dbus_connection_remove_timeout_unlocked (connection,
3337 _dbus_pending_call_get_timeout_unlocked (pending));
3338 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
3340 _dbus_verbose ("middle\n");
3341 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3343 /* Unlocks, and calls out to user code */
3344 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3345 dbus_connection_unref (connection);
3351 * Queues a message to send, as with dbus_connection_send(),
3352 * but also returns a #DBusPendingCall used to receive a reply to the
3353 * message. If no reply is received in the given timeout_milliseconds,
3354 * this function expires the pending reply and generates a synthetic
3355 * error reply (generated in-process, not by the remote application)
3356 * indicating that a timeout occurred.
3358 * A #DBusPendingCall will see a reply message before any filters or
3359 * registered object path handlers. See dbus_connection_dispatch() for
3360 * details on when handlers are run.
3362 * A #DBusPendingCall will always see exactly one reply message,
3363 * unless it's cancelled with dbus_pending_call_cancel().
3365 * If #NULL is passed for the pending_return, the #DBusPendingCall
3366 * will still be generated internally, and used to track
3367 * the message reply timeout. This means a timeout error will
3368 * occur if no reply arrives, unlike with dbus_connection_send().
3370 * If -1 is passed for the timeout, a sane default timeout is used. -1
3371 * is typically the best value for the timeout for this reason, unless
3372 * you want a very short or very long timeout. If #DBUS_TIMEOUT_INFINITE is
3373 * passed for the timeout, no timeout will be set and the call will block
3376 * @warning if the connection is disconnected or you try to send Unix
3377 * file descriptors on a connection that does not support them, the
3378 * #DBusPendingCall will be set to #NULL, so be careful with this.
3380 * @param connection the connection
3381 * @param message the message to send
3382 * @param pending_return return location for a #DBusPendingCall
3383 * object, or #NULL if connection is disconnected or when you try to
3384 * send Unix file descriptors on a connection that does not support
3386 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3387 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3389 * @returns #FALSE if no memory, #TRUE otherwise.
3393 dbus_connection_send_with_reply (DBusConnection *connection,
3394 DBusMessage *message,
3395 DBusPendingCall **pending_return,
3396 int timeout_milliseconds)
3398 DBusPendingCall *pending;
3399 dbus_int32_t serial = -1;
3400 DBusDispatchStatus status;
3402 _dbus_return_val_if_fail (connection != NULL, FALSE);
3403 _dbus_return_val_if_fail (message != NULL, FALSE);
3404 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3407 *pending_return = NULL;
3409 CONNECTION_LOCK (connection);
3411 #ifdef HAVE_UNIX_FD_PASSING
3413 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3414 message->n_unix_fds > 0)
3416 /* Refuse to send fds on a connection that cannot handle
3417 them. Unfortunately we cannot return a proper error here, so
3418 the best we can do is return TRUE but leave *pending_return
3420 CONNECTION_UNLOCK (connection);
3426 if (!_dbus_connection_get_is_connected_unlocked (connection))
3428 CONNECTION_UNLOCK (connection);
3433 pending = _dbus_pending_call_new_unlocked (connection,
3434 timeout_milliseconds,
3435 reply_handler_timeout);
3437 if (pending == NULL)
3439 CONNECTION_UNLOCK (connection);
3443 /* Assign a serial to the message */
3444 serial = dbus_message_get_serial (message);
3447 serial = _dbus_connection_get_next_client_serial (connection);
3448 dbus_message_set_serial (message, serial);
3451 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3454 /* Insert the serial in the pending replies hash;
3455 * hash takes a refcount on DBusPendingCall.
3456 * Also, add the timeout.
3458 if (!_dbus_connection_attach_pending_call_unlocked (connection,
3462 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3464 _dbus_connection_detach_pending_call_and_unlock (connection,
3466 goto error_unlocked;
3470 *pending_return = pending; /* hand off refcount */
3473 _dbus_connection_detach_pending_call_unlocked (connection, pending);
3474 /* we still have a ref to the pending call in this case, we unref
3475 * after unlocking, below
3479 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3481 /* this calls out to user code */
3482 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3484 if (pending_return == NULL)
3485 dbus_pending_call_unref (pending);
3490 CONNECTION_UNLOCK (connection);
3492 dbus_pending_call_unref (pending);
3497 * Sends a message and blocks a certain time period while waiting for
3498 * a reply. This function does not reenter the main loop,
3499 * i.e. messages other than the reply are queued up but not
3500 * processed. This function is used to invoke method calls on a
3503 * If a normal reply is received, it is returned, and removed from the
3504 * incoming message queue. If it is not received, #NULL is returned
3505 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3506 * received, it is converted to a #DBusError and returned as an error,
3507 * then the reply message is deleted and #NULL is returned. If
3508 * something else goes wrong, result is set to whatever is
3509 * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3510 * #DBUS_ERROR_DISCONNECTED.
3512 * @warning While this function blocks the calling thread will not be
3513 * processing the incoming message queue. This means you can end up
3514 * deadlocked if the application you're talking to needs you to reply
3515 * to a method. To solve this, either avoid the situation, block in a
3516 * separate thread from the main connection-dispatching thread, or use
3517 * dbus_pending_call_set_notify() to avoid blocking.
3519 * @param connection the connection
3520 * @param message the message to send
3521 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3522 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3524 * @param error return location for error message
3525 * @returns the message that is the reply or #NULL with an error code if the
3529 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3530 DBusMessage *message,
3531 int timeout_milliseconds,
3535 DBusPendingCall *pending;
3537 _dbus_return_val_if_fail (connection != NULL, NULL);
3538 _dbus_return_val_if_fail (message != NULL, NULL);
3539 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3540 _dbus_return_val_if_error_is_set (error, NULL);
3542 #ifdef HAVE_UNIX_FD_PASSING
3544 CONNECTION_LOCK (connection);
3545 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3546 message->n_unix_fds > 0)
3548 CONNECTION_UNLOCK (connection);
3549 dbus_set_error(error, DBUS_ERROR_FAILED, "Cannot send file descriptors on this connection.");
3552 CONNECTION_UNLOCK (connection);
3556 if (!dbus_connection_send_with_reply (connection, message,
3557 &pending, timeout_milliseconds))
3559 _DBUS_SET_OOM (error);
3563 if (pending == NULL)
3565 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3569 dbus_pending_call_block (pending);
3571 reply = dbus_pending_call_steal_reply (pending);
3572 dbus_pending_call_unref (pending);
3574 /* call_complete_and_unlock() called from pending_call_block() should
3575 * always fill this in.
3577 _dbus_assert (reply != NULL);
3579 if (dbus_set_error_from_message (error, reply))
3581 dbus_message_unref (reply);
3589 * Blocks until the outgoing message queue is empty.
3590 * Assumes connection lock already held.
3592 * If you call this, you MUST call update_dispatch_status afterword...
3594 * @param connection the connection.
3596 static DBusDispatchStatus
3597 _dbus_connection_flush_unlocked (DBusConnection *connection)
3599 /* We have to specify DBUS_ITERATION_DO_READING here because
3600 * otherwise we could have two apps deadlock if they are both doing
3601 * a flush(), and the kernel buffers fill up. This could change the
3604 DBusDispatchStatus status;
3606 HAVE_LOCK_CHECK (connection);
3608 while (connection->n_outgoing > 0 &&
3609 _dbus_connection_get_is_connected_unlocked (connection))
3611 _dbus_verbose ("doing iteration in\n");
3612 HAVE_LOCK_CHECK (connection);
3613 _dbus_connection_do_iteration_unlocked (connection,
3615 DBUS_ITERATION_DO_READING |
3616 DBUS_ITERATION_DO_WRITING |
3617 DBUS_ITERATION_BLOCK,
3621 HAVE_LOCK_CHECK (connection);
3622 _dbus_verbose ("middle\n");
3623 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3625 HAVE_LOCK_CHECK (connection);
3630 * Blocks until the outgoing message queue is empty.
3632 * @param connection the connection.
3635 dbus_connection_flush (DBusConnection *connection)
3637 /* We have to specify DBUS_ITERATION_DO_READING here because
3638 * otherwise we could have two apps deadlock if they are both doing
3639 * a flush(), and the kernel buffers fill up. This could change the
3642 DBusDispatchStatus status;
3644 _dbus_return_if_fail (connection != NULL);
3646 CONNECTION_LOCK (connection);
3648 status = _dbus_connection_flush_unlocked (connection);
3650 HAVE_LOCK_CHECK (connection);
3651 /* Unlocks and calls out to user code */
3652 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3654 _dbus_verbose ("end\n");
3658 * This function implements dbus_connection_read_write_dispatch() and
3659 * dbus_connection_read_write() (they pass a different value for the
3660 * dispatch parameter).
3662 * @param connection the connection
3663 * @param timeout_milliseconds max time to block or -1 for infinite
3664 * @param dispatch dispatch new messages or leave them on the incoming queue
3665 * @returns #TRUE if the disconnect message has not been processed
3668 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3669 int timeout_milliseconds,
3670 dbus_bool_t dispatch)
3672 DBusDispatchStatus dstatus;
3673 dbus_bool_t progress_possible;
3675 /* Need to grab a ref here in case we're a private connection and
3676 * the user drops the last ref in a handler we call; see bug
3677 * https://bugs.freedesktop.org/show_bug.cgi?id=15635
3679 dbus_connection_ref (connection);
3680 dstatus = dbus_connection_get_dispatch_status (connection);
3682 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3684 _dbus_verbose ("doing dispatch\n");
3685 dbus_connection_dispatch (connection);
3686 CONNECTION_LOCK (connection);
3688 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3690 _dbus_verbose ("pausing for memory\n");
3691 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3692 CONNECTION_LOCK (connection);
3696 CONNECTION_LOCK (connection);
3697 if (_dbus_connection_get_is_connected_unlocked (connection))
3699 _dbus_verbose ("doing iteration\n");
3700 _dbus_connection_do_iteration_unlocked (connection,
3702 DBUS_ITERATION_DO_READING |
3703 DBUS_ITERATION_DO_WRITING |
3704 DBUS_ITERATION_BLOCK,
3705 timeout_milliseconds);
3709 HAVE_LOCK_CHECK (connection);
3710 /* If we can dispatch, we can make progress until the Disconnected message
3711 * has been processed; if we can only read/write, we can make progress
3712 * as long as the transport is open.
3715 progress_possible = connection->n_incoming != 0 ||
3716 connection->disconnect_message_link != NULL;
3718 progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3720 CONNECTION_UNLOCK (connection);
3722 dbus_connection_unref (connection);
3724 return progress_possible; /* TRUE if we can make more progress */
3729 * This function is intended for use with applications that don't want
3730 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3731 * example usage would be:
3734 * while (dbus_connection_read_write_dispatch (connection, -1))
3735 * ; // empty loop body
3738 * In this usage you would normally have set up a filter function to look
3739 * at each message as it is dispatched. The loop terminates when the last
3740 * message from the connection (the disconnected signal) is processed.
3742 * If there are messages to dispatch, this function will
3743 * dbus_connection_dispatch() once, and return. If there are no
3744 * messages to dispatch, this function will block until it can read or
3745 * write, then read or write, then return.
3747 * The way to think of this function is that it either makes some sort
3748 * of progress, or it blocks. Note that, while it is blocked on I/O, it
3749 * cannot be interrupted (even by other threads), which makes this function
3750 * unsuitable for applications that do more than just react to received
3753 * The return value indicates whether the disconnect message has been
3754 * processed, NOT whether the connection is connected. This is
3755 * important because even after disconnecting, you want to process any
3756 * messages you received prior to the disconnect.
3758 * @param connection the connection
3759 * @param timeout_milliseconds max time to block or -1 for infinite
3760 * @returns #TRUE if the disconnect message has not been processed
3763 dbus_connection_read_write_dispatch (DBusConnection *connection,
3764 int timeout_milliseconds)
3766 _dbus_return_val_if_fail (connection != NULL, FALSE);
3767 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3768 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3772 * This function is intended for use with applications that don't want to
3773 * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3774 * dbus_connection_read_write_dispatch().
3776 * As long as the connection is open, this function will block until it can
3777 * read or write, then read or write, then return #TRUE.
3779 * If the connection is closed, the function returns #FALSE.
3781 * The return value indicates whether reading or writing is still
3782 * possible, i.e. whether the connection is connected.
3784 * Note that even after disconnection, messages may remain in the
3785 * incoming queue that need to be
3786 * processed. dbus_connection_read_write_dispatch() dispatches
3787 * incoming messages for you; with dbus_connection_read_write() you
3788 * have to arrange to drain the incoming queue yourself.
3790 * @param connection the connection
3791 * @param timeout_milliseconds max time to block or -1 for infinite
3792 * @returns #TRUE if still connected
3795 dbus_connection_read_write (DBusConnection *connection,
3796 int timeout_milliseconds)
3798 _dbus_return_val_if_fail (connection != NULL, FALSE);
3799 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3800 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3803 /* We need to call this anytime we pop the head of the queue, and then
3804 * update_dispatch_status_and_unlock needs to be called afterward
3805 * which will "process" the disconnected message and set
3806 * disconnected_message_processed.
3809 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3810 DBusMessage *head_of_queue)
3812 HAVE_LOCK_CHECK (connection);
3814 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3815 if (connection->disconnect_message_link == NULL &&
3816 dbus_message_is_signal (head_of_queue,
3817 DBUS_INTERFACE_LOCAL,
3820 connection->disconnected_message_arrived = TRUE;
3825 * Returns the first-received message from the incoming message queue,
3826 * leaving it in the queue. If the queue is empty, returns #NULL.
3828 * The caller does not own a reference to the returned message, and
3829 * must either return it using dbus_connection_return_message() or
3830 * keep it after calling dbus_connection_steal_borrowed_message(). No
3831 * one can get at the message while its borrowed, so return it as
3832 * quickly as possible and don't keep a reference to it after
3833 * returning it. If you need to keep the message, make a copy of it.
3835 * dbus_connection_dispatch() will block if called while a borrowed
3836 * message is outstanding; only one piece of code can be playing with
3837 * the incoming queue at a time. This function will block if called
3838 * during a dbus_connection_dispatch().
3840 * @param connection the connection.
3841 * @returns next message in the incoming queue.
3844 dbus_connection_borrow_message (DBusConnection *connection)
3846 DBusDispatchStatus status;
3847 DBusMessage *message;
3849 _dbus_return_val_if_fail (connection != NULL, NULL);
3851 _dbus_verbose ("start\n");
3853 /* this is called for the side effect that it queues
3854 * up any messages from the transport
3856 status = dbus_connection_get_dispatch_status (connection);
3857 if (status != DBUS_DISPATCH_DATA_REMAINS)
3860 CONNECTION_LOCK (connection);
3862 _dbus_connection_acquire_dispatch (connection);
3864 /* While a message is outstanding, the dispatch lock is held */
3865 _dbus_assert (connection->message_borrowed == NULL);
3867 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3869 message = connection->message_borrowed;
3871 check_disconnected_message_arrived_unlocked (connection, message);
3873 /* Note that we KEEP the dispatch lock until the message is returned */
3874 if (message == NULL)
3875 _dbus_connection_release_dispatch (connection);
3877 CONNECTION_UNLOCK (connection);
3879 _dbus_message_trace_ref (message, -1, -1, "dbus_connection_borrow_message");
3881 /* We don't update dispatch status until it's returned or stolen */
3887 * Used to return a message after peeking at it using
3888 * dbus_connection_borrow_message(). Only called if
3889 * message from dbus_connection_borrow_message() was non-#NULL.
3891 * @param connection the connection
3892 * @param message the message from dbus_connection_borrow_message()
3895 dbus_connection_return_message (DBusConnection *connection,
3896 DBusMessage *message)
3898 DBusDispatchStatus status;
3900 _dbus_return_if_fail (connection != NULL);
3901 _dbus_return_if_fail (message != NULL);
3902 _dbus_return_if_fail (message == connection->message_borrowed);
3903 _dbus_return_if_fail (connection->dispatch_acquired);
3905 CONNECTION_LOCK (connection);
3907 _dbus_assert (message == connection->message_borrowed);
3909 connection->message_borrowed = NULL;
3911 _dbus_connection_release_dispatch (connection);
3913 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3914 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3916 _dbus_message_trace_ref (message, -1, -1, "dbus_connection_return_message");
3920 * Used to keep a message after peeking at it using
3921 * dbus_connection_borrow_message(). Before using this function, see
3922 * the caveats/warnings in the documentation for
3923 * dbus_connection_pop_message().
3925 * @param connection the connection
3926 * @param message the message from dbus_connection_borrow_message()
3929 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3930 DBusMessage *message)
3932 DBusMessage *pop_message;
3933 DBusDispatchStatus status;
3935 _dbus_return_if_fail (connection != NULL);
3936 _dbus_return_if_fail (message != NULL);
3937 _dbus_return_if_fail (message == connection->message_borrowed);
3938 _dbus_return_if_fail (connection->dispatch_acquired);
3940 CONNECTION_LOCK (connection);
3942 _dbus_assert (message == connection->message_borrowed);
3944 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3945 _dbus_assert (message == pop_message);
3946 (void) pop_message; /* unused unless asserting */
3948 connection->n_incoming -= 1;
3950 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3951 message, connection->n_incoming);
3953 connection->message_borrowed = NULL;
3955 _dbus_connection_release_dispatch (connection);
3957 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3958 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3959 _dbus_message_trace_ref (message, -1, -1,
3960 "dbus_connection_steal_borrowed_message");
3963 /* See dbus_connection_pop_message, but requires the caller to own
3964 * the lock before calling. May drop the lock while running.
3967 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3969 HAVE_LOCK_CHECK (connection);
3971 _dbus_assert (connection->message_borrowed == NULL);
3973 if (connection->n_incoming > 0)
3977 link = _dbus_list_pop_first_link (&connection->incoming_messages);
3978 connection->n_incoming -= 1;
3980 _dbus_verbose ("Message %p (%s %s %s %s sig:'%s' serial:%u) removed from incoming queue %p, %d incoming\n",
3982 dbus_message_type_to_string (dbus_message_get_type (link->data)),
3983 dbus_message_get_path (link->data) ?
3984 dbus_message_get_path (link->data) :
3986 dbus_message_get_interface (link->data) ?
3987 dbus_message_get_interface (link->data) :
3989 dbus_message_get_member (link->data) ?
3990 dbus_message_get_member (link->data) :
3992 dbus_message_get_signature (link->data),
3993 dbus_message_get_serial (link->data),
3994 connection, connection->n_incoming);
3996 _dbus_message_trace_ref (link->data, -1, -1,
3997 "_dbus_connection_pop_message_link_unlocked");
3999 check_disconnected_message_arrived_unlocked (connection, link->data);
4007 /* See dbus_connection_pop_message, but requires the caller to own
4008 * the lock before calling. May drop the lock while running.
4011 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
4015 HAVE_LOCK_CHECK (connection);
4017 link = _dbus_connection_pop_message_link_unlocked (connection);
4021 DBusMessage *message;
4023 message = link->data;
4025 _dbus_list_free_link (link);
4034 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
4035 DBusList *message_link)
4037 HAVE_LOCK_CHECK (connection);
4039 _dbus_assert (message_link != NULL);
4040 /* You can't borrow a message while a link is outstanding */
4041 _dbus_assert (connection->message_borrowed == NULL);
4042 /* We had to have the dispatch lock across the pop/putback */
4043 _dbus_assert (connection->dispatch_acquired);
4045 _dbus_list_prepend_link (&connection->incoming_messages,
4047 connection->n_incoming += 1;
4049 _dbus_verbose ("Message %p (%s %s %s '%s') put back into queue %p, %d incoming\n",
4051 dbus_message_type_to_string (dbus_message_get_type (message_link->data)),
4052 dbus_message_get_interface (message_link->data) ?
4053 dbus_message_get_interface (message_link->data) :
4055 dbus_message_get_member (message_link->data) ?
4056 dbus_message_get_member (message_link->data) :
4058 dbus_message_get_signature (message_link->data),
4059 connection, connection->n_incoming);
4061 _dbus_message_trace_ref (message_link->data, -1, -1,
4062 "_dbus_connection_putback_message_link_unlocked");
4066 * Returns the first-received message from the incoming message queue,
4067 * removing it from the queue. The caller owns a reference to the
4068 * returned message. If the queue is empty, returns #NULL.
4070 * This function bypasses any message handlers that are registered,
4071 * and so using it is usually wrong. Instead, let the main loop invoke
4072 * dbus_connection_dispatch(). Popping messages manually is only
4073 * useful in very simple programs that don't share a #DBusConnection
4074 * with any libraries or other modules.
4076 * There is a lock that covers all ways of accessing the incoming message
4077 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
4078 * dbus_connection_borrow_message(), etc. will all block while one of the others
4079 * in the group is running.
4081 * @param connection the connection.
4082 * @returns next message in the incoming queue.
4085 dbus_connection_pop_message (DBusConnection *connection)
4087 DBusMessage *message;
4088 DBusDispatchStatus status;
4090 _dbus_verbose ("start\n");
4092 /* this is called for the side effect that it queues
4093 * up any messages from the transport
4095 status = dbus_connection_get_dispatch_status (connection);
4096 if (status != DBUS_DISPATCH_DATA_REMAINS)
4099 CONNECTION_LOCK (connection);
4100 _dbus_connection_acquire_dispatch (connection);
4101 HAVE_LOCK_CHECK (connection);
4103 message = _dbus_connection_pop_message_unlocked (connection);
4105 _dbus_verbose ("Returning popped message %p\n", message);
4107 _dbus_connection_release_dispatch (connection);
4109 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4110 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4116 * Acquire the dispatcher. This is a separate lock so the main
4117 * connection lock can be dropped to call out to application dispatch
4120 * @param connection the connection.
4123 _dbus_connection_acquire_dispatch (DBusConnection *connection)
4125 HAVE_LOCK_CHECK (connection);
4127 _dbus_connection_ref_unlocked (connection);
4128 CONNECTION_UNLOCK (connection);
4130 _dbus_verbose ("locking dispatch_mutex\n");
4131 _dbus_cmutex_lock (connection->dispatch_mutex);
4133 while (connection->dispatch_acquired)
4135 _dbus_verbose ("waiting for dispatch to be acquirable\n");
4136 _dbus_condvar_wait (connection->dispatch_cond,
4137 connection->dispatch_mutex);
4140 _dbus_assert (!connection->dispatch_acquired);
4142 connection->dispatch_acquired = TRUE;
4144 _dbus_verbose ("unlocking dispatch_mutex\n");
4145 _dbus_cmutex_unlock (connection->dispatch_mutex);
4147 CONNECTION_LOCK (connection);
4148 _dbus_connection_unref_unlocked (connection);
4152 * Release the dispatcher when you're done with it. Only call
4153 * after you've acquired the dispatcher. Wakes up at most one
4154 * thread currently waiting to acquire the dispatcher.
4156 * @param connection the connection.
4159 _dbus_connection_release_dispatch (DBusConnection *connection)
4161 HAVE_LOCK_CHECK (connection);
4163 _dbus_verbose ("locking dispatch_mutex\n");
4164 _dbus_cmutex_lock (connection->dispatch_mutex);
4166 _dbus_assert (connection->dispatch_acquired);
4168 connection->dispatch_acquired = FALSE;
4169 _dbus_condvar_wake_one (connection->dispatch_cond);
4171 _dbus_verbose ("unlocking dispatch_mutex\n");
4172 _dbus_cmutex_unlock (connection->dispatch_mutex);
4176 _dbus_connection_failed_pop (DBusConnection *connection,
4177 DBusList *message_link)
4179 _dbus_list_prepend_link (&connection->incoming_messages,
4181 connection->n_incoming += 1;
4184 /* Note this may be called multiple times since we don't track whether we already did it */
4186 notify_disconnected_unlocked (DBusConnection *connection)
4188 HAVE_LOCK_CHECK (connection);
4190 /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
4191 * connection from dbus_bus_get(). We make the same guarantee for
4192 * dbus_connection_open() but in a different way since we don't want to
4193 * unref right here; we instead check for connectedness before returning
4194 * the connection from the hash.
4196 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
4198 /* Dump the outgoing queue, we aren't going to be able to
4199 * send it now, and we'd like accessors like
4200 * dbus_connection_get_outgoing_size() to be accurate.
4202 if (connection->n_outgoing > 0)
4206 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
4207 connection->n_outgoing);
4209 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
4211 _dbus_connection_message_sent_unlocked (connection, link->data);
4216 /* Note this may be called multiple times since we don't track whether we already did it */
4217 static DBusDispatchStatus
4218 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
4220 HAVE_LOCK_CHECK (connection);
4222 if (connection->disconnect_message_link != NULL)
4224 _dbus_verbose ("Sending disconnect message\n");
4226 /* If we have pending calls, queue their timeouts - we want the Disconnected
4227 * to be the last message, after these timeouts.
4229 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
4231 /* We haven't sent the disconnect message already,
4232 * and all real messages have been queued up.
4234 _dbus_connection_queue_synthesized_message_link (connection,
4235 connection->disconnect_message_link);
4236 connection->disconnect_message_link = NULL;
4238 return DBUS_DISPATCH_DATA_REMAINS;
4241 return DBUS_DISPATCH_COMPLETE;
4244 static DBusDispatchStatus
4245 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
4247 HAVE_LOCK_CHECK (connection);
4249 if (connection->n_incoming > 0)
4250 return DBUS_DISPATCH_DATA_REMAINS;
4251 else if (!_dbus_transport_queue_messages (connection->transport))
4252 return DBUS_DISPATCH_NEED_MEMORY;
4255 DBusDispatchStatus status;
4256 dbus_bool_t is_connected;
4258 status = _dbus_transport_get_dispatch_status (connection->transport);
4259 is_connected = _dbus_transport_get_is_connected (connection->transport);
4261 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
4262 DISPATCH_STATUS_NAME (status), is_connected);
4266 /* It's possible this would be better done by having an explicit
4267 * notification from _dbus_transport_disconnect() that would
4268 * synchronously do this, instead of waiting for the next dispatch
4269 * status check. However, probably not good to change until it causes
4272 notify_disconnected_unlocked (connection);
4274 /* I'm not sure this is needed; the idea is that we want to
4275 * queue the Disconnected only after we've read all the
4276 * messages, but if we're disconnected maybe we are guaranteed
4277 * to have read them all ?
4279 if (status == DBUS_DISPATCH_COMPLETE)
4280 status = notify_disconnected_and_dispatch_complete_unlocked (connection);
4283 if (status != DBUS_DISPATCH_COMPLETE)
4285 else if (connection->n_incoming > 0)
4286 return DBUS_DISPATCH_DATA_REMAINS;
4288 return DBUS_DISPATCH_COMPLETE;
4293 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
4294 DBusDispatchStatus new_status)
4296 dbus_bool_t changed;
4297 DBusDispatchStatusFunction function;
4300 HAVE_LOCK_CHECK (connection);
4302 _dbus_connection_ref_unlocked (connection);
4304 changed = new_status != connection->last_dispatch_status;
4306 connection->last_dispatch_status = new_status;
4308 function = connection->dispatch_status_function;
4309 data = connection->dispatch_status_data;
4311 if (connection->disconnected_message_arrived &&
4312 !connection->disconnected_message_processed)
4314 connection->disconnected_message_processed = TRUE;
4316 /* this does an unref, but we have a ref
4317 * so we should not run the finalizer here
4320 connection_forget_shared_unlocked (connection);
4322 if (connection->exit_on_disconnect)
4324 CONNECTION_UNLOCK (connection);
4326 _dbus_verbose ("Exiting on Disconnected signal\n");
4328 _dbus_assert_not_reached ("Call to exit() returned");
4332 /* We drop the lock */
4333 CONNECTION_UNLOCK (connection);
4335 if (changed && function)
4337 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
4338 connection, new_status,
4339 DISPATCH_STATUS_NAME (new_status));
4340 (* function) (connection, new_status, data);
4343 dbus_connection_unref (connection);
4347 * Gets the current state of the incoming message queue.
4348 * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
4349 * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
4350 * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
4351 * there could be data, but we can't know for sure without more
4354 * To process the incoming message queue, use dbus_connection_dispatch()
4355 * or (in rare cases) dbus_connection_pop_message().
4357 * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
4358 * have messages in the queue, or we have raw bytes buffered up
4359 * that need to be parsed. When these bytes are parsed, they
4360 * may not add up to an entire message. Thus, it's possible
4361 * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
4362 * have a message yet.
4364 * In particular this happens on initial connection, because all sorts
4365 * of authentication protocol stuff has to be parsed before the
4366 * first message arrives.
4368 * @param connection the connection.
4369 * @returns current dispatch status
4372 dbus_connection_get_dispatch_status (DBusConnection *connection)
4374 DBusDispatchStatus status;
4376 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4378 _dbus_verbose ("start\n");
4380 CONNECTION_LOCK (connection);
4382 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4384 CONNECTION_UNLOCK (connection);
4390 * Filter funtion for handling the Peer standard interface.
4392 static DBusHandlerResult
4393 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
4394 DBusMessage *message)
4396 dbus_bool_t sent = FALSE;
4397 DBusMessage *ret = NULL;
4398 DBusList *expire_link;
4400 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
4402 /* This means we're letting the bus route this message */
4403 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4406 if (!dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4408 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4411 /* Preallocate a linked-list link, so that if we need to dispose of a
4412 * message, we can attach it to the expired list */
4413 expire_link = _dbus_list_alloc_link (NULL);
4416 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4418 if (dbus_message_is_method_call (message,
4419 DBUS_INTERFACE_PEER,
4422 ret = dbus_message_new_method_return (message);
4426 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4428 else if (dbus_message_is_method_call (message,
4429 DBUS_INTERFACE_PEER,
4434 ret = dbus_message_new_method_return (message);
4438 _dbus_string_init (&uuid);
4439 if (_dbus_get_local_machine_uuid_encoded (&uuid))
4441 const char *v_STRING = _dbus_string_get_const_data (&uuid);
4442 if (dbus_message_append_args (ret,
4443 DBUS_TYPE_STRING, &v_STRING,
4446 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4449 _dbus_string_free (&uuid);
4453 /* We need to bounce anything else with this interface, otherwise apps
4454 * could start extending the interface and when we added extensions
4455 * here to DBusConnection we'd break those apps.
4457 ret = dbus_message_new_error (message,
4458 DBUS_ERROR_UNKNOWN_METHOD,
4459 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4463 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4469 _dbus_list_free_link (expire_link);
4473 /* It'll be safe to unref the reply when we unlock */
4474 expire_link->data = ret;
4475 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4479 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4481 return DBUS_HANDLER_RESULT_HANDLED;
4485 * Processes all builtin filter functions
4487 * If the spec specifies a standard interface
4488 * they should be processed from this method
4490 static DBusHandlerResult
4491 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4492 DBusMessage *message)
4494 /* We just run one filter for now but have the option to run more
4495 if the spec calls for it in the future */
4497 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4501 * Processes any incoming data.
4503 * If there's incoming raw data that has not yet been parsed, it is
4504 * parsed, which may or may not result in adding messages to the
4507 * The incoming data buffer is filled when the connection reads from
4508 * its underlying transport (such as a socket). Reading usually
4509 * happens in dbus_watch_handle() or dbus_connection_read_write().
4511 * If there are complete messages in the incoming queue,
4512 * dbus_connection_dispatch() removes one message from the queue and
4513 * processes it. Processing has three steps.
4515 * First, any method replies are passed to #DBusPendingCall or
4516 * dbus_connection_send_with_reply_and_block() in order to
4517 * complete the pending method call.
4519 * Second, any filters registered with dbus_connection_add_filter()
4520 * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4521 * then processing stops after that filter.
4523 * Third, if the message is a method call it is forwarded to
4524 * any registered object path handlers added with
4525 * dbus_connection_register_object_path() or
4526 * dbus_connection_register_fallback().
4528 * A single call to dbus_connection_dispatch() will process at most
4529 * one message; it will not clear the entire message queue.
4531 * Be careful about calling dbus_connection_dispatch() from inside a
4532 * message handler, i.e. calling dbus_connection_dispatch()
4533 * recursively. If threads have been initialized with a recursive
4534 * mutex function, then this will not deadlock; however, it can
4535 * certainly confuse your application.
4537 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4539 * @param connection the connection
4540 * @returns dispatch status, see dbus_connection_get_dispatch_status()
4543 dbus_connection_dispatch (DBusConnection *connection)
4545 DBusMessage *message;
4546 DBusList *link, *filter_list_copy, *message_link;
4547 DBusHandlerResult result;
4548 DBusPendingCall *pending;
4549 dbus_int32_t reply_serial;
4550 DBusDispatchStatus status;
4551 dbus_bool_t found_object;
4553 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4555 _dbus_verbose ("\n");
4557 CONNECTION_LOCK (connection);
4558 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4559 if (status != DBUS_DISPATCH_DATA_REMAINS)
4561 /* unlocks and calls out to user code */
4562 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4566 /* We need to ref the connection since the callback could potentially
4567 * drop the last ref to it
4569 _dbus_connection_ref_unlocked (connection);
4571 _dbus_connection_acquire_dispatch (connection);
4572 HAVE_LOCK_CHECK (connection);
4574 message_link = _dbus_connection_pop_message_link_unlocked (connection);
4575 if (message_link == NULL)
4577 /* another thread dispatched our stuff */
4579 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4581 _dbus_connection_release_dispatch (connection);
4583 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4585 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4587 dbus_connection_unref (connection);
4592 message = message_link->data;
4594 _dbus_verbose (" dispatching message %p (%s %s %s '%s')\n",
4596 dbus_message_type_to_string (dbus_message_get_type (message)),
4597 dbus_message_get_interface (message) ?
4598 dbus_message_get_interface (message) :
4600 dbus_message_get_member (message) ?
4601 dbus_message_get_member (message) :
4603 dbus_message_get_signature (message));
4605 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4607 /* Pending call handling must be first, because if you do
4608 * dbus_connection_send_with_reply_and_block() or
4609 * dbus_pending_call_block() then no handlers/filters will be run on
4610 * the reply. We want consistent semantics in the case where we
4611 * dbus_connection_dispatch() the reply.
4614 reply_serial = dbus_message_get_reply_serial (message);
4615 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4619 _dbus_verbose ("Dispatching a pending reply\n");
4620 complete_pending_call_and_unlock (connection, pending, message);
4621 pending = NULL; /* it's probably unref'd */
4623 CONNECTION_LOCK (connection);
4624 _dbus_verbose ("pending call completed in dispatch\n");
4625 result = DBUS_HANDLER_RESULT_HANDLED;
4629 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4630 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4633 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4635 _dbus_connection_release_dispatch (connection);
4636 HAVE_LOCK_CHECK (connection);
4638 _dbus_connection_failed_pop (connection, message_link);
4640 /* unlocks and calls user code */
4641 _dbus_connection_update_dispatch_status_and_unlock (connection,
4642 DBUS_DISPATCH_NEED_MEMORY);
4643 dbus_connection_unref (connection);
4645 return DBUS_DISPATCH_NEED_MEMORY;
4648 _dbus_list_foreach (&filter_list_copy,
4649 (DBusForeachFunction)_dbus_message_filter_ref,
4652 /* We're still protected from dispatch() reentrancy here
4653 * since we acquired the dispatcher
4655 CONNECTION_UNLOCK (connection);
4657 link = _dbus_list_get_first_link (&filter_list_copy);
4658 while (link != NULL)
4660 DBusMessageFilter *filter = link->data;
4661 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4663 if (filter->function == NULL)
4665 _dbus_verbose (" filter was removed in a callback function\n");
4670 _dbus_verbose (" running filter on message %p\n", message);
4671 result = (* filter->function) (connection, message, filter->user_data);
4673 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4679 _dbus_list_foreach (&filter_list_copy,
4680 (DBusForeachFunction)_dbus_message_filter_unref,
4682 _dbus_list_clear (&filter_list_copy);
4684 CONNECTION_LOCK (connection);
4686 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4688 _dbus_verbose ("No memory\n");
4691 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4693 _dbus_verbose ("filter handled message in dispatch\n");
4697 /* We're still protected from dispatch() reentrancy here
4698 * since we acquired the dispatcher
4700 _dbus_verbose (" running object path dispatch on message %p (%s %s %s '%s')\n",
4702 dbus_message_type_to_string (dbus_message_get_type (message)),
4703 dbus_message_get_interface (message) ?
4704 dbus_message_get_interface (message) :
4706 dbus_message_get_member (message) ?
4707 dbus_message_get_member (message) :
4709 dbus_message_get_signature (message));
4711 HAVE_LOCK_CHECK (connection);
4712 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4716 CONNECTION_LOCK (connection);
4718 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4720 _dbus_verbose ("object tree handled message in dispatch\n");
4724 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4728 DBusPreallocatedSend *preallocated;
4729 DBusList *expire_link;
4731 _dbus_verbose (" sending error %s\n",
4732 DBUS_ERROR_UNKNOWN_METHOD);
4734 if (!_dbus_string_init (&str))
4736 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4737 _dbus_verbose ("no memory for error string in dispatch\n");
4741 if (!_dbus_string_append_printf (&str,
4742 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4743 dbus_message_get_member (message),
4744 dbus_message_get_signature (message),
4745 dbus_message_get_interface (message)))
4747 _dbus_string_free (&str);
4748 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4749 _dbus_verbose ("no memory for error string in dispatch\n");
4753 reply = dbus_message_new_error (message,
4754 found_object ? DBUS_ERROR_UNKNOWN_METHOD : DBUS_ERROR_UNKNOWN_OBJECT,
4755 _dbus_string_get_const_data (&str));
4756 _dbus_string_free (&str);
4760 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4761 _dbus_verbose ("no memory for error reply in dispatch\n");
4765 expire_link = _dbus_list_alloc_link (reply);
4767 if (expire_link == NULL)
4769 dbus_message_unref (reply);
4770 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4771 _dbus_verbose ("no memory for error send in dispatch\n");
4775 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4777 if (preallocated == NULL)
4779 _dbus_list_free_link (expire_link);
4780 /* It's OK that this is finalized, because it hasn't been seen by
4781 * anything that could attach user callbacks */
4782 dbus_message_unref (reply);
4783 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4784 _dbus_verbose ("no memory for error send in dispatch\n");
4788 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4790 /* reply will be freed when we release the lock */
4791 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4793 result = DBUS_HANDLER_RESULT_HANDLED;
4796 _dbus_verbose (" done dispatching %p (%s %s %s '%s') on connection %p\n", message,
4797 dbus_message_type_to_string (dbus_message_get_type (message)),
4798 dbus_message_get_interface (message) ?
4799 dbus_message_get_interface (message) :
4801 dbus_message_get_member (message) ?
4802 dbus_message_get_member (message) :
4804 dbus_message_get_signature (message),
4808 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4810 _dbus_verbose ("out of memory\n");
4812 /* Put message back, and we'll start over.
4813 * Yes this means handlers must be idempotent if they
4814 * don't return HANDLED; c'est la vie.
4816 _dbus_connection_putback_message_link_unlocked (connection,
4818 /* now we don't want to free them */
4819 message_link = NULL;
4824 _dbus_verbose (" ... done dispatching\n");
4827 _dbus_connection_release_dispatch (connection);
4828 HAVE_LOCK_CHECK (connection);
4830 if (message != NULL)
4832 /* We don't want this message to count in maximum message limits when
4833 * computing the dispatch status, below. We have to drop the lock
4834 * temporarily, because finalizing a message can trigger callbacks.
4836 * We have a reference to the connection, and we don't use any cached
4837 * pointers to the connection's internals below this point, so it should
4838 * be safe to drop the lock and take it back. */
4839 CONNECTION_UNLOCK (connection);
4840 dbus_message_unref (message);
4841 CONNECTION_LOCK (connection);
4844 if (message_link != NULL)
4845 _dbus_list_free_link (message_link);
4847 _dbus_verbose ("before final status update\n");
4848 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4850 /* unlocks and calls user code */
4851 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4853 dbus_connection_unref (connection);
4859 * Sets the watch functions for the connection. These functions are
4860 * responsible for making the application's main loop aware of file
4861 * descriptors that need to be monitored for events, using select() or
4862 * poll(). When using Qt, typically the DBusAddWatchFunction would
4863 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4864 * could call g_io_add_watch(), or could be used as part of a more
4865 * elaborate GSource. Note that when a watch is added, it may
4868 * The DBusWatchToggledFunction notifies the application that the
4869 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4870 * to check this. A disabled watch should have no effect, and enabled
4871 * watch should be added to the main loop. This feature is used
4872 * instead of simply adding/removing the watch because
4873 * enabling/disabling can be done without memory allocation. The
4874 * toggled function may be NULL if a main loop re-queries
4875 * dbus_watch_get_enabled() every time anyway.
4877 * The DBusWatch can be queried for the file descriptor to watch using
4878 * dbus_watch_get_unix_fd() or dbus_watch_get_socket(), and for the
4879 * events to watch for using dbus_watch_get_flags(). The flags
4880 * returned by dbus_watch_get_flags() will only contain
4881 * DBUS_WATCH_READABLE and DBUS_WATCH_WRITABLE, never
4882 * DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR; all watches implicitly
4883 * include a watch for hangups, errors, and other exceptional
4886 * Once a file descriptor becomes readable or writable, or an exception
4887 * occurs, dbus_watch_handle() should be called to
4888 * notify the connection of the file descriptor's condition.
4890 * dbus_watch_handle() cannot be called during the
4891 * DBusAddWatchFunction, as the connection will not be ready to handle
4894 * It is not allowed to reference a DBusWatch after it has been passed
4895 * to remove_function.
4897 * If #FALSE is returned due to lack of memory, the failure may be due
4898 * to a #FALSE return from the new add_function. If so, the
4899 * add_function may have been called successfully one or more times,
4900 * but the remove_function will also have been called to remove any
4901 * successful adds. i.e. if #FALSE is returned the net result
4902 * should be that dbus_connection_set_watch_functions() has no effect,
4903 * but the add_function and remove_function may have been called.
4905 * @note The thread lock on DBusConnection is held while
4906 * watch functions are invoked, so inside these functions you
4907 * may not invoke any methods on DBusConnection or it will deadlock.
4908 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/tread.html#8144
4909 * if you encounter this issue and want to attempt writing a patch.
4911 * @param connection the connection.
4912 * @param add_function function to begin monitoring a new descriptor.
4913 * @param remove_function function to stop monitoring a descriptor.
4914 * @param toggled_function function to notify of enable/disable
4915 * @param data data to pass to add_function and remove_function.
4916 * @param free_data_function function to be called to free the data.
4917 * @returns #FALSE on failure (no memory)
4920 dbus_connection_set_watch_functions (DBusConnection *connection,
4921 DBusAddWatchFunction add_function,
4922 DBusRemoveWatchFunction remove_function,
4923 DBusWatchToggledFunction toggled_function,
4925 DBusFreeFunction free_data_function)
4929 _dbus_return_val_if_fail (connection != NULL, FALSE);
4931 CONNECTION_LOCK (connection);
4933 retval = _dbus_watch_list_set_functions (connection->watches,
4934 add_function, remove_function,
4936 data, free_data_function);
4938 CONNECTION_UNLOCK (connection);
4944 * Sets the timeout functions for the connection. These functions are
4945 * responsible for making the application's main loop aware of timeouts.
4946 * When using Qt, typically the DBusAddTimeoutFunction would create a
4947 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4950 * The DBusTimeoutToggledFunction notifies the application that the
4951 * timeout has been enabled or disabled. Call
4952 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4953 * have no effect, and enabled timeout should be added to the main
4954 * loop. This feature is used instead of simply adding/removing the
4955 * timeout because enabling/disabling can be done without memory
4956 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4957 * to enable and disable. The toggled function may be NULL if a main
4958 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4959 * Whenever a timeout is toggled, its interval may change.
4961 * The DBusTimeout can be queried for the timer interval using
4962 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4963 * repeatedly, each time the interval elapses, starting after it has
4964 * elapsed once. The timeout stops firing when it is removed with the
4965 * given remove_function. The timer interval may change whenever the
4966 * timeout is added, removed, or toggled.
4968 * @note The thread lock on DBusConnection is held while
4969 * timeout functions are invoked, so inside these functions you
4970 * may not invoke any methods on DBusConnection or it will deadlock.
4971 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
4972 * if you encounter this issue and want to attempt writing a patch.
4974 * @param connection the connection.
4975 * @param add_function function to add a timeout.
4976 * @param remove_function function to remove a timeout.
4977 * @param toggled_function function to notify of enable/disable
4978 * @param data data to pass to add_function and remove_function.
4979 * @param free_data_function function to be called to free the data.
4980 * @returns #FALSE on failure (no memory)
4983 dbus_connection_set_timeout_functions (DBusConnection *connection,
4984 DBusAddTimeoutFunction add_function,
4985 DBusRemoveTimeoutFunction remove_function,
4986 DBusTimeoutToggledFunction toggled_function,
4988 DBusFreeFunction free_data_function)
4992 _dbus_return_val_if_fail (connection != NULL, FALSE);
4994 CONNECTION_LOCK (connection);
4996 retval = _dbus_timeout_list_set_functions (connection->timeouts,
4997 add_function, remove_function,
4999 data, free_data_function);
5001 CONNECTION_UNLOCK (connection);
5007 * Sets the mainloop wakeup function for the connection. This function
5008 * is responsible for waking up the main loop (if its sleeping in
5009 * another thread) when some some change has happened to the
5010 * connection that the mainloop needs to reconsider (e.g. a message
5011 * has been queued for writing). When using Qt, this typically
5012 * results in a call to QEventLoop::wakeUp(). When using GLib, it
5013 * would call g_main_context_wakeup().
5015 * @param connection the connection.
5016 * @param wakeup_main_function function to wake up the mainloop
5017 * @param data data to pass wakeup_main_function
5018 * @param free_data_function function to be called to free the data.
5021 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
5022 DBusWakeupMainFunction wakeup_main_function,
5024 DBusFreeFunction free_data_function)
5027 DBusFreeFunction old_free_data;
5029 _dbus_return_if_fail (connection != NULL);
5031 CONNECTION_LOCK (connection);
5032 old_data = connection->wakeup_main_data;
5033 old_free_data = connection->free_wakeup_main_data;
5035 connection->wakeup_main_function = wakeup_main_function;
5036 connection->wakeup_main_data = data;
5037 connection->free_wakeup_main_data = free_data_function;
5039 CONNECTION_UNLOCK (connection);
5041 /* Callback outside the lock */
5043 (*old_free_data) (old_data);
5047 * Set a function to be invoked when the dispatch status changes.
5048 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
5049 * dbus_connection_dispatch() needs to be called to process incoming
5050 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
5051 * from inside the DBusDispatchStatusFunction. Indeed, almost
5052 * any reentrancy in this function is a bad idea. Instead,
5053 * the DBusDispatchStatusFunction should simply save an indication
5054 * that messages should be dispatched later, when the main loop
5057 * If you don't set a dispatch status function, you have to be sure to
5058 * dispatch on every iteration of your main loop, especially if
5059 * dbus_watch_handle() or dbus_timeout_handle() were called.
5061 * @param connection the connection
5062 * @param function function to call on dispatch status changes
5063 * @param data data for function
5064 * @param free_data_function free the function data
5067 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
5068 DBusDispatchStatusFunction function,
5070 DBusFreeFunction free_data_function)
5073 DBusFreeFunction old_free_data;
5075 _dbus_return_if_fail (connection != NULL);
5077 CONNECTION_LOCK (connection);
5078 old_data = connection->dispatch_status_data;
5079 old_free_data = connection->free_dispatch_status_data;
5081 connection->dispatch_status_function = function;
5082 connection->dispatch_status_data = data;
5083 connection->free_dispatch_status_data = free_data_function;
5085 CONNECTION_UNLOCK (connection);
5087 /* Callback outside the lock */
5089 (*old_free_data) (old_data);
5093 * Get the UNIX file descriptor of the connection, if any. This can
5094 * be used for SELinux access control checks with getpeercon() for
5095 * example. DO NOT read or write to the file descriptor, or try to
5096 * select() on it; use DBusWatch for main loop integration. Not all
5097 * connections will have a file descriptor. So for adding descriptors
5098 * to the main loop, use dbus_watch_get_unix_fd() and so forth.
5100 * If the connection is socket-based, you can also use
5101 * dbus_connection_get_socket(), which will work on Windows too.
5102 * This function always fails on Windows.
5104 * Right now the returned descriptor is always a socket, but
5105 * that is not guaranteed.
5107 * @param connection the connection
5108 * @param fd return location for the file descriptor.
5109 * @returns #TRUE if fd is successfully obtained.
5112 dbus_connection_get_unix_fd (DBusConnection *connection,
5115 _dbus_return_val_if_fail (connection != NULL, FALSE);
5116 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5119 /* FIXME do this on a lower level */
5123 return dbus_connection_get_socket(connection, fd);
5127 * Gets the underlying Windows or UNIX socket file descriptor
5128 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
5129 * select() on it; use DBusWatch for main loop integration. Not all
5130 * connections will have a socket. So for adding descriptors
5131 * to the main loop, use dbus_watch_get_socket() and so forth.
5133 * If the connection is not socket-based, this function will return FALSE,
5134 * even if the connection does have a file descriptor of some kind.
5135 * i.e. this function always returns specifically a socket file descriptor.
5137 * @param connection the connection
5138 * @param fd return location for the file descriptor.
5139 * @returns #TRUE if fd is successfully obtained.
5142 dbus_connection_get_socket(DBusConnection *connection,
5147 _dbus_return_val_if_fail (connection != NULL, FALSE);
5148 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5150 CONNECTION_LOCK (connection);
5152 retval = _dbus_transport_get_socket_fd (connection->transport,
5155 CONNECTION_UNLOCK (connection);
5162 * Gets the UNIX user ID of the connection if known. Returns #TRUE if
5163 * the uid is filled in. Always returns #FALSE on non-UNIX platforms
5164 * for now, though in theory someone could hook Windows to NIS or
5165 * something. Always returns #FALSE prior to authenticating the
5168 * The UID is only read by servers from clients; clients can't usually
5169 * get the UID of servers, because servers do not authenticate to
5170 * clients. The returned UID is the UID the connection authenticated
5173 * The message bus is a server and the apps connecting to the bus
5176 * You can ask the bus to tell you the UID of another connection though
5177 * if you like; this is done with dbus_bus_get_unix_user().
5179 * @param connection the connection
5180 * @param uid return location for the user ID
5181 * @returns #TRUE if uid is filled in with a valid user ID
5184 dbus_connection_get_unix_user (DBusConnection *connection,
5189 _dbus_return_val_if_fail (connection != NULL, FALSE);
5190 _dbus_return_val_if_fail (uid != NULL, FALSE);
5192 CONNECTION_LOCK (connection);
5194 if (!_dbus_transport_try_to_authenticate (connection->transport))
5197 result = _dbus_transport_get_unix_user (connection->transport,
5201 _dbus_assert (!result);
5204 CONNECTION_UNLOCK (connection);
5210 * Gets the process ID of the connection if any.
5211 * Returns #TRUE if the pid is filled in.
5212 * Always returns #FALSE prior to authenticating the
5215 * @param connection the connection
5216 * @param pid return location for the process ID
5217 * @returns #TRUE if uid is filled in with a valid process ID
5220 dbus_connection_get_unix_process_id (DBusConnection *connection,
5225 _dbus_return_val_if_fail (connection != NULL, FALSE);
5226 _dbus_return_val_if_fail (pid != NULL, FALSE);
5228 CONNECTION_LOCK (connection);
5230 if (!_dbus_transport_try_to_authenticate (connection->transport))
5233 result = _dbus_transport_get_unix_process_id (connection->transport,
5236 CONNECTION_UNLOCK (connection);
5242 * Gets the ADT audit data of the connection if any.
5243 * Returns #TRUE if the structure pointer is returned.
5244 * Always returns #FALSE prior to authenticating the
5247 * @param connection the connection
5248 * @param data return location for audit data
5249 * @param data_size return location for length of audit data
5250 * @returns #TRUE if audit data is filled in with a valid ucred pointer
5253 dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
5255 dbus_int32_t *data_size)
5259 _dbus_return_val_if_fail (connection != NULL, FALSE);
5260 _dbus_return_val_if_fail (data != NULL, FALSE);
5261 _dbus_return_val_if_fail (data_size != NULL, FALSE);
5263 CONNECTION_LOCK (connection);
5265 if (!_dbus_transport_try_to_authenticate (connection->transport))
5268 result = _dbus_transport_get_adt_audit_session_data (connection->transport,
5271 CONNECTION_UNLOCK (connection);
5277 * Sets a predicate function used to determine whether a given user ID
5278 * is allowed to connect. When an incoming connection has
5279 * authenticated with a particular user ID, this function is called;
5280 * if it returns #TRUE, the connection is allowed to proceed,
5281 * otherwise the connection is disconnected.
5283 * If the function is set to #NULL (as it is by default), then
5284 * only the same UID as the server process will be allowed to
5285 * connect. Also, root is always allowed to connect.
5287 * On Windows, the function will be set and its free_data_function will
5288 * be invoked when the connection is freed or a new function is set.
5289 * However, the function will never be called, because there are
5290 * no UNIX user ids to pass to it, or at least none of the existing
5291 * auth protocols would allow authenticating as a UNIX user on Windows.
5293 * @param connection the connection
5294 * @param function the predicate
5295 * @param data data to pass to the predicate
5296 * @param free_data_function function to free the data
5299 dbus_connection_set_unix_user_function (DBusConnection *connection,
5300 DBusAllowUnixUserFunction function,
5302 DBusFreeFunction free_data_function)
5304 void *old_data = NULL;
5305 DBusFreeFunction old_free_function = NULL;
5307 _dbus_return_if_fail (connection != NULL);
5309 CONNECTION_LOCK (connection);
5310 _dbus_transport_set_unix_user_function (connection->transport,
5311 function, data, free_data_function,
5312 &old_data, &old_free_function);
5313 CONNECTION_UNLOCK (connection);
5315 if (old_free_function != NULL)
5316 (* old_free_function) (old_data);
5320 * Gets the Windows user SID of the connection if known. Returns
5321 * #TRUE if the ID is filled in. Always returns #FALSE on non-Windows
5322 * platforms for now, though in theory someone could hook UNIX to
5323 * Active Directory or something. Always returns #FALSE prior to
5324 * authenticating the connection.
5326 * The user is only read by servers from clients; clients can't usually
5327 * get the user of servers, because servers do not authenticate to
5328 * clients. The returned user is the user the connection authenticated
5331 * The message bus is a server and the apps connecting to the bus
5334 * The returned user string has to be freed with dbus_free().
5336 * The return value indicates whether the user SID is available;
5337 * if it's available but we don't have the memory to copy it,
5338 * then the return value is #TRUE and #NULL is given as the SID.
5340 * @todo We would like to be able to say "You can ask the bus to tell
5341 * you the user of another connection though if you like; this is done
5342 * with dbus_bus_get_windows_user()." But this has to be implemented
5343 * in bus/driver.c and dbus/dbus-bus.c, and is pointless anyway
5344 * since on Windows we only use the session bus for now.
5346 * @param connection the connection
5347 * @param windows_sid_p return location for an allocated copy of the user ID, or #NULL if no memory
5348 * @returns #TRUE if user is available (returned value may be #NULL anyway if no memory)
5351 dbus_connection_get_windows_user (DBusConnection *connection,
5352 char **windows_sid_p)
5356 _dbus_return_val_if_fail (connection != NULL, FALSE);
5357 _dbus_return_val_if_fail (windows_sid_p != NULL, FALSE);
5359 CONNECTION_LOCK (connection);
5361 if (!_dbus_transport_try_to_authenticate (connection->transport))
5364 result = _dbus_transport_get_windows_user (connection->transport,
5368 _dbus_assert (!result);
5371 CONNECTION_UNLOCK (connection);
5377 * Sets a predicate function used to determine whether a given user ID
5378 * is allowed to connect. When an incoming connection has
5379 * authenticated with a particular user ID, this function is called;
5380 * if it returns #TRUE, the connection is allowed to proceed,
5381 * otherwise the connection is disconnected.
5383 * If the function is set to #NULL (as it is by default), then
5384 * only the same user owning the server process will be allowed to
5387 * On UNIX, the function will be set and its free_data_function will
5388 * be invoked when the connection is freed or a new function is set.
5389 * However, the function will never be called, because there is no
5390 * way right now to authenticate as a Windows user on UNIX.
5392 * @param connection the connection
5393 * @param function the predicate
5394 * @param data data to pass to the predicate
5395 * @param free_data_function function to free the data
5398 dbus_connection_set_windows_user_function (DBusConnection *connection,
5399 DBusAllowWindowsUserFunction function,
5401 DBusFreeFunction free_data_function)
5403 void *old_data = NULL;
5404 DBusFreeFunction old_free_function = NULL;
5406 _dbus_return_if_fail (connection != NULL);
5408 CONNECTION_LOCK (connection);
5409 _dbus_transport_set_windows_user_function (connection->transport,
5410 function, data, free_data_function,
5411 &old_data, &old_free_function);
5412 CONNECTION_UNLOCK (connection);
5414 if (old_free_function != NULL)
5415 (* old_free_function) (old_data);
5419 * This function must be called on the server side of a connection when the
5420 * connection is first seen in the #DBusNewConnectionFunction. If set to
5421 * #TRUE (the default is #FALSE), then the connection can proceed even if
5422 * the client does not authenticate as some user identity, i.e. clients
5423 * can connect anonymously.
5425 * This setting interacts with the available authorization mechanisms
5426 * (see dbus_server_set_auth_mechanisms()). Namely, an auth mechanism
5427 * such as ANONYMOUS that supports anonymous auth must be included in
5428 * the list of available mechanisms for anonymous login to work.
5430 * This setting also changes the default rule for connections
5431 * authorized as a user; normally, if a connection authorizes as
5432 * a user identity, it is permitted if the user identity is
5433 * root or the user identity matches the user identity of the server
5434 * process. If anonymous connections are allowed, however,
5435 * then any user identity is allowed.
5437 * You can override the rules for connections authorized as a
5438 * user identity with dbus_connection_set_unix_user_function()
5439 * and dbus_connection_set_windows_user_function().
5441 * @param connection the connection
5442 * @param value whether to allow authentication as an anonymous user
5445 dbus_connection_set_allow_anonymous (DBusConnection *connection,
5448 _dbus_return_if_fail (connection != NULL);
5450 CONNECTION_LOCK (connection);
5451 _dbus_transport_set_allow_anonymous (connection->transport, value);
5452 CONNECTION_UNLOCK (connection);
5457 * Normally #DBusConnection automatically handles all messages to the
5458 * org.freedesktop.DBus.Peer interface. However, the message bus wants
5459 * to be able to route methods on that interface through the bus and
5460 * to other applications. If routing peer messages is enabled, then
5461 * messages with the org.freedesktop.DBus.Peer interface that also
5462 * have a bus destination name set will not be automatically
5463 * handled by the #DBusConnection and instead will be dispatched
5464 * normally to the application.
5466 * If a normal application sets this flag, it can break things badly.
5467 * So don't set this unless you are the message bus.
5469 * @param connection the connection
5470 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
5473 dbus_connection_set_route_peer_messages (DBusConnection *connection,
5476 _dbus_return_if_fail (connection != NULL);
5478 CONNECTION_LOCK (connection);
5479 connection->route_peer_messages = TRUE;
5480 CONNECTION_UNLOCK (connection);
5484 * Adds a message filter. Filters are handlers that are run on all
5485 * incoming messages, prior to the objects registered with
5486 * dbus_connection_register_object_path(). Filters are run in the
5487 * order that they were added. The same handler can be added as a
5488 * filter more than once, in which case it will be run more than once.
5489 * Filters added during a filter callback won't be run on the message
5492 * @todo we don't run filters on messages while blocking without
5493 * entering the main loop, since filters are run as part of
5494 * dbus_connection_dispatch(). This is probably a feature, as filters
5495 * could create arbitrary reentrancy. But kind of sucks if you're
5496 * trying to filter METHOD_RETURN for some reason.
5498 * @param connection the connection
5499 * @param function function to handle messages
5500 * @param user_data user data to pass to the function
5501 * @param free_data_function function to use for freeing user data
5502 * @returns #TRUE on success, #FALSE if not enough memory.
5505 dbus_connection_add_filter (DBusConnection *connection,
5506 DBusHandleMessageFunction function,
5508 DBusFreeFunction free_data_function)
5510 DBusMessageFilter *filter;
5512 _dbus_return_val_if_fail (connection != NULL, FALSE);
5513 _dbus_return_val_if_fail (function != NULL, FALSE);
5515 filter = dbus_new0 (DBusMessageFilter, 1);
5519 _dbus_atomic_inc (&filter->refcount);
5521 CONNECTION_LOCK (connection);
5523 if (!_dbus_list_append (&connection->filter_list,
5526 _dbus_message_filter_unref (filter);
5527 CONNECTION_UNLOCK (connection);
5531 /* Fill in filter after all memory allocated,
5532 * so we don't run the free_user_data_function
5533 * if the add_filter() fails
5536 filter->function = function;
5537 filter->user_data = user_data;
5538 filter->free_user_data_function = free_data_function;
5540 CONNECTION_UNLOCK (connection);
5545 * Removes a previously-added message filter. It is a programming
5546 * error to call this function for a handler that has not been added
5547 * as a filter. If the given handler was added more than once, only
5548 * one instance of it will be removed (the most recently-added
5551 * @param connection the connection
5552 * @param function the handler to remove
5553 * @param user_data user data for the handler to remove
5557 dbus_connection_remove_filter (DBusConnection *connection,
5558 DBusHandleMessageFunction function,
5562 DBusMessageFilter *filter;
5564 _dbus_return_if_fail (connection != NULL);
5565 _dbus_return_if_fail (function != NULL);
5567 CONNECTION_LOCK (connection);
5571 link = _dbus_list_get_last_link (&connection->filter_list);
5572 while (link != NULL)
5574 filter = link->data;
5576 if (filter->function == function &&
5577 filter->user_data == user_data)
5579 _dbus_list_remove_link (&connection->filter_list, link);
5580 filter->function = NULL;
5585 link = _dbus_list_get_prev_link (&connection->filter_list, link);
5589 CONNECTION_UNLOCK (connection);
5591 #ifndef DBUS_DISABLE_CHECKS
5594 _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5595 function, user_data);
5600 /* Call application code */
5601 if (filter->free_user_data_function)
5602 (* filter->free_user_data_function) (filter->user_data);
5604 filter->free_user_data_function = NULL;
5605 filter->user_data = NULL;
5607 _dbus_message_filter_unref (filter);
5611 * Registers a handler for a given path or subsection in the object
5612 * hierarchy. The given vtable handles messages sent to exactly the
5613 * given path or also for paths bellow that, depending on fallback
5616 * @param connection the connection
5617 * @param fallback whether to handle messages also for "subdirectory"
5618 * @param path a '/' delimited string of path elements
5619 * @param vtable the virtual table
5620 * @param user_data data to pass to functions in the vtable
5621 * @param error address where an error can be returned
5622 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5623 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5626 _dbus_connection_register_object_path (DBusConnection *connection,
5627 dbus_bool_t fallback,
5629 const DBusObjectPathVTable *vtable,
5633 char **decomposed_path;
5636 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5639 CONNECTION_LOCK (connection);
5641 retval = _dbus_object_tree_register (connection->objects,
5643 (const char **) decomposed_path, vtable,
5646 CONNECTION_UNLOCK (connection);
5648 dbus_free_string_array (decomposed_path);
5654 * Registers a handler for a given path in the object hierarchy.
5655 * The given vtable handles messages sent to exactly the given path.
5657 * @param connection the connection
5658 * @param path a '/' delimited string of path elements
5659 * @param vtable the virtual table
5660 * @param user_data data to pass to functions in the vtable
5661 * @param error address where an error can be returned
5662 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5663 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5666 dbus_connection_try_register_object_path (DBusConnection *connection,
5668 const DBusObjectPathVTable *vtable,
5672 _dbus_return_val_if_fail (connection != NULL, FALSE);
5673 _dbus_return_val_if_fail (path != NULL, FALSE);
5674 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5675 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5677 return _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, error);
5681 * Registers a handler for a given path in the object hierarchy.
5682 * The given vtable handles messages sent to exactly the given path.
5684 * It is a bug to call this function for object paths which already
5685 * have a handler. Use dbus_connection_try_register_object_path() if this
5686 * might be the case.
5688 * @param connection the connection
5689 * @param path a '/' delimited string of path elements
5690 * @param vtable the virtual table
5691 * @param user_data data to pass to functions in the vtable
5692 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5693 * #DBUS_ERROR_OBJECT_PATH_IN_USE) ocurred
5696 dbus_connection_register_object_path (DBusConnection *connection,
5698 const DBusObjectPathVTable *vtable,
5702 DBusError error = DBUS_ERROR_INIT;
5704 _dbus_return_val_if_fail (connection != NULL, FALSE);
5705 _dbus_return_val_if_fail (path != NULL, FALSE);
5706 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5707 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5709 retval = _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, &error);
5711 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5713 _dbus_warn ("%s\n", error.message);
5714 dbus_error_free (&error);
5722 * Registers a fallback handler for a given subsection of the object
5723 * hierarchy. The given vtable handles messages at or below the given
5724 * path. You can use this to establish a default message handling
5725 * policy for a whole "subdirectory."
5727 * @param connection the connection
5728 * @param path a '/' delimited string of path elements
5729 * @param vtable the virtual table
5730 * @param user_data data to pass to functions in the vtable
5731 * @param error address where an error can be returned
5732 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5733 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5736 dbus_connection_try_register_fallback (DBusConnection *connection,
5738 const DBusObjectPathVTable *vtable,
5742 _dbus_return_val_if_fail (connection != NULL, FALSE);
5743 _dbus_return_val_if_fail (path != NULL, FALSE);
5744 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5745 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5747 return _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, error);
5751 * Registers a fallback handler for a given subsection of the object
5752 * hierarchy. The given vtable handles messages at or below the given
5753 * path. You can use this to establish a default message handling
5754 * policy for a whole "subdirectory."
5756 * It is a bug to call this function for object paths which already
5757 * have a handler. Use dbus_connection_try_register_fallback() if this
5758 * might be the case.
5760 * @param connection the connection
5761 * @param path a '/' delimited string of path elements
5762 * @param vtable the virtual table
5763 * @param user_data data to pass to functions in the vtable
5764 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5765 * #DBUS_ERROR_OBJECT_PATH_IN_USE) occured
5768 dbus_connection_register_fallback (DBusConnection *connection,
5770 const DBusObjectPathVTable *vtable,
5774 DBusError error = DBUS_ERROR_INIT;
5776 _dbus_return_val_if_fail (connection != NULL, FALSE);
5777 _dbus_return_val_if_fail (path != NULL, FALSE);
5778 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5779 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5781 retval = _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, &error);
5783 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5785 _dbus_warn ("%s\n", error.message);
5786 dbus_error_free (&error);
5794 * Unregisters the handler registered with exactly the given path.
5795 * It's a bug to call this function for a path that isn't registered.
5796 * Can unregister both fallback paths and object paths.
5798 * @param connection the connection
5799 * @param path a '/' delimited string of path elements
5800 * @returns #FALSE if not enough memory
5803 dbus_connection_unregister_object_path (DBusConnection *connection,
5806 char **decomposed_path;
5808 _dbus_return_val_if_fail (connection != NULL, FALSE);
5809 _dbus_return_val_if_fail (path != NULL, FALSE);
5810 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5812 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5815 CONNECTION_LOCK (connection);
5817 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5819 dbus_free_string_array (decomposed_path);
5825 * Gets the user data passed to dbus_connection_register_object_path()
5826 * or dbus_connection_register_fallback(). If nothing was registered
5827 * at this path, the data is filled in with #NULL.
5829 * @param connection the connection
5830 * @param path the path you registered with
5831 * @param data_p location to store the user data, or #NULL
5832 * @returns #FALSE if not enough memory
5835 dbus_connection_get_object_path_data (DBusConnection *connection,
5839 char **decomposed_path;
5841 _dbus_return_val_if_fail (connection != NULL, FALSE);
5842 _dbus_return_val_if_fail (path != NULL, FALSE);
5843 _dbus_return_val_if_fail (data_p != NULL, FALSE);
5847 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5850 CONNECTION_LOCK (connection);
5852 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5854 CONNECTION_UNLOCK (connection);
5856 dbus_free_string_array (decomposed_path);
5862 * Lists the registered fallback handlers and object path handlers at
5863 * the given parent_path. The returned array should be freed with
5864 * dbus_free_string_array().
5866 * @param connection the connection
5867 * @param parent_path the path to list the child handlers of
5868 * @param child_entries returns #NULL-terminated array of children
5869 * @returns #FALSE if no memory to allocate the child entries
5872 dbus_connection_list_registered (DBusConnection *connection,
5873 const char *parent_path,
5874 char ***child_entries)
5876 char **decomposed_path;
5878 _dbus_return_val_if_fail (connection != NULL, FALSE);
5879 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5880 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5881 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5883 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5886 CONNECTION_LOCK (connection);
5888 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5889 (const char **) decomposed_path,
5891 dbus_free_string_array (decomposed_path);
5896 static DBusDataSlotAllocator slot_allocator =
5897 _DBUS_DATA_SLOT_ALLOCATOR_INIT (_DBUS_LOCK_NAME (connection_slots));
5900 * Allocates an integer ID to be used for storing application-specific
5901 * data on any DBusConnection. The allocated ID may then be used
5902 * with dbus_connection_set_data() and dbus_connection_get_data().
5903 * The passed-in slot must be initialized to -1, and is filled in
5904 * with the slot ID. If the passed-in slot is not -1, it's assumed
5905 * to be already allocated, and its refcount is incremented.
5907 * The allocated slot is global, i.e. all DBusConnection objects will
5908 * have a slot with the given integer ID reserved.
5910 * @param slot_p address of a global variable storing the slot
5911 * @returns #FALSE on failure (no memory)
5914 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5916 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5921 * Deallocates a global ID for connection data slots.
5922 * dbus_connection_get_data() and dbus_connection_set_data() may no
5923 * longer be used with this slot. Existing data stored on existing
5924 * DBusConnection objects will be freed when the connection is
5925 * finalized, but may not be retrieved (and may only be replaced if
5926 * someone else reallocates the slot). When the refcount on the
5927 * passed-in slot reaches 0, it is set to -1.
5929 * @param slot_p address storing the slot to deallocate
5932 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5934 _dbus_return_if_fail (*slot_p >= 0);
5936 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5940 * Stores a pointer on a DBusConnection, along
5941 * with an optional function to be used for freeing
5942 * the data when the data is set again, or when
5943 * the connection is finalized. The slot number
5944 * must have been allocated with dbus_connection_allocate_data_slot().
5946 * @note This function does not take the
5947 * main thread lock on DBusConnection, which allows it to be
5948 * used from inside watch and timeout functions. (See the
5949 * note in docs for dbus_connection_set_watch_functions().)
5950 * A side effect of this is that you need to know there's
5951 * a reference held on the connection while invoking
5952 * dbus_connection_set_data(), or the connection could be
5953 * finalized during dbus_connection_set_data().
5955 * @param connection the connection
5956 * @param slot the slot number
5957 * @param data the data to store
5958 * @param free_data_func finalizer function for the data
5959 * @returns #TRUE if there was enough memory to store the data
5962 dbus_connection_set_data (DBusConnection *connection,
5965 DBusFreeFunction free_data_func)
5967 DBusFreeFunction old_free_func;
5971 _dbus_return_val_if_fail (connection != NULL, FALSE);
5972 _dbus_return_val_if_fail (slot >= 0, FALSE);
5974 SLOTS_LOCK (connection);
5976 retval = _dbus_data_slot_list_set (&slot_allocator,
5977 &connection->slot_list,
5978 slot, data, free_data_func,
5979 &old_free_func, &old_data);
5981 SLOTS_UNLOCK (connection);
5985 /* Do the actual free outside the connection lock */
5987 (* old_free_func) (old_data);
5994 * Retrieves data previously set with dbus_connection_set_data().
5995 * The slot must still be allocated (must not have been freed).
5997 * @note This function does not take the
5998 * main thread lock on DBusConnection, which allows it to be
5999 * used from inside watch and timeout functions. (See the
6000 * note in docs for dbus_connection_set_watch_functions().)
6001 * A side effect of this is that you need to know there's
6002 * a reference held on the connection while invoking
6003 * dbus_connection_get_data(), or the connection could be
6004 * finalized during dbus_connection_get_data().
6006 * @param connection the connection
6007 * @param slot the slot to get data from
6008 * @returns the data, or #NULL if not found
6011 dbus_connection_get_data (DBusConnection *connection,
6016 _dbus_return_val_if_fail (connection != NULL, NULL);
6017 _dbus_return_val_if_fail (slot >= 0, NULL);
6019 SLOTS_LOCK (connection);
6021 res = _dbus_data_slot_list_get (&slot_allocator,
6022 &connection->slot_list,
6025 SLOTS_UNLOCK (connection);
6031 * This function sets a global flag for whether dbus_connection_new()
6032 * will set SIGPIPE behavior to SIG_IGN.
6034 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
6037 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
6039 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
6043 * Specifies the maximum size message this connection is allowed to
6044 * receive. Larger messages will result in disconnecting the
6047 * @param connection a #DBusConnection
6048 * @param size maximum message size the connection can receive, in bytes
6051 dbus_connection_set_max_message_size (DBusConnection *connection,
6054 _dbus_return_if_fail (connection != NULL);
6056 CONNECTION_LOCK (connection);
6057 _dbus_transport_set_max_message_size (connection->transport,
6059 CONNECTION_UNLOCK (connection);
6063 * Gets the value set by dbus_connection_set_max_message_size().
6065 * @param connection the connection
6066 * @returns the max size of a single message
6069 dbus_connection_get_max_message_size (DBusConnection *connection)
6073 _dbus_return_val_if_fail (connection != NULL, 0);
6075 CONNECTION_LOCK (connection);
6076 res = _dbus_transport_get_max_message_size (connection->transport);
6077 CONNECTION_UNLOCK (connection);
6082 * Specifies the maximum number of unix fds a message on this
6083 * connection is allowed to receive. Messages with more unix fds will
6084 * result in disconnecting the connection.
6086 * @param connection a #DBusConnection
6087 * @param n maximum message unix fds the connection can receive
6090 dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
6093 _dbus_return_if_fail (connection != NULL);
6095 CONNECTION_LOCK (connection);
6096 _dbus_transport_set_max_message_unix_fds (connection->transport,
6098 CONNECTION_UNLOCK (connection);
6102 * Gets the value set by dbus_connection_set_max_message_unix_fds().
6104 * @param connection the connection
6105 * @returns the max numer of unix fds of a single message
6108 dbus_connection_get_max_message_unix_fds (DBusConnection *connection)
6112 _dbus_return_val_if_fail (connection != NULL, 0);
6114 CONNECTION_LOCK (connection);
6115 res = _dbus_transport_get_max_message_unix_fds (connection->transport);
6116 CONNECTION_UNLOCK (connection);
6121 * Sets the maximum total number of bytes that can be used for all messages
6122 * received on this connection. Messages count toward the maximum until
6123 * they are finalized. When the maximum is reached, the connection will
6124 * not read more data until some messages are finalized.
6126 * The semantics of the maximum are: if outstanding messages are
6127 * already above the maximum, additional messages will not be read.
6128 * The semantics are not: if the next message would cause us to exceed
6129 * the maximum, we don't read it. The reason is that we don't know the
6130 * size of a message until after we read it.
6132 * Thus, the max live messages size can actually be exceeded
6133 * by up to the maximum size of a single message.
6135 * Also, if we read say 1024 bytes off the wire in a single read(),
6136 * and that contains a half-dozen small messages, we may exceed the
6137 * size max by that amount. But this should be inconsequential.
6139 * This does imply that we can't call read() with a buffer larger
6140 * than we're willing to exceed this limit by.
6142 * @param connection the connection
6143 * @param size the maximum size in bytes of all outstanding messages
6146 dbus_connection_set_max_received_size (DBusConnection *connection,
6149 _dbus_return_if_fail (connection != NULL);
6151 CONNECTION_LOCK (connection);
6152 _dbus_transport_set_max_received_size (connection->transport,
6154 CONNECTION_UNLOCK (connection);
6158 * Gets the value set by dbus_connection_set_max_received_size().
6160 * @param connection the connection
6161 * @returns the max size of all live messages
6164 dbus_connection_get_max_received_size (DBusConnection *connection)
6168 _dbus_return_val_if_fail (connection != NULL, 0);
6170 CONNECTION_LOCK (connection);
6171 res = _dbus_transport_get_max_received_size (connection->transport);
6172 CONNECTION_UNLOCK (connection);
6177 * Sets the maximum total number of unix fds that can be used for all messages
6178 * received on this connection. Messages count toward the maximum until
6179 * they are finalized. When the maximum is reached, the connection will
6180 * not read more data until some messages are finalized.
6182 * The semantics are analogous to those of dbus_connection_set_max_received_size().
6184 * @param connection the connection
6185 * @param n the maximum size in bytes of all outstanding messages
6188 dbus_connection_set_max_received_unix_fds (DBusConnection *connection,
6191 _dbus_return_if_fail (connection != NULL);
6193 CONNECTION_LOCK (connection);
6194 _dbus_transport_set_max_received_unix_fds (connection->transport,
6196 CONNECTION_UNLOCK (connection);
6200 * Gets the value set by dbus_connection_set_max_received_unix_fds().
6202 * @param connection the connection
6203 * @returns the max unix fds of all live messages
6206 dbus_connection_get_max_received_unix_fds (DBusConnection *connection)
6210 _dbus_return_val_if_fail (connection != NULL, 0);
6212 CONNECTION_LOCK (connection);
6213 res = _dbus_transport_get_max_received_unix_fds (connection->transport);
6214 CONNECTION_UNLOCK (connection);
6219 * Gets the approximate size in bytes of all messages in the outgoing
6220 * message queue. The size is approximate in that you shouldn't use
6221 * it to decide how many bytes to read off the network or anything
6222 * of that nature, as optimizations may choose to tell small white lies
6223 * to avoid performance overhead.
6225 * @param connection the connection
6226 * @returns the number of bytes that have been queued up but not sent
6229 dbus_connection_get_outgoing_size (DBusConnection *connection)
6233 _dbus_return_val_if_fail (connection != NULL, 0);
6235 CONNECTION_LOCK (connection);
6236 res = _dbus_counter_get_size_value (connection->outgoing_counter);
6237 CONNECTION_UNLOCK (connection);
6241 #ifdef DBUS_ENABLE_STATS
6243 _dbus_connection_get_stats (DBusConnection *connection,
6244 dbus_uint32_t *in_messages,
6245 dbus_uint32_t *in_bytes,
6246 dbus_uint32_t *in_fds,
6247 dbus_uint32_t *in_peak_bytes,
6248 dbus_uint32_t *in_peak_fds,
6249 dbus_uint32_t *out_messages,
6250 dbus_uint32_t *out_bytes,
6251 dbus_uint32_t *out_fds,
6252 dbus_uint32_t *out_peak_bytes,
6253 dbus_uint32_t *out_peak_fds)
6255 CONNECTION_LOCK (connection);
6257 if (in_messages != NULL)
6258 *in_messages = connection->n_incoming;
6260 _dbus_transport_get_stats (connection->transport,
6261 in_bytes, in_fds, in_peak_bytes, in_peak_fds);
6263 if (out_messages != NULL)
6264 *out_messages = connection->n_outgoing;
6266 if (out_bytes != NULL)
6267 *out_bytes = _dbus_counter_get_size_value (connection->outgoing_counter);
6269 if (out_fds != NULL)
6270 *out_fds = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6272 if (out_peak_bytes != NULL)
6273 *out_peak_bytes = _dbus_counter_get_peak_size_value (connection->outgoing_counter);
6275 if (out_peak_fds != NULL)
6276 *out_peak_fds = _dbus_counter_get_peak_unix_fd_value (connection->outgoing_counter);
6278 CONNECTION_UNLOCK (connection);
6280 #endif /* DBUS_ENABLE_STATS */
6283 * Gets the approximate number of uni fds of all messages in the
6284 * outgoing message queue.
6286 * @param connection the connection
6287 * @returns the number of unix fds that have been queued up but not sent
6290 dbus_connection_get_outgoing_unix_fds (DBusConnection *connection)
6294 _dbus_return_val_if_fail (connection != NULL, 0);
6296 CONNECTION_LOCK (connection);
6297 res = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6298 CONNECTION_UNLOCK (connection);
6303 * Returns the address of the transport object of this connection
6305 * @param connection the connection
6306 * @returns the address string
6309 _dbus_connection_get_address (DBusConnection *connection)
6311 return _dbus_transport_get_address (connection->transport);
6315 dbus_connection_get_transport(DBusConnection *connection)
6317 _dbus_return_val_if_fail (connection != NULL, NULL);
6319 return connection->transport;