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"
48 #ifdef DBUS_DISABLE_CHECKS
49 #define TOOK_LOCK_CHECK(connection)
50 #define RELEASING_LOCK_CHECK(connection)
51 #define HAVE_LOCK_CHECK(connection)
53 #define TOOK_LOCK_CHECK(connection) do { \
54 _dbus_assert (!(connection)->have_connection_lock); \
55 (connection)->have_connection_lock = TRUE; \
57 #define RELEASING_LOCK_CHECK(connection) do { \
58 _dbus_assert ((connection)->have_connection_lock); \
59 (connection)->have_connection_lock = FALSE; \
61 #define HAVE_LOCK_CHECK(connection) _dbus_assert ((connection)->have_connection_lock)
62 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
67 #define CONNECTION_LOCK(connection) do { \
68 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
69 _dbus_rmutex_lock ((connection)->mutex); \
70 TOOK_LOCK_CHECK (connection); \
73 #define CONNECTION_UNLOCK(connection) _dbus_connection_unlock (connection)
75 #define SLOTS_LOCK(connection) do { \
76 _dbus_rmutex_lock ((connection)->slot_mutex); \
79 #define SLOTS_UNLOCK(connection) do { \
80 _dbus_rmutex_unlock ((connection)->slot_mutex); \
83 #define DISPATCH_STATUS_NAME(s) \
84 ((s) == DBUS_DISPATCH_COMPLETE ? "complete" : \
85 (s) == DBUS_DISPATCH_DATA_REMAINS ? "data remains" : \
86 (s) == DBUS_DISPATCH_NEED_MEMORY ? "need memory" : \
90 * @defgroup DBusConnection DBusConnection
92 * @brief Connection to another application
94 * A DBusConnection represents a connection to another
95 * application. Messages can be sent and received via this connection.
96 * The other application may be a message bus; for convenience, the
97 * function dbus_bus_get() is provided to automatically open a
98 * connection to the well-known message buses.
100 * In brief a DBusConnection is a message queue associated with some
101 * message transport mechanism such as a socket. The connection
102 * maintains a queue of incoming messages and a queue of outgoing
105 * Several functions use the following terms:
107 * <li><b>read</b> means to fill the incoming message queue by reading from the socket</li>
108 * <li><b>write</b> means to drain the outgoing queue by writing to the socket</li>
109 * <li><b>dispatch</b> means to drain the incoming queue by invoking application-provided message handlers</li>
112 * The function dbus_connection_read_write_dispatch() for example does all
113 * three of these things, offering a simple alternative to a main loop.
115 * In an application with a main loop, the read/write/dispatch
116 * operations are usually separate.
118 * The connection provides #DBusWatch and #DBusTimeout objects to
119 * the main loop. These are used to know when reading, writing, or
120 * dispatching should be performed.
122 * Incoming messages are processed
123 * by calling dbus_connection_dispatch(). dbus_connection_dispatch()
124 * runs any handlers registered for the topmost message in the message
125 * queue, then discards the message, then returns.
127 * dbus_connection_get_dispatch_status() indicates whether
128 * messages are currently in the queue that need dispatching.
129 * dbus_connection_set_dispatch_status_function() allows
130 * you to set a function to be used to monitor the dispatch status.
132 * If you're using GLib or Qt add-on libraries for D-Bus, there are
133 * special convenience APIs in those libraries that hide
134 * all the details of dispatch and watch/timeout monitoring.
135 * For example, dbus_connection_setup_with_g_main().
137 * If you aren't using these add-on libraries, but want to process
138 * messages asynchronously, you must manually call
139 * dbus_connection_set_dispatch_status_function(),
140 * dbus_connection_set_watch_functions(),
141 * dbus_connection_set_timeout_functions() providing appropriate
142 * functions to integrate the connection with your application's main
143 * loop. This can be tricky to get right; main loops are not simple.
145 * If you don't need to be asynchronous, you can ignore #DBusWatch,
146 * #DBusTimeout, and dbus_connection_dispatch(). Instead,
147 * dbus_connection_read_write_dispatch() can be used.
149 * Or, in <em>very</em> simple applications,
150 * dbus_connection_pop_message() may be all you need, allowing you to
151 * avoid setting up any handler functions (see
152 * dbus_connection_add_filter(),
153 * dbus_connection_register_object_path() for more on handlers).
155 * When you use dbus_connection_send() or one of its variants to send
156 * a message, the message is added to the outgoing queue. It's
157 * actually written to the network later; either in
158 * dbus_watch_handle() invoked by your main loop, or in
159 * dbus_connection_flush() which blocks until it can write out the
160 * entire outgoing queue. The GLib/Qt add-on libraries again
161 * handle the details here for you by setting up watch functions.
163 * When a connection is disconnected, you are guaranteed to get a
164 * signal "Disconnected" from the interface
165 * #DBUS_INTERFACE_LOCAL, path
168 * You may not drop the last reference to a #DBusConnection
169 * until that connection has been disconnected.
171 * You may dispatch the unprocessed incoming message queue even if the
172 * connection is disconnected. However, "Disconnected" will always be
173 * the last message in the queue (obviously no messages are received
174 * after disconnection).
176 * After calling dbus_threads_init(), #DBusConnection has thread
177 * locks and drops them when invoking user callbacks, so in general is
178 * transparently threadsafe. However, #DBusMessage does NOT have
179 * thread locks; you must not send the same message to multiple
180 * #DBusConnection if those connections will be used from different threads,
183 * Also, if you dispatch or pop messages from multiple threads, it
184 * may work in the sense that it won't crash, but it's tough to imagine
185 * sane results; it will be completely unpredictable which messages
186 * go to which threads.
188 * It's recommended to dispatch from a single thread.
190 * The most useful function to call from multiple threads at once
191 * is dbus_connection_send_with_reply_and_block(). That is,
192 * multiple threads can make method calls at the same time.
194 * If you aren't using threads, you can use a main loop and
195 * dbus_pending_call_set_notify() to achieve a similar result.
199 * @defgroup DBusConnectionInternals DBusConnection implementation details
200 * @ingroup DBusInternals
201 * @brief Implementation details of DBusConnection
207 _dbus_connection_trace_ref (DBusConnection *connection,
212 #ifdef DBUS_ENABLE_VERBOSE_MODE
213 static int enabled = -1;
215 _dbus_trace_ref ("DBusConnection", connection, old_refcount, new_refcount,
216 why, "DBUS_CONNECTION_TRACE", &enabled);
221 * Internal struct representing a message filter function
223 typedef struct DBusMessageFilter DBusMessageFilter;
226 * Internal struct representing a message filter function
228 struct DBusMessageFilter
230 DBusAtomic refcount; /**< Reference count */
231 DBusHandleMessageFunction function; /**< Function to call to filter */
232 void *user_data; /**< User data for the function */
233 DBusFreeFunction free_user_data_function; /**< Function to free the user data */
238 * Internals of DBusPreallocatedSend
240 struct DBusPreallocatedSend
242 DBusConnection *connection; /**< Connection we'd send the message to */
243 DBusList *queue_link; /**< Preallocated link in the queue */
244 DBusList *counter_link; /**< Preallocated link in the resource counter */
247 #if HAVE_DECL_MSG_NOSIGNAL
248 static dbus_bool_t _dbus_modify_sigpipe = FALSE;
250 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
254 * Implementation details of DBusConnection. All fields are private.
256 struct DBusConnection
258 DBusAtomic refcount; /**< Reference count. */
260 DBusRMutex *mutex; /**< Lock on the entire DBusConnection */
262 DBusCMutex *dispatch_mutex; /**< Protects dispatch_acquired */
263 DBusCondVar *dispatch_cond; /**< Notify when dispatch_acquired is available */
264 DBusCMutex *io_path_mutex; /**< Protects io_path_acquired */
265 DBusCondVar *io_path_cond; /**< Notify when io_path_acquired is available */
267 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
268 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
269 DBusList *expired_messages; /**< Messages that will be released when we next unlock. */
271 DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
272 * dispatch_acquired will be set by the borrower
275 int n_outgoing; /**< Length of outgoing queue. */
276 int n_incoming; /**< Length of incoming queue. */
278 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
280 DBusTransport *transport; /**< Object that sends/receives messages over network. */
281 DBusWatchList *watches; /**< Stores active watches. */
282 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
284 DBusList *filter_list; /**< List of filters. */
286 DBusRMutex *slot_mutex; /**< Lock on slot_list so overall connection lock need not be taken */
287 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
289 DBusHashTable *pending_replies; /**< Hash of message serials to #DBusPendingCall. */
291 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
292 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
294 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
295 void *wakeup_main_data; /**< Application data for wakeup_main_function */
296 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
298 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
299 void *dispatch_status_data; /**< Application data for dispatch_status_function */
300 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
302 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
304 DBusObjectTree *objects; /**< Object path handlers registered with this connection */
306 char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
308 /* These two MUST be bools and not bitfields, because they are protected by a separate lock
309 * from connection->mutex and all bitfields in a word have to be read/written together.
310 * So you can't have a different lock for different bitfields in the same word.
312 dbus_bool_t dispatch_acquired; /**< Someone has dispatch path (can drain incoming queue) */
313 dbus_bool_t io_path_acquired; /**< Someone has transport io path (can use the transport to read/write messages) */
315 unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
317 unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
319 unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
321 unsigned int disconnected_message_arrived : 1; /**< We popped or are dispatching the disconnected message.
322 * if the disconnect_message_link is NULL then we queued it, but
323 * this flag is whether it got to the head of the queue.
325 unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
326 * such as closing the connection.
329 #ifndef DBUS_DISABLE_CHECKS
330 unsigned int have_connection_lock : 1; /**< Used to check locking */
333 #if defined(DBUS_ENABLE_CHECKS) || defined(DBUS_ENABLE_ASSERT)
334 int generation; /**< _dbus_current_generation that should correspond to this connection */
338 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
339 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
340 DBusDispatchStatus new_status);
341 static void _dbus_connection_last_unref (DBusConnection *connection);
342 static void _dbus_connection_acquire_dispatch (DBusConnection *connection);
343 static void _dbus_connection_release_dispatch (DBusConnection *connection);
344 static DBusDispatchStatus _dbus_connection_flush_unlocked (DBusConnection *connection);
345 static void _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection);
346 static dbus_bool_t _dbus_connection_get_is_connected_unlocked (DBusConnection *connection);
347 static dbus_bool_t _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
348 dbus_uint32_t client_serial);
350 static DBusMessageFilter *
351 _dbus_message_filter_ref (DBusMessageFilter *filter)
353 #ifdef DBUS_DISABLE_ASSERT
354 _dbus_atomic_inc (&filter->refcount);
356 dbus_int32_t old_value;
358 old_value = _dbus_atomic_inc (&filter->refcount);
359 _dbus_assert (old_value > 0);
366 _dbus_message_filter_unref (DBusMessageFilter *filter)
368 dbus_int32_t old_value;
370 old_value = _dbus_atomic_dec (&filter->refcount);
371 _dbus_assert (old_value > 0);
375 if (filter->free_user_data_function)
376 (* filter->free_user_data_function) (filter->user_data);
383 * Acquires the connection lock.
385 * @param connection the connection.
388 _dbus_connection_lock (DBusConnection *connection)
390 CONNECTION_LOCK (connection);
394 * Releases the connection lock.
396 * @param connection the connection.
399 _dbus_connection_unlock (DBusConnection *connection)
401 DBusList *expired_messages;
406 _dbus_verbose ("UNLOCK\n");
409 /* If we had messages that expired (fell off the incoming or outgoing
410 * queues) while we were locked, actually release them now */
411 expired_messages = connection->expired_messages;
412 connection->expired_messages = NULL;
414 RELEASING_LOCK_CHECK (connection);
415 _dbus_rmutex_unlock (connection->mutex);
417 for (iter = _dbus_list_pop_first_link (&expired_messages);
419 iter = _dbus_list_pop_first_link (&expired_messages))
421 DBusMessage *message = iter->data;
423 dbus_message_unref (message);
424 _dbus_list_free_link (iter);
429 * Wakes up the main loop if it is sleeping
430 * Needed if we're e.g. queueing outgoing messages
431 * on a thread while the mainloop sleeps.
433 * @param connection the connection.
436 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
438 if (connection->wakeup_main_function)
439 (*connection->wakeup_main_function) (connection->wakeup_main_data);
442 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
444 * Gets the locks so we can examine them
446 * @param connection the connection.
447 * @param mutex_loc return for the location of the main mutex pointer
448 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
449 * @param io_path_mutex_loc return location of the io_path mutex pointer
450 * @param dispatch_cond_loc return location of the dispatch conditional
452 * @param io_path_cond_loc return location of the io_path conditional
456 _dbus_connection_test_get_locks (DBusConnection *connection,
457 DBusMutex **mutex_loc,
458 DBusMutex **dispatch_mutex_loc,
459 DBusMutex **io_path_mutex_loc,
460 DBusCondVar **dispatch_cond_loc,
461 DBusCondVar **io_path_cond_loc)
463 *mutex_loc = (DBusMutex *) connection->mutex;
464 *dispatch_mutex_loc = (DBusMutex *) connection->dispatch_mutex;
465 *io_path_mutex_loc = (DBusMutex *) connection->io_path_mutex;
466 *dispatch_cond_loc = connection->dispatch_cond;
467 *io_path_cond_loc = connection->io_path_cond;
472 * Adds a message-containing list link to the incoming message queue,
473 * taking ownership of the link and the message's current refcount.
474 * Cannot fail due to lack of memory.
476 * @param connection the connection.
477 * @param link the message link to queue.
480 _dbus_connection_queue_received_message_link (DBusConnection *connection,
483 DBusPendingCall *pending;
484 dbus_uint32_t reply_serial;
485 DBusMessage *message;
487 _dbus_assert (_dbus_transport_peek_is_authenticated (connection->transport));
489 _dbus_list_append_link (&connection->incoming_messages,
491 message = link->data;
493 /* If this is a reply we're waiting on, remove timeout for it */
494 reply_serial = dbus_message_get_reply_serial (message);
495 if (reply_serial != 0)
497 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
501 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
502 _dbus_connection_remove_timeout_unlocked (connection,
503 _dbus_pending_call_get_timeout_unlocked (pending));
505 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
511 connection->n_incoming += 1;
513 _dbus_connection_wakeup_mainloop (connection);
515 _dbus_verbose ("Message %p (%s %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
517 dbus_message_type_to_string (dbus_message_get_type (message)),
518 dbus_message_get_path (message) ?
519 dbus_message_get_path (message) :
521 dbus_message_get_interface (message) ?
522 dbus_message_get_interface (message) :
524 dbus_message_get_member (message) ?
525 dbus_message_get_member (message) :
527 dbus_message_get_signature (message),
528 dbus_message_get_reply_serial (message),
530 connection->n_incoming);
532 _dbus_message_trace_ref (message, -1, -1,
533 "_dbus_conection_queue_received_message_link");
537 * Adds a link + message to the incoming message queue.
538 * Can't fail. Takes ownership of both link and message.
540 * @param connection the connection.
541 * @param link the list node and message to queue.
545 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
548 HAVE_LOCK_CHECK (connection);
550 _dbus_list_append_link (&connection->incoming_messages, link);
552 connection->n_incoming += 1;
554 _dbus_connection_wakeup_mainloop (connection);
556 _dbus_message_trace_ref (link->data, -1, -1,
557 "_dbus_connection_queue_synthesized_message_link");
559 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
560 link->data, connection, connection->n_incoming);
565 * Checks whether there are messages in the outgoing message queue.
566 * Called with connection lock held.
568 * @param connection the connection.
569 * @returns #TRUE if the outgoing queue is non-empty.
572 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
574 HAVE_LOCK_CHECK (connection);
575 return connection->outgoing_messages != NULL;
579 * Checks whether there are messages in the outgoing message queue.
580 * Use dbus_connection_flush() to block until all outgoing
581 * messages have been written to the underlying transport
582 * (such as a socket).
584 * @param connection the connection.
585 * @returns #TRUE if the outgoing queue is non-empty.
588 dbus_connection_has_messages_to_send (DBusConnection *connection)
592 _dbus_return_val_if_fail (connection != NULL, FALSE);
594 CONNECTION_LOCK (connection);
595 v = _dbus_connection_has_messages_to_send_unlocked (connection);
596 CONNECTION_UNLOCK (connection);
602 * Gets the next outgoing message. The message remains in the
603 * queue, and the caller does not own a reference to it.
605 * @param connection the connection.
606 * @returns the message to be sent.
609 _dbus_connection_get_message_to_send (DBusConnection *connection)
611 HAVE_LOCK_CHECK (connection);
613 return _dbus_list_get_last (&connection->outgoing_messages);
617 * Notifies the connection that a message has been sent, so the
618 * message can be removed from the outgoing queue.
619 * Called with the connection lock held.
621 * @param connection the connection.
622 * @param message the message that was sent.
625 _dbus_connection_message_sent_unlocked (DBusConnection *connection,
626 DBusMessage *message)
630 HAVE_LOCK_CHECK (connection);
632 /* This can be called before we even complete authentication, since
633 * it's called on disconnect to clean up the outgoing queue.
634 * It's also called as we successfully send each message.
637 link = _dbus_list_get_last_link (&connection->outgoing_messages);
638 _dbus_assert (link != NULL);
639 _dbus_assert (link->data == message);
641 _dbus_list_unlink (&connection->outgoing_messages,
643 _dbus_list_prepend_link (&connection->expired_messages, link);
645 connection->n_outgoing -= 1;
647 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
649 dbus_message_type_to_string (dbus_message_get_type (message)),
650 dbus_message_get_path (message) ?
651 dbus_message_get_path (message) :
653 dbus_message_get_interface (message) ?
654 dbus_message_get_interface (message) :
656 dbus_message_get_member (message) ?
657 dbus_message_get_member (message) :
659 dbus_message_get_signature (message),
660 connection, connection->n_outgoing);
662 /* It's OK that in principle we call the notify function, because for the
663 * outgoing limit, there isn't one */
664 _dbus_message_remove_counter (message, connection->outgoing_counter);
666 /* The message will actually be unreffed when we unlock */
669 /** Function to be called in protected_change_watch() with refcount held */
670 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
672 /** Function to be called in protected_change_watch() with refcount held */
673 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
675 /** Function to be called in protected_change_watch() with refcount held */
676 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
678 dbus_bool_t enabled);
681 protected_change_watch (DBusConnection *connection,
683 DBusWatchAddFunction add_function,
684 DBusWatchRemoveFunction remove_function,
685 DBusWatchToggleFunction toggle_function,
690 HAVE_LOCK_CHECK (connection);
692 /* The original purpose of protected_change_watch() was to hold a
693 * ref on the connection while dropping the connection lock, then
694 * calling out to the app. This was a broken hack that did not
695 * work, since the connection was in a hosed state (no WatchList
696 * field) while calling out.
698 * So for now we'll just keep the lock while calling out. This means
699 * apps are not allowed to call DBusConnection methods inside a
700 * watch function or they will deadlock.
702 * The "real fix" is to use the _and_unlock() pattern found
703 * elsewhere in the code, to defer calling out to the app until
704 * we're about to drop locks and return flow of control to the app
707 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
710 if (connection->watches)
713 retval = (* add_function) (connection->watches, watch);
714 else if (remove_function)
717 (* remove_function) (connection->watches, watch);
722 (* toggle_function) (connection->watches, watch, enabled);
732 * Adds a watch using the connection's DBusAddWatchFunction if
733 * available. Otherwise records the watch to be added when said
734 * function is available. Also re-adds the watch if the
735 * DBusAddWatchFunction changes. May fail due to lack of memory.
736 * Connection lock should be held when calling this.
738 * @param connection the connection.
739 * @param watch the watch to add.
740 * @returns #TRUE on success.
743 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
746 return protected_change_watch (connection, watch,
747 _dbus_watch_list_add_watch,
752 * Removes a watch using the connection's DBusRemoveWatchFunction
753 * if available. It's an error to call this function on a watch
754 * that was not previously added.
755 * Connection lock should be held when calling this.
757 * @param connection the connection.
758 * @param watch the watch to remove.
761 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
764 protected_change_watch (connection, watch,
766 _dbus_watch_list_remove_watch,
771 * Toggles a watch and notifies app via connection's
772 * DBusWatchToggledFunction if available. It's an error to call this
773 * function on a watch that was not previously added.
774 * Connection lock should be held when calling this.
776 * @param connection the connection.
777 * @param watch the watch to toggle.
778 * @param enabled whether to enable or disable
781 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
785 _dbus_assert (watch != NULL);
787 protected_change_watch (connection, watch,
789 _dbus_watch_list_toggle_watch,
793 /** Function to be called in protected_change_timeout() with refcount held */
794 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
795 DBusTimeout *timeout);
796 /** Function to be called in protected_change_timeout() with refcount held */
797 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
798 DBusTimeout *timeout);
799 /** Function to be called in protected_change_timeout() with refcount held */
800 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
801 DBusTimeout *timeout,
802 dbus_bool_t enabled);
805 protected_change_timeout (DBusConnection *connection,
806 DBusTimeout *timeout,
807 DBusTimeoutAddFunction add_function,
808 DBusTimeoutRemoveFunction remove_function,
809 DBusTimeoutToggleFunction toggle_function,
814 HAVE_LOCK_CHECK (connection);
816 /* The original purpose of protected_change_timeout() was to hold a
817 * ref on the connection while dropping the connection lock, then
818 * calling out to the app. This was a broken hack that did not
819 * work, since the connection was in a hosed state (no TimeoutList
820 * field) while calling out.
822 * So for now we'll just keep the lock while calling out. This means
823 * apps are not allowed to call DBusConnection methods inside a
824 * timeout function or they will deadlock.
826 * The "real fix" is to use the _and_unlock() pattern found
827 * elsewhere in the code, to defer calling out to the app until
828 * we're about to drop locks and return flow of control to the app
831 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
834 if (connection->timeouts)
837 retval = (* add_function) (connection->timeouts, timeout);
838 else if (remove_function)
841 (* remove_function) (connection->timeouts, timeout);
846 (* toggle_function) (connection->timeouts, timeout, enabled);
855 * Adds a timeout using the connection's DBusAddTimeoutFunction if
856 * available. Otherwise records the timeout to be added when said
857 * function is available. Also re-adds the timeout if the
858 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
859 * The timeout will fire repeatedly until removed.
860 * Connection lock should be held when calling this.
862 * @param connection the connection.
863 * @param timeout the timeout to add.
864 * @returns #TRUE on success.
867 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
868 DBusTimeout *timeout)
870 return protected_change_timeout (connection, timeout,
871 _dbus_timeout_list_add_timeout,
876 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
877 * if available. It's an error to call this function on a timeout
878 * that was not previously added.
879 * Connection lock should be held when calling this.
881 * @param connection the connection.
882 * @param timeout the timeout to remove.
885 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
886 DBusTimeout *timeout)
888 protected_change_timeout (connection, timeout,
890 _dbus_timeout_list_remove_timeout,
895 * Toggles a timeout and notifies app via connection's
896 * DBusTimeoutToggledFunction if available. It's an error to call this
897 * function on a timeout that was not previously added.
898 * Connection lock should be held when calling this.
900 * @param connection the connection.
901 * @param timeout the timeout to toggle.
902 * @param enabled whether to enable or disable
905 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
906 DBusTimeout *timeout,
909 protected_change_timeout (connection, timeout,
911 _dbus_timeout_list_toggle_timeout,
916 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
917 DBusPendingCall *pending)
919 dbus_uint32_t reply_serial;
920 DBusTimeout *timeout;
922 HAVE_LOCK_CHECK (connection);
924 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
926 _dbus_assert (reply_serial != 0);
928 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
932 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
935 if (!_dbus_hash_table_insert_int (connection->pending_replies,
939 _dbus_connection_remove_timeout_unlocked (connection, timeout);
941 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
942 HAVE_LOCK_CHECK (connection);
946 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
950 if (!_dbus_hash_table_insert_int (connection->pending_replies,
954 HAVE_LOCK_CHECK (connection);
959 _dbus_pending_call_ref_unlocked (pending);
961 HAVE_LOCK_CHECK (connection);
967 free_pending_call_on_hash_removal (void *data)
969 DBusPendingCall *pending;
970 DBusConnection *connection;
977 connection = _dbus_pending_call_get_connection_unlocked (pending);
979 HAVE_LOCK_CHECK (connection);
981 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
983 _dbus_connection_remove_timeout_unlocked (connection,
984 _dbus_pending_call_get_timeout_unlocked (pending));
986 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
989 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
990 * here, but the pending call finalizer could in principle call out to
991 * application code so we pretty much have to... some larger code reorg
994 _dbus_connection_ref_unlocked (connection);
995 _dbus_pending_call_unref_and_unlock (pending);
996 CONNECTION_LOCK (connection);
997 _dbus_connection_unref_unlocked (connection);
1001 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
1002 DBusPendingCall *pending)
1004 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
1007 _dbus_hash_table_remove_int (connection->pending_replies,
1008 _dbus_pending_call_get_reply_serial_unlocked (pending));
1012 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
1013 DBusPendingCall *pending)
1015 /* The idea here is to avoid finalizing the pending call
1016 * with the lock held, since there's a destroy notifier
1017 * in pending call that goes out to application code.
1019 * There's an extra unlock inside the hash table
1020 * "free pending call" function FIXME...
1022 _dbus_pending_call_ref_unlocked (pending);
1023 _dbus_hash_table_remove_int (connection->pending_replies,
1024 _dbus_pending_call_get_reply_serial_unlocked (pending));
1026 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
1027 _dbus_connection_remove_timeout_unlocked (connection,
1028 _dbus_pending_call_get_timeout_unlocked (pending));
1030 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
1032 _dbus_pending_call_unref_and_unlock (pending);
1036 * Removes a pending call from the connection, such that
1037 * the pending reply will be ignored. May drop the last
1038 * reference to the pending call.
1040 * @param connection the connection
1041 * @param pending the pending call
1044 _dbus_connection_remove_pending_call (DBusConnection *connection,
1045 DBusPendingCall *pending)
1047 CONNECTION_LOCK (connection);
1048 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
1052 * Acquire the transporter I/O path. This must be done before
1053 * doing any I/O in the transporter. May sleep and drop the
1054 * IO path mutex while waiting for the I/O path.
1056 * @param connection the connection.
1057 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1058 * @returns TRUE if the I/O path was acquired.
1061 _dbus_connection_acquire_io_path (DBusConnection *connection,
1062 int timeout_milliseconds)
1064 dbus_bool_t we_acquired;
1066 HAVE_LOCK_CHECK (connection);
1068 /* We don't want the connection to vanish */
1069 _dbus_connection_ref_unlocked (connection);
1071 /* We will only touch io_path_acquired which is protected by our mutex */
1072 CONNECTION_UNLOCK (connection);
1074 _dbus_verbose ("locking io_path_mutex\n");
1075 _dbus_cmutex_lock (connection->io_path_mutex);
1077 _dbus_verbose ("start connection->io_path_acquired = %d timeout = %d\n",
1078 connection->io_path_acquired, timeout_milliseconds);
1080 we_acquired = FALSE;
1082 if (connection->io_path_acquired)
1084 if (timeout_milliseconds != -1)
1086 _dbus_verbose ("waiting %d for IO path to be acquirable\n",
1087 timeout_milliseconds);
1089 if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1090 connection->io_path_mutex,
1091 timeout_milliseconds))
1093 /* We timed out before anyone signaled. */
1094 /* (writing the loop to handle the !timedout case by
1095 * waiting longer if needed is a pain since dbus
1096 * wraps pthread_cond_timedwait to take a relative
1097 * time instead of absolute, something kind of stupid
1098 * on our part. for now it doesn't matter, we will just
1099 * end up back here eventually.)
1105 while (connection->io_path_acquired)
1107 _dbus_verbose ("waiting for IO path to be acquirable\n");
1108 _dbus_condvar_wait (connection->io_path_cond,
1109 connection->io_path_mutex);
1114 if (!connection->io_path_acquired)
1117 connection->io_path_acquired = TRUE;
1120 _dbus_verbose ("end connection->io_path_acquired = %d we_acquired = %d\n",
1121 connection->io_path_acquired, we_acquired);
1123 _dbus_verbose ("unlocking io_path_mutex\n");
1124 _dbus_cmutex_unlock (connection->io_path_mutex);
1126 CONNECTION_LOCK (connection);
1128 HAVE_LOCK_CHECK (connection);
1130 _dbus_connection_unref_unlocked (connection);
1136 * Release the I/O path when you're done with it. Only call
1137 * after you've acquired the I/O. Wakes up at most one thread
1138 * currently waiting to acquire the I/O path.
1140 * @param connection the connection.
1143 _dbus_connection_release_io_path (DBusConnection *connection)
1145 HAVE_LOCK_CHECK (connection);
1147 _dbus_verbose ("locking io_path_mutex\n");
1148 _dbus_cmutex_lock (connection->io_path_mutex);
1150 _dbus_assert (connection->io_path_acquired);
1152 _dbus_verbose ("start connection->io_path_acquired = %d\n",
1153 connection->io_path_acquired);
1155 connection->io_path_acquired = FALSE;
1156 _dbus_condvar_wake_one (connection->io_path_cond);
1158 _dbus_verbose ("unlocking io_path_mutex\n");
1159 _dbus_cmutex_unlock (connection->io_path_mutex);
1163 * Queues incoming messages and sends outgoing messages for this
1164 * connection, optionally blocking in the process. Each call to
1165 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1166 * time and then read or write data if possible.
1168 * The purpose of this function is to be able to flush outgoing
1169 * messages or queue up incoming messages without returning
1170 * control to the application and causing reentrancy weirdness.
1172 * The flags parameter allows you to specify whether to
1173 * read incoming messages, write outgoing messages, or both,
1174 * and whether to block if no immediate action is possible.
1176 * The timeout_milliseconds parameter does nothing unless the
1177 * iteration is blocking.
1179 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1180 * wasn't specified, then it's impossible to block, even if
1181 * you specify DBUS_ITERATION_BLOCK; in that case the function
1182 * returns immediately.
1184 * If pending is not NULL then a check is made if the pending call
1185 * is completed after the io path has been required. If the call
1186 * has been completed nothing is done. This must be done since
1187 * the _dbus_connection_acquire_io_path releases the connection
1190 * Called with connection lock held.
1192 * @param connection the connection.
1193 * @param pending the pending call that should be checked or NULL
1194 * @param flags iteration flags.
1195 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1198 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1199 DBusPendingCall *pending,
1201 int timeout_milliseconds)
1203 _dbus_verbose ("start\n");
1205 HAVE_LOCK_CHECK (connection);
1207 if (connection->n_outgoing == 0)
1208 flags &= ~DBUS_ITERATION_DO_WRITING;
1210 if (_dbus_connection_acquire_io_path (connection,
1211 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1213 HAVE_LOCK_CHECK (connection);
1215 if ( (pending != NULL) && _dbus_pending_call_get_completed_unlocked(pending))
1217 _dbus_verbose ("pending call completed while acquiring I/O path");
1219 else if ( (pending != NULL) &&
1220 _dbus_connection_peek_for_reply_unlocked (connection,
1221 _dbus_pending_call_get_reply_serial_unlocked (pending)))
1223 _dbus_verbose ("pending call completed while acquiring I/O path (reply found in queue)");
1227 _dbus_transport_do_iteration (connection->transport,
1228 flags, timeout_milliseconds);
1231 _dbus_connection_release_io_path (connection);
1234 HAVE_LOCK_CHECK (connection);
1236 _dbus_verbose ("end\n");
1240 * Creates a new connection for the given transport. A transport
1241 * represents a message stream that uses some concrete mechanism, such
1242 * as UNIX domain sockets. May return #NULL if insufficient
1243 * memory exists to create the connection.
1245 * @param transport the transport.
1246 * @returns the new connection, or #NULL on failure.
1249 _dbus_connection_new_for_transport (DBusTransport *transport)
1251 DBusConnection *connection;
1252 DBusWatchList *watch_list;
1253 DBusTimeoutList *timeout_list;
1254 DBusHashTable *pending_replies;
1255 DBusList *disconnect_link;
1256 DBusMessage *disconnect_message;
1257 DBusCounter *outgoing_counter;
1258 DBusObjectTree *objects;
1262 pending_replies = NULL;
1263 timeout_list = NULL;
1264 disconnect_link = NULL;
1265 disconnect_message = NULL;
1266 outgoing_counter = NULL;
1269 watch_list = _dbus_watch_list_new ();
1270 if (watch_list == NULL)
1273 timeout_list = _dbus_timeout_list_new ();
1274 if (timeout_list == NULL)
1278 _dbus_hash_table_new (DBUS_HASH_INT,
1280 (DBusFreeFunction)free_pending_call_on_hash_removal);
1281 if (pending_replies == NULL)
1284 connection = dbus_new0 (DBusConnection, 1);
1285 if (connection == NULL)
1288 _dbus_rmutex_new_at_location (&connection->mutex);
1289 if (connection->mutex == NULL)
1292 _dbus_cmutex_new_at_location (&connection->io_path_mutex);
1293 if (connection->io_path_mutex == NULL)
1296 _dbus_cmutex_new_at_location (&connection->dispatch_mutex);
1297 if (connection->dispatch_mutex == NULL)
1300 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1301 if (connection->dispatch_cond == NULL)
1304 _dbus_condvar_new_at_location (&connection->io_path_cond);
1305 if (connection->io_path_cond == NULL)
1308 _dbus_rmutex_new_at_location (&connection->slot_mutex);
1309 if (connection->slot_mutex == NULL)
1312 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1313 DBUS_INTERFACE_LOCAL,
1316 if (disconnect_message == NULL)
1319 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1320 if (disconnect_link == NULL)
1323 outgoing_counter = _dbus_counter_new ();
1324 if (outgoing_counter == NULL)
1327 objects = _dbus_object_tree_new (connection);
1328 if (objects == NULL)
1331 if (_dbus_modify_sigpipe)
1332 _dbus_disable_sigpipe ();
1334 /* initialized to 0: use atomic op to avoid mixing atomic and non-atomic */
1335 _dbus_atomic_inc (&connection->refcount);
1336 connection->transport = transport;
1337 connection->watches = watch_list;
1338 connection->timeouts = timeout_list;
1339 connection->pending_replies = pending_replies;
1340 connection->outgoing_counter = outgoing_counter;
1341 connection->filter_list = NULL;
1342 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1343 connection->objects = objects;
1344 connection->exit_on_disconnect = FALSE;
1345 connection->shareable = FALSE;
1346 connection->route_peer_messages = FALSE;
1347 connection->disconnected_message_arrived = FALSE;
1348 connection->disconnected_message_processed = FALSE;
1350 #if defined(DBUS_ENABLE_CHECKS) || defined(DBUS_ENABLE_ASSERT)
1351 connection->generation = _dbus_current_generation;
1354 _dbus_data_slot_list_init (&connection->slot_list);
1356 connection->client_serial = 1;
1358 connection->disconnect_message_link = disconnect_link;
1360 CONNECTION_LOCK (connection);
1362 if (!_dbus_transport_set_connection (transport, connection))
1364 CONNECTION_UNLOCK (connection);
1369 _dbus_transport_ref (transport);
1371 CONNECTION_UNLOCK (connection);
1373 _dbus_connection_trace_ref (connection, 0, 1, "new_for_transport");
1377 if (disconnect_message != NULL)
1378 dbus_message_unref (disconnect_message);
1380 if (disconnect_link != NULL)
1381 _dbus_list_free_link (disconnect_link);
1383 if (connection != NULL)
1385 _dbus_condvar_free_at_location (&connection->io_path_cond);
1386 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1387 _dbus_rmutex_free_at_location (&connection->mutex);
1388 _dbus_cmutex_free_at_location (&connection->io_path_mutex);
1389 _dbus_cmutex_free_at_location (&connection->dispatch_mutex);
1390 _dbus_rmutex_free_at_location (&connection->slot_mutex);
1391 dbus_free (connection);
1393 if (pending_replies)
1394 _dbus_hash_table_unref (pending_replies);
1397 _dbus_watch_list_free (watch_list);
1400 _dbus_timeout_list_free (timeout_list);
1402 if (outgoing_counter)
1403 _dbus_counter_unref (outgoing_counter);
1406 _dbus_object_tree_unref (objects);
1412 * Increments the reference count of a DBusConnection.
1413 * Requires that the caller already holds the connection lock.
1415 * @param connection the connection.
1416 * @returns the connection.
1419 _dbus_connection_ref_unlocked (DBusConnection *connection)
1421 dbus_int32_t old_refcount;
1423 _dbus_assert (connection != NULL);
1424 _dbus_assert (connection->generation == _dbus_current_generation);
1426 HAVE_LOCK_CHECK (connection);
1428 old_refcount = _dbus_atomic_inc (&connection->refcount);
1429 _dbus_connection_trace_ref (connection, old_refcount, old_refcount + 1,
1436 * Decrements the reference count of a DBusConnection.
1437 * Requires that the caller already holds the connection lock.
1439 * @param connection the connection.
1442 _dbus_connection_unref_unlocked (DBusConnection *connection)
1444 dbus_int32_t old_refcount;
1446 HAVE_LOCK_CHECK (connection);
1448 _dbus_assert (connection != NULL);
1450 old_refcount = _dbus_atomic_dec (&connection->refcount);
1452 _dbus_connection_trace_ref (connection, old_refcount, old_refcount - 1,
1455 if (old_refcount == 1)
1456 _dbus_connection_last_unref (connection);
1459 static dbus_uint32_t
1460 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1462 dbus_uint32_t serial;
1464 serial = connection->client_serial++;
1466 if (connection->client_serial == 0)
1467 connection->client_serial = 1;
1473 * A callback for use with dbus_watch_new() to create a DBusWatch.
1475 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1476 * and the virtual handle_watch in DBusTransport if we got rid of it.
1477 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1480 * @param watch the watch.
1481 * @param condition the current condition of the file descriptors being watched.
1482 * @param data must be a pointer to a #DBusConnection
1483 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1486 _dbus_connection_handle_watch (DBusWatch *watch,
1487 unsigned int condition,
1490 DBusConnection *connection;
1492 DBusDispatchStatus status;
1496 _dbus_verbose ("start\n");
1498 CONNECTION_LOCK (connection);
1500 if (!_dbus_connection_acquire_io_path (connection, 1))
1502 /* another thread is handling the message */
1503 CONNECTION_UNLOCK (connection);
1507 HAVE_LOCK_CHECK (connection);
1508 retval = _dbus_transport_handle_watch (connection->transport,
1511 _dbus_connection_release_io_path (connection);
1513 HAVE_LOCK_CHECK (connection);
1515 _dbus_verbose ("middle\n");
1517 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1519 /* this calls out to user code */
1520 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1522 _dbus_verbose ("end\n");
1527 /* Protected by _DBUS_LOCK (shared_connections) */
1528 static DBusHashTable *shared_connections = NULL;
1529 static DBusList *shared_connections_no_guid = NULL;
1532 close_connection_on_shutdown (DBusConnection *connection)
1534 DBusMessage *message;
1536 dbus_connection_ref (connection);
1537 _dbus_connection_close_possibly_shared (connection);
1539 /* Churn through to the Disconnected message */
1540 while ((message = dbus_connection_pop_message (connection)))
1542 dbus_message_unref (message);
1544 dbus_connection_unref (connection);
1548 shared_connections_shutdown (void *data)
1552 if (!_DBUS_LOCK (shared_connections))
1554 /* We'd have initialized locks before adding anything, so there
1555 * can't be anything there. */
1559 /* This is a little bit unpleasant... better ideas? */
1560 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1562 DBusConnection *connection;
1565 _dbus_hash_iter_init (shared_connections, &iter);
1566 _dbus_hash_iter_next (&iter);
1568 connection = _dbus_hash_iter_get_value (&iter);
1570 _DBUS_UNLOCK (shared_connections);
1571 close_connection_on_shutdown (connection);
1572 if (!_DBUS_LOCK (shared_connections))
1573 _dbus_assert_not_reached ("global locks were already initialized");
1575 /* The connection should now be dead and not in our hash ... */
1576 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1579 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1581 _dbus_hash_table_unref (shared_connections);
1582 shared_connections = NULL;
1584 if (shared_connections_no_guid != NULL)
1586 DBusConnection *connection;
1587 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1588 while (connection != NULL)
1590 _DBUS_UNLOCK (shared_connections);
1591 close_connection_on_shutdown (connection);
1592 if (!_DBUS_LOCK (shared_connections))
1593 _dbus_assert_not_reached ("global locks were already initialized");
1594 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1598 shared_connections_no_guid = NULL;
1600 _DBUS_UNLOCK (shared_connections);
1604 connection_lookup_shared (DBusAddressEntry *entry,
1605 DBusConnection **result)
1607 _dbus_verbose ("checking for existing connection\n");
1611 if (!_DBUS_LOCK (shared_connections))
1613 /* If it was shared, we'd have initialized global locks when we put
1614 * it in shared_connections. */
1618 if (shared_connections == NULL)
1620 _dbus_verbose ("creating shared_connections hash table\n");
1622 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1625 if (shared_connections == NULL)
1627 _DBUS_UNLOCK (shared_connections);
1631 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1633 _dbus_hash_table_unref (shared_connections);
1634 shared_connections = NULL;
1635 _DBUS_UNLOCK (shared_connections);
1639 _dbus_verbose (" successfully created shared_connections\n");
1641 _DBUS_UNLOCK (shared_connections);
1642 return TRUE; /* no point looking up in the hash we just made */
1648 guid = dbus_address_entry_get_value (entry, "guid");
1652 DBusConnection *connection;
1654 connection = _dbus_hash_table_lookup_string (shared_connections,
1659 /* The DBusConnection can't be finalized without taking
1660 * the shared_connections lock to remove it from the
1661 * hash. So it's safe to ref the connection here.
1662 * However, it may be disconnected if the Disconnected
1663 * message hasn't been processed yet, in which case we
1664 * want to pretend it isn't in the hash and avoid
1667 * The idea is to avoid ever returning a disconnected connection
1668 * from dbus_connection_open(). We could just synchronously
1669 * drop our shared ref to the connection on connection disconnect,
1670 * and then assert here that the connection is connected, but
1671 * that causes reentrancy headaches.
1673 CONNECTION_LOCK (connection);
1674 if (_dbus_connection_get_is_connected_unlocked (connection))
1676 _dbus_connection_ref_unlocked (connection);
1677 *result = connection;
1678 _dbus_verbose ("looked up existing connection to server guid %s\n",
1683 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1686 CONNECTION_UNLOCK (connection);
1690 _DBUS_UNLOCK (shared_connections);
1696 connection_record_shared_unlocked (DBusConnection *connection,
1700 char *guid_in_connection;
1702 HAVE_LOCK_CHECK (connection);
1703 _dbus_assert (connection->server_guid == NULL);
1704 _dbus_assert (connection->shareable);
1706 /* get a hard ref on this connection, even if
1707 * we won't in fact store it in the hash, we still
1708 * need to hold a ref on it until it's disconnected.
1710 _dbus_connection_ref_unlocked (connection);
1714 if (!_DBUS_LOCK (shared_connections))
1717 if (!_dbus_list_prepend (&shared_connections_no_guid, connection))
1719 _DBUS_UNLOCK (shared_connections);
1723 _DBUS_UNLOCK (shared_connections);
1724 return TRUE; /* don't store in the hash */
1727 /* A separate copy of the key is required in the hash table, because
1728 * we don't have a lock on the connection when we are doing a hash
1732 guid_key = _dbus_strdup (guid);
1733 if (guid_key == NULL)
1736 guid_in_connection = _dbus_strdup (guid);
1737 if (guid_in_connection == NULL)
1739 dbus_free (guid_key);
1743 if (!_DBUS_LOCK (shared_connections))
1745 dbus_free (guid_in_connection);
1746 dbus_free (guid_key);
1750 _dbus_assert (shared_connections != NULL);
1752 if (!_dbus_hash_table_insert_string (shared_connections,
1753 guid_key, connection))
1755 dbus_free (guid_key);
1756 dbus_free (guid_in_connection);
1757 _DBUS_UNLOCK (shared_connections);
1761 connection->server_guid = guid_in_connection;
1763 _dbus_verbose ("stored connection to %s to be shared\n",
1764 connection->server_guid);
1766 _DBUS_UNLOCK (shared_connections);
1768 _dbus_assert (connection->server_guid != NULL);
1774 connection_forget_shared_unlocked (DBusConnection *connection)
1776 HAVE_LOCK_CHECK (connection);
1778 if (!connection->shareable)
1781 if (!_DBUS_LOCK (shared_connections))
1783 /* If it was shared, we'd have initialized global locks when we put
1784 * it in the table; so it can't be there. */
1788 if (connection->server_guid != NULL)
1790 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1791 connection->server_guid);
1793 if (!_dbus_hash_table_remove_string (shared_connections,
1794 connection->server_guid))
1795 _dbus_assert_not_reached ("connection was not in the shared table");
1797 dbus_free (connection->server_guid);
1798 connection->server_guid = NULL;
1802 _dbus_list_remove (&shared_connections_no_guid, connection);
1805 _DBUS_UNLOCK (shared_connections);
1807 /* remove our reference held on all shareable connections */
1808 _dbus_connection_unref_unlocked (connection);
1811 static DBusConnection*
1812 connection_try_from_address_entry (DBusAddressEntry *entry,
1815 DBusTransport *transport;
1816 DBusConnection *connection;
1818 transport = _dbus_transport_open (entry, error);
1820 if (transport == NULL)
1822 _DBUS_ASSERT_ERROR_IS_SET (error);
1826 connection = _dbus_connection_new_for_transport (transport);
1828 _dbus_transport_unref (transport);
1830 if (connection == NULL)
1832 _DBUS_SET_OOM (error);
1836 #ifndef DBUS_DISABLE_CHECKS
1837 _dbus_assert (!connection->have_connection_lock);
1843 * If the shared parameter is true, then any existing connection will
1844 * be used (and if a new connection is created, it will be available
1845 * for use by others). If the shared parameter is false, a new
1846 * connection will always be created, and the new connection will
1847 * never be returned to other callers.
1849 * @param address the address
1850 * @param shared whether the connection is shared or private
1851 * @param error error return
1852 * @returns the connection or #NULL on error
1854 static DBusConnection*
1855 _dbus_connection_open_internal (const char *address,
1859 DBusConnection *connection;
1860 DBusAddressEntry **entries;
1861 DBusError tmp_error = DBUS_ERROR_INIT;
1862 DBusError first_error = DBUS_ERROR_INIT;
1865 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1867 _dbus_verbose ("opening %s connection to: %s\n",
1868 shared ? "shared" : "private", address);
1870 if (!dbus_parse_address (address, &entries, &len, error))
1873 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1877 for (i = 0; i < len; i++)
1881 if (!connection_lookup_shared (entries[i], &connection))
1882 _DBUS_SET_OOM (&tmp_error);
1885 if (connection == NULL)
1887 connection = connection_try_from_address_entry (entries[i],
1890 if (connection != NULL && shared)
1894 connection->shareable = TRUE;
1896 /* guid may be NULL */
1897 guid = dbus_address_entry_get_value (entries[i], "guid");
1899 CONNECTION_LOCK (connection);
1901 if (!connection_record_shared_unlocked (connection, guid))
1903 _DBUS_SET_OOM (&tmp_error);
1904 _dbus_connection_close_possibly_shared_and_unlock (connection);
1905 dbus_connection_unref (connection);
1909 CONNECTION_UNLOCK (connection);
1916 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1919 dbus_move_error (&tmp_error, &first_error);
1921 dbus_error_free (&tmp_error);
1924 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1925 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1927 if (connection == NULL)
1929 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1930 dbus_move_error (&first_error, error);
1933 dbus_error_free (&first_error);
1935 dbus_address_entries_free (entries);
1940 * Closes a shared OR private connection, while dbus_connection_close() can
1941 * only be used on private connections. Should only be called by the
1942 * dbus code that owns the connection - an owner must be known,
1943 * the open/close state is like malloc/free, not like ref/unref.
1945 * @param connection the connection
1948 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1950 _dbus_assert (connection != NULL);
1951 _dbus_assert (connection->generation == _dbus_current_generation);
1953 CONNECTION_LOCK (connection);
1954 _dbus_connection_close_possibly_shared_and_unlock (connection);
1957 static DBusPreallocatedSend*
1958 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1960 DBusPreallocatedSend *preallocated;
1962 HAVE_LOCK_CHECK (connection);
1964 _dbus_assert (connection != NULL);
1966 preallocated = dbus_new (DBusPreallocatedSend, 1);
1967 if (preallocated == NULL)
1970 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1971 if (preallocated->queue_link == NULL)
1974 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1975 if (preallocated->counter_link == NULL)
1978 _dbus_counter_ref (preallocated->counter_link->data);
1980 preallocated->connection = connection;
1982 return preallocated;
1985 _dbus_list_free_link (preallocated->queue_link);
1987 dbus_free (preallocated);
1992 /* Called with lock held, does not update dispatch status */
1994 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
1995 DBusPreallocatedSend *preallocated,
1996 DBusMessage *message,
1997 dbus_uint32_t *client_serial)
1999 dbus_uint32_t serial;
2001 preallocated->queue_link->data = message;
2002 _dbus_list_prepend_link (&connection->outgoing_messages,
2003 preallocated->queue_link);
2005 /* It's OK that we'll never call the notify function, because for the
2006 * outgoing limit, there isn't one */
2007 _dbus_message_add_counter_link (message,
2008 preallocated->counter_link);
2010 dbus_free (preallocated);
2011 preallocated = NULL;
2013 dbus_message_ref (message);
2015 connection->n_outgoing += 1;
2017 _dbus_verbose ("Message %p (%s %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
2019 dbus_message_type_to_string (dbus_message_get_type (message)),
2020 dbus_message_get_path (message) ?
2021 dbus_message_get_path (message) :
2023 dbus_message_get_interface (message) ?
2024 dbus_message_get_interface (message) :
2026 dbus_message_get_member (message) ?
2027 dbus_message_get_member (message) :
2029 dbus_message_get_signature (message),
2030 dbus_message_get_destination (message) ?
2031 dbus_message_get_destination (message) :
2034 connection->n_outgoing);
2036 if (dbus_message_get_serial (message) == 0)
2038 serial = _dbus_connection_get_next_client_serial (connection);
2039 dbus_message_set_serial (message, serial);
2041 *client_serial = serial;
2046 *client_serial = dbus_message_get_serial (message);
2049 _dbus_verbose ("Message %p serial is %u\n",
2050 message, dbus_message_get_serial (message));
2052 dbus_message_lock (message);
2054 /* Now we need to run an iteration to hopefully just write the messages
2055 * out immediately, and otherwise get them queued up
2057 _dbus_connection_do_iteration_unlocked (connection,
2059 DBUS_ITERATION_DO_WRITING,
2062 /* If stuff is still queued up, be sure we wake up the main loop */
2063 if (connection->n_outgoing > 0)
2064 _dbus_connection_wakeup_mainloop (connection);
2068 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2069 DBusPreallocatedSend *preallocated,
2070 DBusMessage *message,
2071 dbus_uint32_t *client_serial)
2073 DBusDispatchStatus status;
2075 HAVE_LOCK_CHECK (connection);
2077 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2079 message, client_serial);
2081 _dbus_verbose ("middle\n");
2082 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2084 /* this calls out to user code */
2085 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2089 * Like dbus_connection_send(), but assumes the connection
2090 * is already locked on function entry, and unlocks before returning.
2092 * @param connection the connection
2093 * @param message the message to send
2094 * @param client_serial return location for client serial of sent message
2095 * @returns #FALSE on out-of-memory
2098 _dbus_connection_send_and_unlock (DBusConnection *connection,
2099 DBusMessage *message,
2100 dbus_uint32_t *client_serial)
2102 DBusPreallocatedSend *preallocated;
2104 _dbus_assert (connection != NULL);
2105 _dbus_assert (message != NULL);
2107 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2108 if (preallocated == NULL)
2110 CONNECTION_UNLOCK (connection);
2114 _dbus_connection_send_preallocated_and_unlock (connection,
2122 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2123 * If the new connection function does not ref the connection, we want to close it.
2125 * A bit of a hack, probably the new connection function should have returned a value
2126 * for whether to close, or should have had to close the connection itself if it
2129 * But, this works OK as long as the new connection function doesn't do anything
2130 * crazy like keep the connection around without ref'ing it.
2132 * We have to lock the connection across refcount check and close in case
2133 * the new connection function spawns a thread that closes and unrefs.
2134 * In that case, if the app thread
2135 * closes and unrefs first, we'll harmlessly close again; if the app thread
2136 * still has the ref, we'll close and then the app will close harmlessly.
2137 * If the app unrefs without closing, the app is broken since if the
2138 * app refs from the new connection function it is supposed to also close.
2140 * If we didn't atomically check the refcount and close with the lock held
2141 * though, we could screw this up.
2143 * @param connection the connection
2146 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2148 dbus_int32_t refcount;
2150 CONNECTION_LOCK (connection);
2152 refcount = _dbus_atomic_get (&connection->refcount);
2153 /* The caller should have at least one ref */
2154 _dbus_assert (refcount >= 1);
2157 _dbus_connection_close_possibly_shared_and_unlock (connection);
2159 CONNECTION_UNLOCK (connection);
2164 * When a function that blocks has been called with a timeout, and we
2165 * run out of memory, the time to wait for memory is based on the
2166 * timeout. If the caller was willing to block a long time we wait a
2167 * relatively long time for memory, if they were only willing to block
2168 * briefly then we retry for memory at a rapid rate.
2170 * @param timeout_milliseconds the timeout requested for blocking
2173 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2175 if (timeout_milliseconds == -1)
2176 _dbus_sleep_milliseconds (1000);
2177 else if (timeout_milliseconds < 100)
2178 ; /* just busy loop */
2179 else if (timeout_milliseconds <= 1000)
2180 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2182 _dbus_sleep_milliseconds (1000);
2185 static DBusMessage *
2186 generate_local_error_message (dbus_uint32_t serial,
2190 DBusMessage *message;
2191 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2195 if (!dbus_message_set_error_name (message, error_name))
2197 dbus_message_unref (message);
2202 dbus_message_set_no_reply (message, TRUE);
2204 if (!dbus_message_set_reply_serial (message,
2207 dbus_message_unref (message);
2212 if (error_msg != NULL)
2214 DBusMessageIter iter;
2216 dbus_message_iter_init_append (message, &iter);
2217 if (!dbus_message_iter_append_basic (&iter,
2221 dbus_message_unref (message);
2232 * Peek the incoming queue to see if we got reply for a specific serial
2235 _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
2236 dbus_uint32_t client_serial)
2239 HAVE_LOCK_CHECK (connection);
2241 link = _dbus_list_get_first_link (&connection->incoming_messages);
2243 while (link != NULL)
2245 DBusMessage *reply = link->data;
2247 if (dbus_message_get_reply_serial (reply) == client_serial)
2249 _dbus_verbose ("%s reply to %d found in queue\n", _DBUS_FUNCTION_NAME, client_serial);
2252 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2258 /* This is slightly strange since we can pop a message here without
2259 * the dispatch lock.
2262 check_for_reply_unlocked (DBusConnection *connection,
2263 dbus_uint32_t client_serial)
2267 HAVE_LOCK_CHECK (connection);
2269 link = _dbus_list_get_first_link (&connection->incoming_messages);
2271 while (link != NULL)
2273 DBusMessage *reply = link->data;
2275 if (dbus_message_get_reply_serial (reply) == client_serial)
2277 _dbus_list_remove_link (&connection->incoming_messages, link);
2278 connection->n_incoming -= 1;
2281 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2288 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2290 /* We can't iterate over the hash in the normal way since we'll be
2291 * dropping the lock for each item. So we restart the
2292 * iter each time as we drain the hash table.
2295 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2297 DBusPendingCall *pending;
2300 _dbus_hash_iter_init (connection->pending_replies, &iter);
2301 _dbus_hash_iter_next (&iter);
2303 pending = _dbus_hash_iter_get_value (&iter);
2304 _dbus_pending_call_ref_unlocked (pending);
2306 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2309 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
2310 _dbus_connection_remove_timeout_unlocked (connection,
2311 _dbus_pending_call_get_timeout_unlocked (pending));
2312 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2313 _dbus_hash_iter_remove_entry (&iter);
2315 _dbus_pending_call_unref_and_unlock (pending);
2316 CONNECTION_LOCK (connection);
2318 HAVE_LOCK_CHECK (connection);
2322 complete_pending_call_and_unlock (DBusConnection *connection,
2323 DBusPendingCall *pending,
2324 DBusMessage *message)
2326 _dbus_pending_call_set_reply_unlocked (pending, message);
2327 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2328 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2330 /* Must be called unlocked since it invokes app callback */
2331 _dbus_pending_call_complete (pending);
2332 dbus_pending_call_unref (pending);
2336 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2337 DBusPendingCall *pending)
2340 DBusDispatchStatus status;
2342 reply = check_for_reply_unlocked (connection,
2343 _dbus_pending_call_get_reply_serial_unlocked (pending));
2346 _dbus_verbose ("checked for reply\n");
2348 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2350 complete_pending_call_and_unlock (connection, pending, reply);
2351 dbus_message_unref (reply);
2353 CONNECTION_LOCK (connection);
2354 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2355 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2356 dbus_pending_call_unref (pending);
2365 * Blocks until a pending call times out or gets a reply.
2367 * Does not re-enter the main loop or run filter/path-registered
2368 * callbacks. The reply to the message will not be seen by
2371 * Returns immediately if pending call already got a reply.
2373 * @todo could use performance improvements (it keeps scanning
2374 * the whole message queue for example)
2376 * @param pending the pending call we block for a reply on
2379 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2381 long start_tv_sec, start_tv_usec;
2382 long tv_sec, tv_usec;
2383 DBusDispatchStatus status;
2384 DBusConnection *connection;
2385 dbus_uint32_t client_serial;
2386 DBusTimeout *timeout;
2387 int timeout_milliseconds, elapsed_milliseconds;
2389 _dbus_assert (pending != NULL);
2391 if (dbus_pending_call_get_completed (pending))
2394 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2396 connection = _dbus_pending_call_get_connection_and_lock (pending);
2398 /* Flush message queue - note, can affect dispatch status */
2399 _dbus_connection_flush_unlocked (connection);
2401 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2403 /* note that timeout_milliseconds is limited to a smallish value
2404 * in _dbus_pending_call_new() so overflows aren't possible
2407 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
2408 _dbus_get_monotonic_time (&start_tv_sec, &start_tv_usec);
2411 timeout_milliseconds = dbus_timeout_get_interval (timeout);
2413 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec\n",
2414 timeout_milliseconds,
2416 start_tv_sec, start_tv_usec);
2420 timeout_milliseconds = -1;
2422 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block for reply serial %u\n", client_serial);
2425 /* check to see if we already got the data off the socket */
2426 /* from another blocked pending call */
2427 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2430 /* Now we wait... */
2431 /* always block at least once as we know we don't have the reply yet */
2432 _dbus_connection_do_iteration_unlocked (connection,
2434 DBUS_ITERATION_DO_READING |
2435 DBUS_ITERATION_BLOCK,
2436 timeout_milliseconds);
2440 _dbus_verbose ("top of recheck\n");
2442 HAVE_LOCK_CHECK (connection);
2444 /* queue messages and get status */
2446 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2448 /* the get_completed() is in case a dispatch() while we were blocking
2449 * got the reply instead of us.
2451 if (_dbus_pending_call_get_completed_unlocked (pending))
2453 _dbus_verbose ("Pending call completed by dispatch\n");
2454 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2455 dbus_pending_call_unref (pending);
2459 if (status == DBUS_DISPATCH_DATA_REMAINS)
2461 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2465 _dbus_get_monotonic_time (&tv_sec, &tv_usec);
2466 elapsed_milliseconds = (tv_sec - start_tv_sec) * 1000 +
2467 (tv_usec - start_tv_usec) / 1000;
2469 if (!_dbus_connection_get_is_connected_unlocked (connection))
2471 DBusMessage *error_msg;
2473 error_msg = generate_local_error_message (client_serial,
2474 DBUS_ERROR_DISCONNECTED,
2475 "Connection was disconnected before a reply was received");
2477 /* on OOM error_msg is set to NULL */
2478 complete_pending_call_and_unlock (connection, pending, error_msg);
2479 dbus_pending_call_unref (pending);
2482 else if (connection->disconnect_message_link == NULL)
2483 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2484 else if (timeout == NULL)
2486 if (status == DBUS_DISPATCH_NEED_MEMORY)
2488 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2489 * we may already have a reply in the buffer and just can't process
2492 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2494 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2498 /* block again, we don't have the reply buffered yet. */
2499 _dbus_connection_do_iteration_unlocked (connection,
2501 DBUS_ITERATION_DO_READING |
2502 DBUS_ITERATION_BLOCK,
2503 timeout_milliseconds - elapsed_milliseconds);
2506 goto recheck_status;
2508 else if (tv_sec < start_tv_sec)
2509 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2510 else if (elapsed_milliseconds < timeout_milliseconds)
2512 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds - elapsed_milliseconds);
2514 if (status == DBUS_DISPATCH_NEED_MEMORY)
2516 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2517 * we may already have a reply in the buffer and just can't process
2520 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2522 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2526 /* block again, we don't have the reply buffered yet. */
2527 _dbus_connection_do_iteration_unlocked (connection,
2529 DBUS_ITERATION_DO_READING |
2530 DBUS_ITERATION_BLOCK,
2531 timeout_milliseconds - elapsed_milliseconds);
2534 goto recheck_status;
2537 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %d milliseconds and got no reply\n",
2538 elapsed_milliseconds);
2540 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2542 /* unlock and call user code */
2543 complete_pending_call_and_unlock (connection, pending, NULL);
2545 /* update user code on dispatch status */
2546 CONNECTION_LOCK (connection);
2547 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2548 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2549 dbus_pending_call_unref (pending);
2555 * @addtogroup DBusConnection
2561 * Gets a connection to a remote address. If a connection to the given
2562 * address already exists, returns the existing connection with its
2563 * reference count incremented. Otherwise, returns a new connection
2564 * and saves the new connection for possible re-use if a future call
2565 * to dbus_connection_open() asks to connect to the same server.
2567 * Use dbus_connection_open_private() to get a dedicated connection
2568 * not shared with other callers of dbus_connection_open().
2570 * If the open fails, the function returns #NULL, and provides a
2571 * reason for the failure in the error parameter. Pass #NULL for the
2572 * error parameter if you aren't interested in the reason for
2575 * Because this connection is shared, no user of the connection
2576 * may call dbus_connection_close(). However, when you are done with the
2577 * connection you should call dbus_connection_unref().
2579 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2580 * unless you have good reason; connections are expensive enough
2581 * that it's wasteful to create lots of connections to the same
2584 * @param address the address.
2585 * @param error address where an error can be returned.
2586 * @returns new connection, or #NULL on failure.
2589 dbus_connection_open (const char *address,
2592 DBusConnection *connection;
2594 _dbus_return_val_if_fail (address != NULL, NULL);
2595 _dbus_return_val_if_error_is_set (error, NULL);
2597 connection = _dbus_connection_open_internal (address,
2605 * Opens a new, dedicated connection to a remote address. Unlike
2606 * dbus_connection_open(), always creates a new connection.
2607 * This connection will not be saved or recycled by libdbus.
2609 * If the open fails, the function returns #NULL, and provides a
2610 * reason for the failure in the error parameter. Pass #NULL for the
2611 * error parameter if you aren't interested in the reason for
2614 * When you are done with this connection, you must
2615 * dbus_connection_close() to disconnect it,
2616 * and dbus_connection_unref() to free the connection object.
2618 * (The dbus_connection_close() can be skipped if the
2619 * connection is already known to be disconnected, for example
2620 * if you are inside a handler for the Disconnected signal.)
2622 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2623 * unless you have good reason; connections are expensive enough
2624 * that it's wasteful to create lots of connections to the same
2627 * @param address the address.
2628 * @param error address where an error can be returned.
2629 * @returns new connection, or #NULL on failure.
2632 dbus_connection_open_private (const char *address,
2635 DBusConnection *connection;
2637 _dbus_return_val_if_fail (address != NULL, NULL);
2638 _dbus_return_val_if_error_is_set (error, NULL);
2640 connection = _dbus_connection_open_internal (address,
2648 * Increments the reference count of a DBusConnection.
2650 * @param connection the connection.
2651 * @returns the connection.
2654 dbus_connection_ref (DBusConnection *connection)
2656 dbus_int32_t old_refcount;
2658 _dbus_return_val_if_fail (connection != NULL, NULL);
2659 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2660 old_refcount = _dbus_atomic_inc (&connection->refcount);
2661 _dbus_connection_trace_ref (connection, old_refcount, old_refcount + 1,
2668 free_outgoing_message (void *element,
2671 DBusMessage *message = element;
2672 DBusConnection *connection = data;
2674 _dbus_message_remove_counter (message, connection->outgoing_counter);
2675 dbus_message_unref (message);
2678 /* This is run without the mutex held, but after the last reference
2679 * to the connection has been dropped we should have no thread-related
2683 _dbus_connection_last_unref (DBusConnection *connection)
2687 _dbus_verbose ("Finalizing connection %p\n", connection);
2689 _dbus_assert (_dbus_atomic_get (&connection->refcount) == 0);
2691 /* You have to disconnect the connection before unref:ing it. Otherwise
2692 * you won't get the disconnected message.
2694 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2695 _dbus_assert (connection->server_guid == NULL);
2697 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2698 _dbus_object_tree_free_all_unlocked (connection->objects);
2700 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2701 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2702 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2703 dbus_connection_set_windows_user_function (connection, NULL, NULL, NULL);
2705 _dbus_watch_list_free (connection->watches);
2706 connection->watches = NULL;
2708 _dbus_timeout_list_free (connection->timeouts);
2709 connection->timeouts = NULL;
2711 _dbus_data_slot_list_free (&connection->slot_list);
2713 link = _dbus_list_get_first_link (&connection->filter_list);
2714 while (link != NULL)
2716 DBusMessageFilter *filter = link->data;
2717 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2719 filter->function = NULL;
2720 _dbus_message_filter_unref (filter); /* calls app callback */
2725 _dbus_list_clear (&connection->filter_list);
2727 /* ---- Done with stuff that invokes application callbacks */
2729 _dbus_object_tree_unref (connection->objects);
2731 _dbus_hash_table_unref (connection->pending_replies);
2732 connection->pending_replies = NULL;
2734 _dbus_list_clear (&connection->filter_list);
2736 _dbus_list_foreach (&connection->outgoing_messages,
2737 free_outgoing_message,
2739 _dbus_list_clear (&connection->outgoing_messages);
2741 _dbus_list_foreach (&connection->incoming_messages,
2742 (DBusForeachFunction) dbus_message_unref,
2744 _dbus_list_clear (&connection->incoming_messages);
2746 _dbus_counter_unref (connection->outgoing_counter);
2748 _dbus_transport_unref (connection->transport);
2750 if (connection->disconnect_message_link)
2752 DBusMessage *message = connection->disconnect_message_link->data;
2753 dbus_message_unref (message);
2754 _dbus_list_free_link (connection->disconnect_message_link);
2757 _dbus_condvar_free_at_location (&connection->dispatch_cond);
2758 _dbus_condvar_free_at_location (&connection->io_path_cond);
2760 _dbus_cmutex_free_at_location (&connection->io_path_mutex);
2761 _dbus_cmutex_free_at_location (&connection->dispatch_mutex);
2763 _dbus_rmutex_free_at_location (&connection->slot_mutex);
2765 _dbus_rmutex_free_at_location (&connection->mutex);
2767 dbus_free (connection);
2771 * Decrements the reference count of a DBusConnection, and finalizes
2772 * it if the count reaches zero.
2774 * Note: it is a bug to drop the last reference to a connection that
2775 * is still connected.
2777 * For shared connections, libdbus will own a reference
2778 * as long as the connection is connected, so you can know that either
2779 * you don't have the last reference, or it's OK to drop the last reference.
2780 * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2781 * return shared connections.
2783 * For private connections, the creator of the connection must arrange for
2784 * dbus_connection_close() to be called prior to dropping the last reference.
2785 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2787 * @param connection the connection.
2790 dbus_connection_unref (DBusConnection *connection)
2792 dbus_int32_t old_refcount;
2794 _dbus_return_if_fail (connection != NULL);
2795 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2797 old_refcount = _dbus_atomic_dec (&connection->refcount);
2799 _dbus_connection_trace_ref (connection, old_refcount, old_refcount - 1,
2802 if (old_refcount == 1)
2804 #ifndef DBUS_DISABLE_CHECKS
2805 if (_dbus_transport_get_is_connected (connection->transport))
2807 _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",
2808 connection->shareable ?
2809 "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2810 "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2814 _dbus_connection_last_unref (connection);
2819 * Note that the transport can disconnect itself (other end drops us)
2820 * and in that case this function never runs. So this function must
2821 * not do anything more than disconnect the transport and update the
2824 * If the transport self-disconnects, then we assume someone will
2825 * dispatch the connection to cause the dispatch status update.
2828 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2830 DBusDispatchStatus status;
2832 HAVE_LOCK_CHECK (connection);
2834 _dbus_verbose ("Disconnecting %p\n", connection);
2836 /* We need to ref because update_dispatch_status_and_unlock will unref
2837 * the connection if it was shared and libdbus was the only remaining
2840 _dbus_connection_ref_unlocked (connection);
2842 _dbus_transport_disconnect (connection->transport);
2844 /* This has the side effect of queuing the disconnect message link
2845 * (unless we don't have enough memory, possibly, so don't assert it).
2846 * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2847 * should never again return the newly-disconnected connection.
2849 * However, we only unref the shared connection and exit_on_disconnect when
2850 * the disconnect message reaches the head of the message queue,
2851 * NOT when it's first queued.
2853 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2855 /* This calls out to user code */
2856 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2858 /* Could also call out to user code */
2859 dbus_connection_unref (connection);
2863 * Closes a private connection, so no further data can be sent or received.
2864 * This disconnects the transport (such as a socket) underlying the
2867 * Attempts to send messages after closing a connection are safe, but will result in
2868 * error replies generated locally in libdbus.
2870 * This function does not affect the connection's reference count. It's
2871 * safe to close a connection more than once; all calls after the
2872 * first do nothing. It's impossible to "reopen" a connection, a
2873 * new connection must be created. This function may result in a call
2874 * to the DBusDispatchStatusFunction set with
2875 * dbus_connection_set_dispatch_status_function(), as the disconnect
2876 * message it generates needs to be dispatched.
2878 * If a connection is dropped by the remote application, it will
2881 * You must close a connection prior to releasing the last reference to
2882 * the connection. If you dbus_connection_unref() for the last time
2883 * without closing the connection, the results are undefined; it
2884 * is a bug in your program and libdbus will try to print a warning.
2886 * You may not close a shared connection. Connections created with
2887 * dbus_connection_open() or dbus_bus_get() are shared.
2888 * These connections are owned by libdbus, and applications should
2889 * only unref them, never close them. Applications can know it is
2890 * safe to unref these connections because libdbus will be holding a
2891 * reference as long as the connection is open. Thus, either the
2892 * connection is closed and it is OK to drop the last reference,
2893 * or the connection is open and the app knows it does not have the
2896 * Connections created with dbus_connection_open_private() or
2897 * dbus_bus_get_private() are not kept track of or referenced by
2898 * libdbus. The creator of these connections is responsible for
2899 * calling dbus_connection_close() prior to releasing the last
2900 * reference, if the connection is not already disconnected.
2902 * @param connection the private (unshared) connection to close
2905 dbus_connection_close (DBusConnection *connection)
2907 _dbus_return_if_fail (connection != NULL);
2908 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2910 CONNECTION_LOCK (connection);
2912 #ifndef DBUS_DISABLE_CHECKS
2913 if (connection->shareable)
2915 CONNECTION_UNLOCK (connection);
2917 _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2922 _dbus_connection_close_possibly_shared_and_unlock (connection);
2926 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2928 HAVE_LOCK_CHECK (connection);
2929 return _dbus_transport_get_is_connected (connection->transport);
2933 * Gets whether the connection is currently open. A connection may
2934 * become disconnected when the remote application closes its end, or
2935 * exits; a connection may also be disconnected with
2936 * dbus_connection_close().
2938 * There are not separate states for "closed" and "disconnected," the two
2939 * terms are synonymous. This function should really be called
2940 * get_is_open() but for historical reasons is not.
2942 * @param connection the connection.
2943 * @returns #TRUE if the connection is still alive.
2946 dbus_connection_get_is_connected (DBusConnection *connection)
2950 _dbus_return_val_if_fail (connection != NULL, FALSE);
2952 CONNECTION_LOCK (connection);
2953 res = _dbus_connection_get_is_connected_unlocked (connection);
2954 CONNECTION_UNLOCK (connection);
2960 * Gets whether the connection was authenticated. (Note that
2961 * if the connection was authenticated then disconnected,
2962 * this function still returns #TRUE)
2964 * @param connection the connection
2965 * @returns #TRUE if the connection was ever authenticated
2968 dbus_connection_get_is_authenticated (DBusConnection *connection)
2972 _dbus_return_val_if_fail (connection != NULL, FALSE);
2974 CONNECTION_LOCK (connection);
2975 res = _dbus_transport_try_to_authenticate (connection->transport);
2976 CONNECTION_UNLOCK (connection);
2982 * Gets whether the connection is not authenticated as a specific
2983 * user. If the connection is not authenticated, this function
2984 * returns #TRUE, and if it is authenticated but as an anonymous user,
2985 * it returns #TRUE. If it is authenticated as a specific user, then
2986 * this returns #FALSE. (Note that if the connection was authenticated
2987 * as anonymous then disconnected, this function still returns #TRUE.)
2989 * If the connection is not anonymous, you can use
2990 * dbus_connection_get_unix_user() and
2991 * dbus_connection_get_windows_user() to see who it's authorized as.
2993 * If you want to prevent non-anonymous authorization, use
2994 * dbus_server_set_auth_mechanisms() to remove the mechanisms that
2995 * allow proving user identity (i.e. only allow the ANONYMOUS
2998 * @param connection the connection
2999 * @returns #TRUE if not authenticated or authenticated as anonymous
3002 dbus_connection_get_is_anonymous (DBusConnection *connection)
3006 _dbus_return_val_if_fail (connection != NULL, FALSE);
3008 CONNECTION_LOCK (connection);
3009 res = _dbus_transport_get_is_anonymous (connection->transport);
3010 CONNECTION_UNLOCK (connection);
3016 * Gets the ID of the server address we are authenticated to, if this
3017 * connection is on the client side. If the connection is on the
3018 * server side, this will always return #NULL - use dbus_server_get_id()
3019 * to get the ID of your own server, if you are the server side.
3021 * If a client-side connection is not authenticated yet, the ID may be
3022 * available if it was included in the server address, but may not be
3023 * available. The only way to be sure the server ID is available
3024 * is to wait for authentication to complete.
3026 * In general, each mode of connecting to a given server will have
3027 * its own ID. So for example, if the session bus daemon is listening
3028 * on UNIX domain sockets and on TCP, then each of those modalities
3029 * will have its own server ID.
3031 * If you want an ID that identifies an entire session bus, look at
3032 * dbus_bus_get_id() instead (which is just a convenience wrapper
3033 * around the org.freedesktop.DBus.GetId method invoked on the bus).
3035 * You can also get a machine ID; see dbus_get_local_machine_id() to
3036 * get the machine you are on. There isn't a convenience wrapper, but
3037 * you can invoke org.freedesktop.DBus.Peer.GetMachineId on any peer
3038 * to get the machine ID on the other end.
3040 * The D-Bus specification describes the server ID and other IDs in a
3043 * @param connection the connection
3044 * @returns the server ID or #NULL if no memory or the connection is server-side
3047 dbus_connection_get_server_id (DBusConnection *connection)
3051 _dbus_return_val_if_fail (connection != NULL, NULL);
3053 CONNECTION_LOCK (connection);
3054 id = _dbus_strdup (_dbus_transport_get_server_id (connection->transport));
3055 CONNECTION_UNLOCK (connection);
3061 * Tests whether a certain type can be send via the connection. This
3062 * will always return TRUE for all types, with the exception of
3063 * DBUS_TYPE_UNIX_FD. The function will return TRUE for
3064 * DBUS_TYPE_UNIX_FD only on systems that know Unix file descriptors
3065 * and can send them via the chosen transport and when the remote side
3068 * This function can be used to do runtime checking for types that
3069 * might be unknown to the specific D-Bus client implementation
3070 * version, i.e. it will return FALSE for all types this
3071 * implementation does not know, including invalid or reserved types.
3073 * @param connection the connection
3074 * @param type the type to check
3075 * @returns TRUE if the type may be send via the connection
3078 dbus_connection_can_send_type(DBusConnection *connection,
3081 _dbus_return_val_if_fail (connection != NULL, FALSE);
3083 if (!dbus_type_is_valid (type))
3086 if (type != DBUS_TYPE_UNIX_FD)
3089 #ifdef HAVE_UNIX_FD_PASSING
3093 CONNECTION_LOCK(connection);
3094 b = _dbus_transport_can_pass_unix_fd(connection->transport);
3095 CONNECTION_UNLOCK(connection);
3105 * Set whether _exit() should be called when the connection receives a
3106 * disconnect signal. The call to _exit() comes after any handlers for
3107 * the disconnect signal run; handlers can cancel the exit by calling
3110 * By default, exit_on_disconnect is #FALSE; but for message bus
3111 * connections returned from dbus_bus_get() it will be toggled on
3114 * @param connection the connection
3115 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
3118 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
3119 dbus_bool_t exit_on_disconnect)
3121 _dbus_return_if_fail (connection != NULL);
3123 CONNECTION_LOCK (connection);
3124 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
3125 CONNECTION_UNLOCK (connection);
3129 * Preallocates resources needed to send a message, allowing the message
3130 * to be sent without the possibility of memory allocation failure.
3131 * Allows apps to create a future guarantee that they can send
3132 * a message regardless of memory shortages.
3134 * @param connection the connection we're preallocating for.
3135 * @returns the preallocated resources, or #NULL
3137 DBusPreallocatedSend*
3138 dbus_connection_preallocate_send (DBusConnection *connection)
3140 DBusPreallocatedSend *preallocated;
3142 _dbus_return_val_if_fail (connection != NULL, NULL);
3144 CONNECTION_LOCK (connection);
3147 _dbus_connection_preallocate_send_unlocked (connection);
3149 CONNECTION_UNLOCK (connection);
3151 return preallocated;
3155 * Frees preallocated message-sending resources from
3156 * dbus_connection_preallocate_send(). Should only
3157 * be called if the preallocated resources are not used
3158 * to send a message.
3160 * @param connection the connection
3161 * @param preallocated the resources
3164 dbus_connection_free_preallocated_send (DBusConnection *connection,
3165 DBusPreallocatedSend *preallocated)
3167 _dbus_return_if_fail (connection != NULL);
3168 _dbus_return_if_fail (preallocated != NULL);
3169 _dbus_return_if_fail (connection == preallocated->connection);
3171 _dbus_list_free_link (preallocated->queue_link);
3172 _dbus_counter_unref (preallocated->counter_link->data);
3173 _dbus_list_free_link (preallocated->counter_link);
3174 dbus_free (preallocated);
3178 * Sends a message using preallocated resources. This function cannot fail.
3179 * It works identically to dbus_connection_send() in other respects.
3180 * Preallocated resources comes from dbus_connection_preallocate_send().
3181 * This function "consumes" the preallocated resources, they need not
3182 * be freed separately.
3184 * @param connection the connection
3185 * @param preallocated the preallocated resources
3186 * @param message the message to send
3187 * @param client_serial return location for client serial assigned to the message
3190 dbus_connection_send_preallocated (DBusConnection *connection,
3191 DBusPreallocatedSend *preallocated,
3192 DBusMessage *message,
3193 dbus_uint32_t *client_serial)
3195 _dbus_return_if_fail (connection != NULL);
3196 _dbus_return_if_fail (preallocated != NULL);
3197 _dbus_return_if_fail (message != NULL);
3198 _dbus_return_if_fail (preallocated->connection == connection);
3199 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3200 dbus_message_get_member (message) != NULL);
3201 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
3202 (dbus_message_get_interface (message) != NULL &&
3203 dbus_message_get_member (message) != NULL));
3205 CONNECTION_LOCK (connection);
3207 #ifdef HAVE_UNIX_FD_PASSING
3209 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3210 message->n_unix_fds > 0)
3212 /* Refuse to send fds on a connection that cannot handle
3213 them. Unfortunately we cannot return a proper error here, so
3214 the best we can is just return. */
3215 CONNECTION_UNLOCK (connection);
3221 _dbus_connection_send_preallocated_and_unlock (connection,
3223 message, client_serial);
3227 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
3228 DBusMessage *message,
3229 dbus_uint32_t *client_serial)
3231 DBusPreallocatedSend *preallocated;
3233 _dbus_assert (connection != NULL);
3234 _dbus_assert (message != NULL);
3236 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
3237 if (preallocated == NULL)
3240 _dbus_connection_send_preallocated_unlocked_no_update (connection,
3248 * Adds a message to the outgoing message queue. Does not block to
3249 * write the message to the network; that happens asynchronously. To
3250 * force the message to be written, call dbus_connection_flush() however
3251 * it is not necessary to call dbus_connection_flush() by hand; the
3252 * message will be sent the next time the main loop is run.
3253 * dbus_connection_flush() should only be used, for example, if
3254 * the application was expected to exit before running the main loop.
3256 * Because this only queues the message, the only reason it can
3257 * fail is lack of memory. Even if the connection is disconnected,
3258 * no error will be returned. If the function fails due to lack of memory,
3259 * it returns #FALSE. The function will never fail for other reasons; even
3260 * if the connection is disconnected, you can queue an outgoing message,
3261 * though obviously it won't be sent.
3263 * The message serial is used by the remote application to send a
3264 * reply; see dbus_message_get_serial() or the D-Bus specification.
3266 * dbus_message_unref() can be called as soon as this method returns
3267 * as the message queue will hold its own ref until the message is sent.
3269 * @param connection the connection.
3270 * @param message the message to write.
3271 * @param serial return location for message serial, or #NULL if you don't care
3272 * @returns #TRUE on success.
3275 dbus_connection_send (DBusConnection *connection,
3276 DBusMessage *message,
3277 dbus_uint32_t *serial)
3279 _dbus_return_val_if_fail (connection != NULL, FALSE);
3280 _dbus_return_val_if_fail (message != NULL, FALSE);
3282 CONNECTION_LOCK (connection);
3284 #ifdef HAVE_UNIX_FD_PASSING
3286 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3287 message->n_unix_fds > 0)
3289 /* Refuse to send fds on a connection that cannot handle
3290 them. Unfortunately we cannot return a proper error here, so
3291 the best we can is just return. */
3292 CONNECTION_UNLOCK (connection);
3298 return _dbus_connection_send_and_unlock (connection,
3304 reply_handler_timeout (void *data)
3306 DBusConnection *connection;
3307 DBusDispatchStatus status;
3308 DBusPendingCall *pending = data;
3310 connection = _dbus_pending_call_get_connection_and_lock (pending);
3311 _dbus_connection_ref_unlocked (connection);
3313 _dbus_pending_call_queue_timeout_error_unlocked (pending,
3315 _dbus_connection_remove_timeout_unlocked (connection,
3316 _dbus_pending_call_get_timeout_unlocked (pending));
3317 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
3319 _dbus_verbose ("middle\n");
3320 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3322 /* Unlocks, and calls out to user code */
3323 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3324 dbus_connection_unref (connection);
3330 * Queues a message to send, as with dbus_connection_send(),
3331 * but also returns a #DBusPendingCall used to receive a reply to the
3332 * message. If no reply is received in the given timeout_milliseconds,
3333 * this function expires the pending reply and generates a synthetic
3334 * error reply (generated in-process, not by the remote application)
3335 * indicating that a timeout occurred.
3337 * A #DBusPendingCall will see a reply message before any filters or
3338 * registered object path handlers. See dbus_connection_dispatch() for
3339 * details on when handlers are run.
3341 * A #DBusPendingCall will always see exactly one reply message,
3342 * unless it's cancelled with dbus_pending_call_cancel().
3344 * If #NULL is passed for the pending_return, the #DBusPendingCall
3345 * will still be generated internally, and used to track
3346 * the message reply timeout. This means a timeout error will
3347 * occur if no reply arrives, unlike with dbus_connection_send().
3349 * If -1 is passed for the timeout, a sane default timeout is used. -1
3350 * is typically the best value for the timeout for this reason, unless
3351 * you want a very short or very long timeout. If #DBUS_TIMEOUT_INFINITE is
3352 * passed for the timeout, no timeout will be set and the call will block
3355 * @warning if the connection is disconnected or you try to send Unix
3356 * file descriptors on a connection that does not support them, the
3357 * #DBusPendingCall will be set to #NULL, so be careful with this.
3359 * @param connection the connection
3360 * @param message the message to send
3361 * @param pending_return return location for a #DBusPendingCall
3362 * object, or #NULL if connection is disconnected or when you try to
3363 * send Unix file descriptors on a connection that does not support
3365 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3366 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3368 * @returns #FALSE if no memory, #TRUE otherwise.
3372 dbus_connection_send_with_reply (DBusConnection *connection,
3373 DBusMessage *message,
3374 DBusPendingCall **pending_return,
3375 int timeout_milliseconds)
3377 DBusPendingCall *pending;
3378 dbus_int32_t serial = -1;
3379 DBusDispatchStatus status;
3381 _dbus_return_val_if_fail (connection != NULL, FALSE);
3382 _dbus_return_val_if_fail (message != NULL, FALSE);
3383 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3386 *pending_return = NULL;
3388 CONNECTION_LOCK (connection);
3390 #ifdef HAVE_UNIX_FD_PASSING
3392 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3393 message->n_unix_fds > 0)
3395 /* Refuse to send fds on a connection that cannot handle
3396 them. Unfortunately we cannot return a proper error here, so
3397 the best we can do is return TRUE but leave *pending_return
3399 CONNECTION_UNLOCK (connection);
3405 if (!_dbus_connection_get_is_connected_unlocked (connection))
3407 CONNECTION_UNLOCK (connection);
3412 pending = _dbus_pending_call_new_unlocked (connection,
3413 timeout_milliseconds,
3414 reply_handler_timeout);
3416 if (pending == NULL)
3418 CONNECTION_UNLOCK (connection);
3422 /* Assign a serial to the message */
3423 serial = dbus_message_get_serial (message);
3426 serial = _dbus_connection_get_next_client_serial (connection);
3427 dbus_message_set_serial (message, serial);
3430 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3433 /* Insert the serial in the pending replies hash;
3434 * hash takes a refcount on DBusPendingCall.
3435 * Also, add the timeout.
3437 if (!_dbus_connection_attach_pending_call_unlocked (connection,
3441 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3443 _dbus_connection_detach_pending_call_and_unlock (connection,
3445 goto error_unlocked;
3449 *pending_return = pending; /* hand off refcount */
3452 _dbus_connection_detach_pending_call_unlocked (connection, pending);
3453 /* we still have a ref to the pending call in this case, we unref
3454 * after unlocking, below
3458 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3460 /* this calls out to user code */
3461 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3463 if (pending_return == NULL)
3464 dbus_pending_call_unref (pending);
3469 CONNECTION_UNLOCK (connection);
3471 dbus_pending_call_unref (pending);
3476 * Sends a message and blocks a certain time period while waiting for
3477 * a reply. This function does not reenter the main loop,
3478 * i.e. messages other than the reply are queued up but not
3479 * processed. This function is used to invoke method calls on a
3482 * If a normal reply is received, it is returned, and removed from the
3483 * incoming message queue. If it is not received, #NULL is returned
3484 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3485 * received, it is converted to a #DBusError and returned as an error,
3486 * then the reply message is deleted and #NULL is returned. If
3487 * something else goes wrong, result is set to whatever is
3488 * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3489 * #DBUS_ERROR_DISCONNECTED.
3491 * @warning While this function blocks the calling thread will not be
3492 * processing the incoming message queue. This means you can end up
3493 * deadlocked if the application you're talking to needs you to reply
3494 * to a method. To solve this, either avoid the situation, block in a
3495 * separate thread from the main connection-dispatching thread, or use
3496 * dbus_pending_call_set_notify() to avoid blocking.
3498 * @param connection the connection
3499 * @param message the message to send
3500 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3501 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3503 * @param error return location for error message
3504 * @returns the message that is the reply or #NULL with an error code if the
3508 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3509 DBusMessage *message,
3510 int timeout_milliseconds,
3514 DBusPendingCall *pending;
3516 _dbus_return_val_if_fail (connection != NULL, NULL);
3517 _dbus_return_val_if_fail (message != NULL, NULL);
3518 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3519 _dbus_return_val_if_error_is_set (error, NULL);
3521 #ifdef HAVE_UNIX_FD_PASSING
3523 CONNECTION_LOCK (connection);
3524 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3525 message->n_unix_fds > 0)
3527 CONNECTION_UNLOCK (connection);
3528 dbus_set_error(error, DBUS_ERROR_FAILED, "Cannot send file descriptors on this connection.");
3531 CONNECTION_UNLOCK (connection);
3535 if (!dbus_connection_send_with_reply (connection, message,
3536 &pending, timeout_milliseconds))
3538 _DBUS_SET_OOM (error);
3542 if (pending == NULL)
3544 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3548 dbus_pending_call_block (pending);
3550 reply = dbus_pending_call_steal_reply (pending);
3551 dbus_pending_call_unref (pending);
3553 /* call_complete_and_unlock() called from pending_call_block() should
3554 * always fill this in.
3556 _dbus_assert (reply != NULL);
3558 if (dbus_set_error_from_message (error, reply))
3560 dbus_message_unref (reply);
3568 * Blocks until the outgoing message queue is empty.
3569 * Assumes connection lock already held.
3571 * If you call this, you MUST call update_dispatch_status afterword...
3573 * @param connection the connection.
3575 static DBusDispatchStatus
3576 _dbus_connection_flush_unlocked (DBusConnection *connection)
3578 /* We have to specify DBUS_ITERATION_DO_READING here because
3579 * otherwise we could have two apps deadlock if they are both doing
3580 * a flush(), and the kernel buffers fill up. This could change the
3583 DBusDispatchStatus status;
3585 HAVE_LOCK_CHECK (connection);
3587 while (connection->n_outgoing > 0 &&
3588 _dbus_connection_get_is_connected_unlocked (connection))
3590 _dbus_verbose ("doing iteration in\n");
3591 HAVE_LOCK_CHECK (connection);
3592 _dbus_connection_do_iteration_unlocked (connection,
3594 DBUS_ITERATION_DO_READING |
3595 DBUS_ITERATION_DO_WRITING |
3596 DBUS_ITERATION_BLOCK,
3600 HAVE_LOCK_CHECK (connection);
3601 _dbus_verbose ("middle\n");
3602 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3604 HAVE_LOCK_CHECK (connection);
3609 * Blocks until the outgoing message queue is empty.
3611 * @param connection the connection.
3614 dbus_connection_flush (DBusConnection *connection)
3616 /* We have to specify DBUS_ITERATION_DO_READING here because
3617 * otherwise we could have two apps deadlock if they are both doing
3618 * a flush(), and the kernel buffers fill up. This could change the
3621 DBusDispatchStatus status;
3623 _dbus_return_if_fail (connection != NULL);
3625 CONNECTION_LOCK (connection);
3627 status = _dbus_connection_flush_unlocked (connection);
3629 HAVE_LOCK_CHECK (connection);
3630 /* Unlocks and calls out to user code */
3631 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3633 _dbus_verbose ("end\n");
3637 * This function implements dbus_connection_read_write_dispatch() and
3638 * dbus_connection_read_write() (they pass a different value for the
3639 * dispatch parameter).
3641 * @param connection the connection
3642 * @param timeout_milliseconds max time to block or -1 for infinite
3643 * @param dispatch dispatch new messages or leave them on the incoming queue
3644 * @returns #TRUE if the disconnect message has not been processed
3647 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3648 int timeout_milliseconds,
3649 dbus_bool_t dispatch)
3651 DBusDispatchStatus dstatus;
3652 dbus_bool_t progress_possible;
3654 /* Need to grab a ref here in case we're a private connection and
3655 * the user drops the last ref in a handler we call; see bug
3656 * https://bugs.freedesktop.org/show_bug.cgi?id=15635
3658 dbus_connection_ref (connection);
3659 dstatus = dbus_connection_get_dispatch_status (connection);
3661 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3663 _dbus_verbose ("doing dispatch\n");
3664 dbus_connection_dispatch (connection);
3665 CONNECTION_LOCK (connection);
3667 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3669 _dbus_verbose ("pausing for memory\n");
3670 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3671 CONNECTION_LOCK (connection);
3675 CONNECTION_LOCK (connection);
3676 if (_dbus_connection_get_is_connected_unlocked (connection))
3678 _dbus_verbose ("doing iteration\n");
3679 _dbus_connection_do_iteration_unlocked (connection,
3681 DBUS_ITERATION_DO_READING |
3682 DBUS_ITERATION_DO_WRITING |
3683 DBUS_ITERATION_BLOCK,
3684 timeout_milliseconds);
3688 HAVE_LOCK_CHECK (connection);
3689 /* If we can dispatch, we can make progress until the Disconnected message
3690 * has been processed; if we can only read/write, we can make progress
3691 * as long as the transport is open.
3694 progress_possible = connection->n_incoming != 0 ||
3695 connection->disconnect_message_link != NULL;
3697 progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3699 CONNECTION_UNLOCK (connection);
3701 dbus_connection_unref (connection);
3703 return progress_possible; /* TRUE if we can make more progress */
3708 * This function is intended for use with applications that don't want
3709 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3710 * example usage would be:
3713 * while (dbus_connection_read_write_dispatch (connection, -1))
3714 * ; // empty loop body
3717 * In this usage you would normally have set up a filter function to look
3718 * at each message as it is dispatched. The loop terminates when the last
3719 * message from the connection (the disconnected signal) is processed.
3721 * If there are messages to dispatch, this function will
3722 * dbus_connection_dispatch() once, and return. If there are no
3723 * messages to dispatch, this function will block until it can read or
3724 * write, then read or write, then return.
3726 * The way to think of this function is that it either makes some sort
3727 * of progress, or it blocks. Note that, while it is blocked on I/O, it
3728 * cannot be interrupted (even by other threads), which makes this function
3729 * unsuitable for applications that do more than just react to received
3732 * The return value indicates whether the disconnect message has been
3733 * processed, NOT whether the connection is connected. This is
3734 * important because even after disconnecting, you want to process any
3735 * messages you received prior to the disconnect.
3737 * @param connection the connection
3738 * @param timeout_milliseconds max time to block or -1 for infinite
3739 * @returns #TRUE if the disconnect message has not been processed
3742 dbus_connection_read_write_dispatch (DBusConnection *connection,
3743 int timeout_milliseconds)
3745 _dbus_return_val_if_fail (connection != NULL, FALSE);
3746 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3747 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3751 * This function is intended for use with applications that don't want to
3752 * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3753 * dbus_connection_read_write_dispatch().
3755 * As long as the connection is open, this function will block until it can
3756 * read or write, then read or write, then return #TRUE.
3758 * If the connection is closed, the function returns #FALSE.
3760 * The return value indicates whether reading or writing is still
3761 * possible, i.e. whether the connection is connected.
3763 * Note that even after disconnection, messages may remain in the
3764 * incoming queue that need to be
3765 * processed. dbus_connection_read_write_dispatch() dispatches
3766 * incoming messages for you; with dbus_connection_read_write() you
3767 * have to arrange to drain the incoming queue yourself.
3769 * @param connection the connection
3770 * @param timeout_milliseconds max time to block or -1 for infinite
3771 * @returns #TRUE if still connected
3774 dbus_connection_read_write (DBusConnection *connection,
3775 int timeout_milliseconds)
3777 _dbus_return_val_if_fail (connection != NULL, FALSE);
3778 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3779 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3782 /* We need to call this anytime we pop the head of the queue, and then
3783 * update_dispatch_status_and_unlock needs to be called afterward
3784 * which will "process" the disconnected message and set
3785 * disconnected_message_processed.
3788 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3789 DBusMessage *head_of_queue)
3791 HAVE_LOCK_CHECK (connection);
3793 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3794 if (connection->disconnect_message_link == NULL &&
3795 dbus_message_is_signal (head_of_queue,
3796 DBUS_INTERFACE_LOCAL,
3799 connection->disconnected_message_arrived = TRUE;
3804 * Returns the first-received message from the incoming message queue,
3805 * leaving it in the queue. If the queue is empty, returns #NULL.
3807 * The caller does not own a reference to the returned message, and
3808 * must either return it using dbus_connection_return_message() or
3809 * keep it after calling dbus_connection_steal_borrowed_message(). No
3810 * one can get at the message while its borrowed, so return it as
3811 * quickly as possible and don't keep a reference to it after
3812 * returning it. If you need to keep the message, make a copy of it.
3814 * dbus_connection_dispatch() will block if called while a borrowed
3815 * message is outstanding; only one piece of code can be playing with
3816 * the incoming queue at a time. This function will block if called
3817 * during a dbus_connection_dispatch().
3819 * @param connection the connection.
3820 * @returns next message in the incoming queue.
3823 dbus_connection_borrow_message (DBusConnection *connection)
3825 DBusDispatchStatus status;
3826 DBusMessage *message;
3828 _dbus_return_val_if_fail (connection != NULL, NULL);
3830 _dbus_verbose ("start\n");
3832 /* this is called for the side effect that it queues
3833 * up any messages from the transport
3835 status = dbus_connection_get_dispatch_status (connection);
3836 if (status != DBUS_DISPATCH_DATA_REMAINS)
3839 CONNECTION_LOCK (connection);
3841 _dbus_connection_acquire_dispatch (connection);
3843 /* While a message is outstanding, the dispatch lock is held */
3844 _dbus_assert (connection->message_borrowed == NULL);
3846 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3848 message = connection->message_borrowed;
3850 check_disconnected_message_arrived_unlocked (connection, message);
3852 /* Note that we KEEP the dispatch lock until the message is returned */
3853 if (message == NULL)
3854 _dbus_connection_release_dispatch (connection);
3856 CONNECTION_UNLOCK (connection);
3858 _dbus_message_trace_ref (message, -1, -1, "dbus_connection_borrow_message");
3860 /* We don't update dispatch status until it's returned or stolen */
3866 * Used to return a message after peeking at it using
3867 * dbus_connection_borrow_message(). Only called if
3868 * message from dbus_connection_borrow_message() was non-#NULL.
3870 * @param connection the connection
3871 * @param message the message from dbus_connection_borrow_message()
3874 dbus_connection_return_message (DBusConnection *connection,
3875 DBusMessage *message)
3877 DBusDispatchStatus status;
3879 _dbus_return_if_fail (connection != NULL);
3880 _dbus_return_if_fail (message != NULL);
3881 _dbus_return_if_fail (message == connection->message_borrowed);
3882 _dbus_return_if_fail (connection->dispatch_acquired);
3884 CONNECTION_LOCK (connection);
3886 _dbus_assert (message == connection->message_borrowed);
3888 connection->message_borrowed = NULL;
3890 _dbus_connection_release_dispatch (connection);
3892 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3893 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3895 _dbus_message_trace_ref (message, -1, -1, "dbus_connection_return_message");
3899 * Used to keep a message after peeking at it using
3900 * dbus_connection_borrow_message(). Before using this function, see
3901 * the caveats/warnings in the documentation for
3902 * dbus_connection_pop_message().
3904 * @param connection the connection
3905 * @param message the message from dbus_connection_borrow_message()
3908 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3909 DBusMessage *message)
3911 DBusMessage *pop_message;
3912 DBusDispatchStatus status;
3914 _dbus_return_if_fail (connection != NULL);
3915 _dbus_return_if_fail (message != NULL);
3916 _dbus_return_if_fail (message == connection->message_borrowed);
3917 _dbus_return_if_fail (connection->dispatch_acquired);
3919 CONNECTION_LOCK (connection);
3921 _dbus_assert (message == connection->message_borrowed);
3923 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3924 _dbus_assert (message == pop_message);
3925 (void) pop_message; /* unused unless asserting */
3927 connection->n_incoming -= 1;
3929 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3930 message, connection->n_incoming);
3932 connection->message_borrowed = NULL;
3934 _dbus_connection_release_dispatch (connection);
3936 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3937 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3938 _dbus_message_trace_ref (message, -1, -1,
3939 "dbus_connection_steal_borrowed_message");
3942 /* See dbus_connection_pop_message, but requires the caller to own
3943 * the lock before calling. May drop the lock while running.
3946 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3948 HAVE_LOCK_CHECK (connection);
3950 _dbus_assert (connection->message_borrowed == NULL);
3952 if (connection->n_incoming > 0)
3956 link = _dbus_list_pop_first_link (&connection->incoming_messages);
3957 connection->n_incoming -= 1;
3959 _dbus_verbose ("Message %p (%s %s %s %s sig:'%s' serial:%u) removed from incoming queue %p, %d incoming\n",
3961 dbus_message_type_to_string (dbus_message_get_type (link->data)),
3962 dbus_message_get_path (link->data) ?
3963 dbus_message_get_path (link->data) :
3965 dbus_message_get_interface (link->data) ?
3966 dbus_message_get_interface (link->data) :
3968 dbus_message_get_member (link->data) ?
3969 dbus_message_get_member (link->data) :
3971 dbus_message_get_signature (link->data),
3972 dbus_message_get_serial (link->data),
3973 connection, connection->n_incoming);
3975 _dbus_message_trace_ref (link->data, -1, -1,
3976 "_dbus_connection_pop_message_link_unlocked");
3978 check_disconnected_message_arrived_unlocked (connection, link->data);
3986 /* See dbus_connection_pop_message, but requires the caller to own
3987 * the lock before calling. May drop the lock while running.
3990 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3994 HAVE_LOCK_CHECK (connection);
3996 link = _dbus_connection_pop_message_link_unlocked (connection);
4000 DBusMessage *message;
4002 message = link->data;
4004 _dbus_list_free_link (link);
4013 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
4014 DBusList *message_link)
4016 HAVE_LOCK_CHECK (connection);
4018 _dbus_assert (message_link != NULL);
4019 /* You can't borrow a message while a link is outstanding */
4020 _dbus_assert (connection->message_borrowed == NULL);
4021 /* We had to have the dispatch lock across the pop/putback */
4022 _dbus_assert (connection->dispatch_acquired);
4024 _dbus_list_prepend_link (&connection->incoming_messages,
4026 connection->n_incoming += 1;
4028 _dbus_verbose ("Message %p (%s %s %s '%s') put back into queue %p, %d incoming\n",
4030 dbus_message_type_to_string (dbus_message_get_type (message_link->data)),
4031 dbus_message_get_interface (message_link->data) ?
4032 dbus_message_get_interface (message_link->data) :
4034 dbus_message_get_member (message_link->data) ?
4035 dbus_message_get_member (message_link->data) :
4037 dbus_message_get_signature (message_link->data),
4038 connection, connection->n_incoming);
4040 _dbus_message_trace_ref (message_link->data, -1, -1,
4041 "_dbus_connection_putback_message_link_unlocked");
4045 * Returns the first-received message from the incoming message queue,
4046 * removing it from the queue. The caller owns a reference to the
4047 * returned message. If the queue is empty, returns #NULL.
4049 * This function bypasses any message handlers that are registered,
4050 * and so using it is usually wrong. Instead, let the main loop invoke
4051 * dbus_connection_dispatch(). Popping messages manually is only
4052 * useful in very simple programs that don't share a #DBusConnection
4053 * with any libraries or other modules.
4055 * There is a lock that covers all ways of accessing the incoming message
4056 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
4057 * dbus_connection_borrow_message(), etc. will all block while one of the others
4058 * in the group is running.
4060 * @param connection the connection.
4061 * @returns next message in the incoming queue.
4064 dbus_connection_pop_message (DBusConnection *connection)
4066 DBusMessage *message;
4067 DBusDispatchStatus status;
4069 _dbus_verbose ("start\n");
4071 /* this is called for the side effect that it queues
4072 * up any messages from the transport
4074 status = dbus_connection_get_dispatch_status (connection);
4075 if (status != DBUS_DISPATCH_DATA_REMAINS)
4078 CONNECTION_LOCK (connection);
4079 _dbus_connection_acquire_dispatch (connection);
4080 HAVE_LOCK_CHECK (connection);
4082 message = _dbus_connection_pop_message_unlocked (connection);
4084 _dbus_verbose ("Returning popped message %p\n", message);
4086 _dbus_connection_release_dispatch (connection);
4088 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4089 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4095 * Acquire the dispatcher. This is a separate lock so the main
4096 * connection lock can be dropped to call out to application dispatch
4099 * @param connection the connection.
4102 _dbus_connection_acquire_dispatch (DBusConnection *connection)
4104 HAVE_LOCK_CHECK (connection);
4106 _dbus_connection_ref_unlocked (connection);
4107 CONNECTION_UNLOCK (connection);
4109 _dbus_verbose ("locking dispatch_mutex\n");
4110 _dbus_cmutex_lock (connection->dispatch_mutex);
4112 while (connection->dispatch_acquired)
4114 _dbus_verbose ("waiting for dispatch to be acquirable\n");
4115 _dbus_condvar_wait (connection->dispatch_cond,
4116 connection->dispatch_mutex);
4119 _dbus_assert (!connection->dispatch_acquired);
4121 connection->dispatch_acquired = TRUE;
4123 _dbus_verbose ("unlocking dispatch_mutex\n");
4124 _dbus_cmutex_unlock (connection->dispatch_mutex);
4126 CONNECTION_LOCK (connection);
4127 _dbus_connection_unref_unlocked (connection);
4131 * Release the dispatcher when you're done with it. Only call
4132 * after you've acquired the dispatcher. Wakes up at most one
4133 * thread currently waiting to acquire the dispatcher.
4135 * @param connection the connection.
4138 _dbus_connection_release_dispatch (DBusConnection *connection)
4140 HAVE_LOCK_CHECK (connection);
4142 _dbus_verbose ("locking dispatch_mutex\n");
4143 _dbus_cmutex_lock (connection->dispatch_mutex);
4145 _dbus_assert (connection->dispatch_acquired);
4147 connection->dispatch_acquired = FALSE;
4148 _dbus_condvar_wake_one (connection->dispatch_cond);
4150 _dbus_verbose ("unlocking dispatch_mutex\n");
4151 _dbus_cmutex_unlock (connection->dispatch_mutex);
4155 _dbus_connection_failed_pop (DBusConnection *connection,
4156 DBusList *message_link)
4158 _dbus_list_prepend_link (&connection->incoming_messages,
4160 connection->n_incoming += 1;
4163 /* Note this may be called multiple times since we don't track whether we already did it */
4165 notify_disconnected_unlocked (DBusConnection *connection)
4167 HAVE_LOCK_CHECK (connection);
4169 /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
4170 * connection from dbus_bus_get(). We make the same guarantee for
4171 * dbus_connection_open() but in a different way since we don't want to
4172 * unref right here; we instead check for connectedness before returning
4173 * the connection from the hash.
4175 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
4177 /* Dump the outgoing queue, we aren't going to be able to
4178 * send it now, and we'd like accessors like
4179 * dbus_connection_get_outgoing_size() to be accurate.
4181 if (connection->n_outgoing > 0)
4185 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
4186 connection->n_outgoing);
4188 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
4190 _dbus_connection_message_sent_unlocked (connection, link->data);
4195 /* Note this may be called multiple times since we don't track whether we already did it */
4196 static DBusDispatchStatus
4197 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
4199 HAVE_LOCK_CHECK (connection);
4201 if (connection->disconnect_message_link != NULL)
4203 _dbus_verbose ("Sending disconnect message\n");
4205 /* If we have pending calls, queue their timeouts - we want the Disconnected
4206 * to be the last message, after these timeouts.
4208 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
4210 /* We haven't sent the disconnect message already,
4211 * and all real messages have been queued up.
4213 _dbus_connection_queue_synthesized_message_link (connection,
4214 connection->disconnect_message_link);
4215 connection->disconnect_message_link = NULL;
4217 return DBUS_DISPATCH_DATA_REMAINS;
4220 return DBUS_DISPATCH_COMPLETE;
4223 static DBusDispatchStatus
4224 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
4226 HAVE_LOCK_CHECK (connection);
4228 if (connection->n_incoming > 0)
4229 return DBUS_DISPATCH_DATA_REMAINS;
4230 else if (!_dbus_transport_queue_messages (connection->transport))
4231 return DBUS_DISPATCH_NEED_MEMORY;
4234 DBusDispatchStatus status;
4235 dbus_bool_t is_connected;
4237 status = _dbus_transport_get_dispatch_status (connection->transport);
4238 is_connected = _dbus_transport_get_is_connected (connection->transport);
4240 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
4241 DISPATCH_STATUS_NAME (status), is_connected);
4245 /* It's possible this would be better done by having an explicit
4246 * notification from _dbus_transport_disconnect() that would
4247 * synchronously do this, instead of waiting for the next dispatch
4248 * status check. However, probably not good to change until it causes
4251 notify_disconnected_unlocked (connection);
4253 /* I'm not sure this is needed; the idea is that we want to
4254 * queue the Disconnected only after we've read all the
4255 * messages, but if we're disconnected maybe we are guaranteed
4256 * to have read them all ?
4258 if (status == DBUS_DISPATCH_COMPLETE)
4259 status = notify_disconnected_and_dispatch_complete_unlocked (connection);
4262 if (status != DBUS_DISPATCH_COMPLETE)
4264 else if (connection->n_incoming > 0)
4265 return DBUS_DISPATCH_DATA_REMAINS;
4267 return DBUS_DISPATCH_COMPLETE;
4272 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
4273 DBusDispatchStatus new_status)
4275 dbus_bool_t changed;
4276 DBusDispatchStatusFunction function;
4279 HAVE_LOCK_CHECK (connection);
4281 _dbus_connection_ref_unlocked (connection);
4283 changed = new_status != connection->last_dispatch_status;
4285 connection->last_dispatch_status = new_status;
4287 function = connection->dispatch_status_function;
4288 data = connection->dispatch_status_data;
4290 if (connection->disconnected_message_arrived &&
4291 !connection->disconnected_message_processed)
4293 connection->disconnected_message_processed = TRUE;
4295 /* this does an unref, but we have a ref
4296 * so we should not run the finalizer here
4299 connection_forget_shared_unlocked (connection);
4301 if (connection->exit_on_disconnect)
4303 CONNECTION_UNLOCK (connection);
4305 _dbus_verbose ("Exiting on Disconnected signal\n");
4307 _dbus_assert_not_reached ("Call to exit() returned");
4311 /* We drop the lock */
4312 CONNECTION_UNLOCK (connection);
4314 if (changed && function)
4316 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
4317 connection, new_status,
4318 DISPATCH_STATUS_NAME (new_status));
4319 (* function) (connection, new_status, data);
4322 dbus_connection_unref (connection);
4326 * Gets the current state of the incoming message queue.
4327 * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
4328 * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
4329 * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
4330 * there could be data, but we can't know for sure without more
4333 * To process the incoming message queue, use dbus_connection_dispatch()
4334 * or (in rare cases) dbus_connection_pop_message().
4336 * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
4337 * have messages in the queue, or we have raw bytes buffered up
4338 * that need to be parsed. When these bytes are parsed, they
4339 * may not add up to an entire message. Thus, it's possible
4340 * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
4341 * have a message yet.
4343 * In particular this happens on initial connection, because all sorts
4344 * of authentication protocol stuff has to be parsed before the
4345 * first message arrives.
4347 * @param connection the connection.
4348 * @returns current dispatch status
4351 dbus_connection_get_dispatch_status (DBusConnection *connection)
4353 DBusDispatchStatus status;
4355 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4357 _dbus_verbose ("start\n");
4359 CONNECTION_LOCK (connection);
4361 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4363 CONNECTION_UNLOCK (connection);
4369 * Filter funtion for handling the Peer standard interface.
4371 static DBusHandlerResult
4372 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
4373 DBusMessage *message)
4375 dbus_bool_t sent = FALSE;
4376 DBusMessage *ret = NULL;
4377 DBusList *expire_link;
4379 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
4381 /* This means we're letting the bus route this message */
4382 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4385 if (!dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4387 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4390 /* Preallocate a linked-list link, so that if we need to dispose of a
4391 * message, we can attach it to the expired list */
4392 expire_link = _dbus_list_alloc_link (NULL);
4395 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4397 if (dbus_message_is_method_call (message,
4398 DBUS_INTERFACE_PEER,
4401 ret = dbus_message_new_method_return (message);
4405 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4407 else if (dbus_message_is_method_call (message,
4408 DBUS_INTERFACE_PEER,
4413 ret = dbus_message_new_method_return (message);
4417 _dbus_string_init (&uuid);
4418 if (_dbus_get_local_machine_uuid_encoded (&uuid))
4420 const char *v_STRING = _dbus_string_get_const_data (&uuid);
4421 if (dbus_message_append_args (ret,
4422 DBUS_TYPE_STRING, &v_STRING,
4425 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4428 _dbus_string_free (&uuid);
4432 /* We need to bounce anything else with this interface, otherwise apps
4433 * could start extending the interface and when we added extensions
4434 * here to DBusConnection we'd break those apps.
4436 ret = dbus_message_new_error (message,
4437 DBUS_ERROR_UNKNOWN_METHOD,
4438 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4442 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4448 _dbus_list_free_link (expire_link);
4452 /* It'll be safe to unref the reply when we unlock */
4453 expire_link->data = ret;
4454 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4458 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4460 return DBUS_HANDLER_RESULT_HANDLED;
4464 * Processes all builtin filter functions
4466 * If the spec specifies a standard interface
4467 * they should be processed from this method
4469 static DBusHandlerResult
4470 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4471 DBusMessage *message)
4473 /* We just run one filter for now but have the option to run more
4474 if the spec calls for it in the future */
4476 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4480 * Processes any incoming data.
4482 * If there's incoming raw data that has not yet been parsed, it is
4483 * parsed, which may or may not result in adding messages to the
4486 * The incoming data buffer is filled when the connection reads from
4487 * its underlying transport (such as a socket). Reading usually
4488 * happens in dbus_watch_handle() or dbus_connection_read_write().
4490 * If there are complete messages in the incoming queue,
4491 * dbus_connection_dispatch() removes one message from the queue and
4492 * processes it. Processing has three steps.
4494 * First, any method replies are passed to #DBusPendingCall or
4495 * dbus_connection_send_with_reply_and_block() in order to
4496 * complete the pending method call.
4498 * Second, any filters registered with dbus_connection_add_filter()
4499 * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4500 * then processing stops after that filter.
4502 * Third, if the message is a method call it is forwarded to
4503 * any registered object path handlers added with
4504 * dbus_connection_register_object_path() or
4505 * dbus_connection_register_fallback().
4507 * A single call to dbus_connection_dispatch() will process at most
4508 * one message; it will not clear the entire message queue.
4510 * Be careful about calling dbus_connection_dispatch() from inside a
4511 * message handler, i.e. calling dbus_connection_dispatch()
4512 * recursively. If threads have been initialized with a recursive
4513 * mutex function, then this will not deadlock; however, it can
4514 * certainly confuse your application.
4516 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4518 * @param connection the connection
4519 * @returns dispatch status, see dbus_connection_get_dispatch_status()
4522 dbus_connection_dispatch (DBusConnection *connection)
4524 DBusMessage *message;
4525 DBusList *link, *filter_list_copy, *message_link;
4526 DBusHandlerResult result;
4527 DBusPendingCall *pending;
4528 dbus_int32_t reply_serial;
4529 DBusDispatchStatus status;
4530 dbus_bool_t found_object;
4532 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4534 _dbus_verbose ("\n");
4536 CONNECTION_LOCK (connection);
4537 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4538 if (status != DBUS_DISPATCH_DATA_REMAINS)
4540 /* unlocks and calls out to user code */
4541 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4545 /* We need to ref the connection since the callback could potentially
4546 * drop the last ref to it
4548 _dbus_connection_ref_unlocked (connection);
4550 _dbus_connection_acquire_dispatch (connection);
4551 HAVE_LOCK_CHECK (connection);
4553 message_link = _dbus_connection_pop_message_link_unlocked (connection);
4554 if (message_link == NULL)
4556 /* another thread dispatched our stuff */
4558 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4560 _dbus_connection_release_dispatch (connection);
4562 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4564 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4566 dbus_connection_unref (connection);
4571 message = message_link->data;
4573 _dbus_verbose (" dispatching message %p (%s %s %s '%s')\n",
4575 dbus_message_type_to_string (dbus_message_get_type (message)),
4576 dbus_message_get_interface (message) ?
4577 dbus_message_get_interface (message) :
4579 dbus_message_get_member (message) ?
4580 dbus_message_get_member (message) :
4582 dbus_message_get_signature (message));
4584 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4586 /* Pending call handling must be first, because if you do
4587 * dbus_connection_send_with_reply_and_block() or
4588 * dbus_pending_call_block() then no handlers/filters will be run on
4589 * the reply. We want consistent semantics in the case where we
4590 * dbus_connection_dispatch() the reply.
4593 reply_serial = dbus_message_get_reply_serial (message);
4594 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4598 _dbus_verbose ("Dispatching a pending reply\n");
4599 complete_pending_call_and_unlock (connection, pending, message);
4600 pending = NULL; /* it's probably unref'd */
4602 CONNECTION_LOCK (connection);
4603 _dbus_verbose ("pending call completed in dispatch\n");
4604 result = DBUS_HANDLER_RESULT_HANDLED;
4608 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4609 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4612 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4614 _dbus_connection_release_dispatch (connection);
4615 HAVE_LOCK_CHECK (connection);
4617 _dbus_connection_failed_pop (connection, message_link);
4619 /* unlocks and calls user code */
4620 _dbus_connection_update_dispatch_status_and_unlock (connection,
4621 DBUS_DISPATCH_NEED_MEMORY);
4622 dbus_connection_unref (connection);
4624 return DBUS_DISPATCH_NEED_MEMORY;
4627 _dbus_list_foreach (&filter_list_copy,
4628 (DBusForeachFunction)_dbus_message_filter_ref,
4631 /* We're still protected from dispatch() reentrancy here
4632 * since we acquired the dispatcher
4634 CONNECTION_UNLOCK (connection);
4636 link = _dbus_list_get_first_link (&filter_list_copy);
4637 while (link != NULL)
4639 DBusMessageFilter *filter = link->data;
4640 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4642 if (filter->function == NULL)
4644 _dbus_verbose (" filter was removed in a callback function\n");
4649 _dbus_verbose (" running filter on message %p\n", message);
4650 result = (* filter->function) (connection, message, filter->user_data);
4652 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4658 _dbus_list_foreach (&filter_list_copy,
4659 (DBusForeachFunction)_dbus_message_filter_unref,
4661 _dbus_list_clear (&filter_list_copy);
4663 CONNECTION_LOCK (connection);
4665 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4667 _dbus_verbose ("No memory\n");
4670 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4672 _dbus_verbose ("filter handled message in dispatch\n");
4676 /* We're still protected from dispatch() reentrancy here
4677 * since we acquired the dispatcher
4679 _dbus_verbose (" running object path dispatch on message %p (%s %s %s '%s')\n",
4681 dbus_message_type_to_string (dbus_message_get_type (message)),
4682 dbus_message_get_interface (message) ?
4683 dbus_message_get_interface (message) :
4685 dbus_message_get_member (message) ?
4686 dbus_message_get_member (message) :
4688 dbus_message_get_signature (message));
4690 HAVE_LOCK_CHECK (connection);
4691 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4695 CONNECTION_LOCK (connection);
4697 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4699 _dbus_verbose ("object tree handled message in dispatch\n");
4703 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4707 DBusPreallocatedSend *preallocated;
4708 DBusList *expire_link;
4710 _dbus_verbose (" sending error %s\n",
4711 DBUS_ERROR_UNKNOWN_METHOD);
4713 if (!_dbus_string_init (&str))
4715 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4716 _dbus_verbose ("no memory for error string in dispatch\n");
4720 if (!_dbus_string_append_printf (&str,
4721 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4722 dbus_message_get_member (message),
4723 dbus_message_get_signature (message),
4724 dbus_message_get_interface (message)))
4726 _dbus_string_free (&str);
4727 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4728 _dbus_verbose ("no memory for error string in dispatch\n");
4732 reply = dbus_message_new_error (message,
4733 found_object ? DBUS_ERROR_UNKNOWN_METHOD : DBUS_ERROR_UNKNOWN_OBJECT,
4734 _dbus_string_get_const_data (&str));
4735 _dbus_string_free (&str);
4739 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4740 _dbus_verbose ("no memory for error reply in dispatch\n");
4744 expire_link = _dbus_list_alloc_link (reply);
4746 if (expire_link == NULL)
4748 dbus_message_unref (reply);
4749 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4750 _dbus_verbose ("no memory for error send in dispatch\n");
4754 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4756 if (preallocated == NULL)
4758 _dbus_list_free_link (expire_link);
4759 /* It's OK that this is finalized, because it hasn't been seen by
4760 * anything that could attach user callbacks */
4761 dbus_message_unref (reply);
4762 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4763 _dbus_verbose ("no memory for error send in dispatch\n");
4767 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4769 /* reply will be freed when we release the lock */
4770 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4772 result = DBUS_HANDLER_RESULT_HANDLED;
4775 _dbus_verbose (" done dispatching %p (%s %s %s '%s') on connection %p\n", message,
4776 dbus_message_type_to_string (dbus_message_get_type (message)),
4777 dbus_message_get_interface (message) ?
4778 dbus_message_get_interface (message) :
4780 dbus_message_get_member (message) ?
4781 dbus_message_get_member (message) :
4783 dbus_message_get_signature (message),
4787 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4789 _dbus_verbose ("out of memory\n");
4791 /* Put message back, and we'll start over.
4792 * Yes this means handlers must be idempotent if they
4793 * don't return HANDLED; c'est la vie.
4795 _dbus_connection_putback_message_link_unlocked (connection,
4797 /* now we don't want to free them */
4798 message_link = NULL;
4803 _dbus_verbose (" ... done dispatching\n");
4806 _dbus_connection_release_dispatch (connection);
4807 HAVE_LOCK_CHECK (connection);
4809 if (message != NULL)
4811 /* We don't want this message to count in maximum message limits when
4812 * computing the dispatch status, below. We have to drop the lock
4813 * temporarily, because finalizing a message can trigger callbacks.
4815 * We have a reference to the connection, and we don't use any cached
4816 * pointers to the connection's internals below this point, so it should
4817 * be safe to drop the lock and take it back. */
4818 CONNECTION_UNLOCK (connection);
4819 dbus_message_unref (message);
4820 CONNECTION_LOCK (connection);
4823 if (message_link != NULL)
4824 _dbus_list_free_link (message_link);
4826 _dbus_verbose ("before final status update\n");
4827 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4829 /* unlocks and calls user code */
4830 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4832 dbus_connection_unref (connection);
4838 * Sets the watch functions for the connection. These functions are
4839 * responsible for making the application's main loop aware of file
4840 * descriptors that need to be monitored for events, using select() or
4841 * poll(). When using Qt, typically the DBusAddWatchFunction would
4842 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4843 * could call g_io_add_watch(), or could be used as part of a more
4844 * elaborate GSource. Note that when a watch is added, it may
4847 * The DBusWatchToggledFunction notifies the application that the
4848 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4849 * to check this. A disabled watch should have no effect, and enabled
4850 * watch should be added to the main loop. This feature is used
4851 * instead of simply adding/removing the watch because
4852 * enabling/disabling can be done without memory allocation. The
4853 * toggled function may be NULL if a main loop re-queries
4854 * dbus_watch_get_enabled() every time anyway.
4856 * The DBusWatch can be queried for the file descriptor to watch using
4857 * dbus_watch_get_unix_fd() or dbus_watch_get_socket(), and for the
4858 * events to watch for using dbus_watch_get_flags(). The flags
4859 * returned by dbus_watch_get_flags() will only contain
4860 * DBUS_WATCH_READABLE and DBUS_WATCH_WRITABLE, never
4861 * DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR; all watches implicitly
4862 * include a watch for hangups, errors, and other exceptional
4865 * Once a file descriptor becomes readable or writable, or an exception
4866 * occurs, dbus_watch_handle() should be called to
4867 * notify the connection of the file descriptor's condition.
4869 * dbus_watch_handle() cannot be called during the
4870 * DBusAddWatchFunction, as the connection will not be ready to handle
4873 * It is not allowed to reference a DBusWatch after it has been passed
4874 * to remove_function.
4876 * If #FALSE is returned due to lack of memory, the failure may be due
4877 * to a #FALSE return from the new add_function. If so, the
4878 * add_function may have been called successfully one or more times,
4879 * but the remove_function will also have been called to remove any
4880 * successful adds. i.e. if #FALSE is returned the net result
4881 * should be that dbus_connection_set_watch_functions() has no effect,
4882 * but the add_function and remove_function may have been called.
4884 * @note The thread lock on DBusConnection is held while
4885 * watch functions are invoked, so inside these functions you
4886 * may not invoke any methods on DBusConnection or it will deadlock.
4887 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/tread.html#8144
4888 * if you encounter this issue and want to attempt writing a patch.
4890 * @param connection the connection.
4891 * @param add_function function to begin monitoring a new descriptor.
4892 * @param remove_function function to stop monitoring a descriptor.
4893 * @param toggled_function function to notify of enable/disable
4894 * @param data data to pass to add_function and remove_function.
4895 * @param free_data_function function to be called to free the data.
4896 * @returns #FALSE on failure (no memory)
4899 dbus_connection_set_watch_functions (DBusConnection *connection,
4900 DBusAddWatchFunction add_function,
4901 DBusRemoveWatchFunction remove_function,
4902 DBusWatchToggledFunction toggled_function,
4904 DBusFreeFunction free_data_function)
4908 _dbus_return_val_if_fail (connection != NULL, FALSE);
4910 CONNECTION_LOCK (connection);
4912 retval = _dbus_watch_list_set_functions (connection->watches,
4913 add_function, remove_function,
4915 data, free_data_function);
4917 CONNECTION_UNLOCK (connection);
4923 * Sets the timeout functions for the connection. These functions are
4924 * responsible for making the application's main loop aware of timeouts.
4925 * When using Qt, typically the DBusAddTimeoutFunction would create a
4926 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4929 * The DBusTimeoutToggledFunction notifies the application that the
4930 * timeout has been enabled or disabled. Call
4931 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4932 * have no effect, and enabled timeout should be added to the main
4933 * loop. This feature is used instead of simply adding/removing the
4934 * timeout because enabling/disabling can be done without memory
4935 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4936 * to enable and disable. The toggled function may be NULL if a main
4937 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4938 * Whenever a timeout is toggled, its interval may change.
4940 * The DBusTimeout can be queried for the timer interval using
4941 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4942 * repeatedly, each time the interval elapses, starting after it has
4943 * elapsed once. The timeout stops firing when it is removed with the
4944 * given remove_function. The timer interval may change whenever the
4945 * timeout is added, removed, or toggled.
4947 * @note The thread lock on DBusConnection is held while
4948 * timeout functions are invoked, so inside these functions you
4949 * may not invoke any methods on DBusConnection or it will deadlock.
4950 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
4951 * if you encounter this issue and want to attempt writing a patch.
4953 * @param connection the connection.
4954 * @param add_function function to add a timeout.
4955 * @param remove_function function to remove a timeout.
4956 * @param toggled_function function to notify of enable/disable
4957 * @param data data to pass to add_function and remove_function.
4958 * @param free_data_function function to be called to free the data.
4959 * @returns #FALSE on failure (no memory)
4962 dbus_connection_set_timeout_functions (DBusConnection *connection,
4963 DBusAddTimeoutFunction add_function,
4964 DBusRemoveTimeoutFunction remove_function,
4965 DBusTimeoutToggledFunction toggled_function,
4967 DBusFreeFunction free_data_function)
4971 _dbus_return_val_if_fail (connection != NULL, FALSE);
4973 CONNECTION_LOCK (connection);
4975 retval = _dbus_timeout_list_set_functions (connection->timeouts,
4976 add_function, remove_function,
4978 data, free_data_function);
4980 CONNECTION_UNLOCK (connection);
4986 * Sets the mainloop wakeup function for the connection. This function
4987 * is responsible for waking up the main loop (if its sleeping in
4988 * another thread) when some some change has happened to the
4989 * connection that the mainloop needs to reconsider (e.g. a message
4990 * has been queued for writing). When using Qt, this typically
4991 * results in a call to QEventLoop::wakeUp(). When using GLib, it
4992 * would call g_main_context_wakeup().
4994 * @param connection the connection.
4995 * @param wakeup_main_function function to wake up the mainloop
4996 * @param data data to pass wakeup_main_function
4997 * @param free_data_function function to be called to free the data.
5000 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
5001 DBusWakeupMainFunction wakeup_main_function,
5003 DBusFreeFunction free_data_function)
5006 DBusFreeFunction old_free_data;
5008 _dbus_return_if_fail (connection != NULL);
5010 CONNECTION_LOCK (connection);
5011 old_data = connection->wakeup_main_data;
5012 old_free_data = connection->free_wakeup_main_data;
5014 connection->wakeup_main_function = wakeup_main_function;
5015 connection->wakeup_main_data = data;
5016 connection->free_wakeup_main_data = free_data_function;
5018 CONNECTION_UNLOCK (connection);
5020 /* Callback outside the lock */
5022 (*old_free_data) (old_data);
5026 * Set a function to be invoked when the dispatch status changes.
5027 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
5028 * dbus_connection_dispatch() needs to be called to process incoming
5029 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
5030 * from inside the DBusDispatchStatusFunction. Indeed, almost
5031 * any reentrancy in this function is a bad idea. Instead,
5032 * the DBusDispatchStatusFunction should simply save an indication
5033 * that messages should be dispatched later, when the main loop
5036 * If you don't set a dispatch status function, you have to be sure to
5037 * dispatch on every iteration of your main loop, especially if
5038 * dbus_watch_handle() or dbus_timeout_handle() were called.
5040 * @param connection the connection
5041 * @param function function to call on dispatch status changes
5042 * @param data data for function
5043 * @param free_data_function free the function data
5046 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
5047 DBusDispatchStatusFunction function,
5049 DBusFreeFunction free_data_function)
5052 DBusFreeFunction old_free_data;
5054 _dbus_return_if_fail (connection != NULL);
5056 CONNECTION_LOCK (connection);
5057 old_data = connection->dispatch_status_data;
5058 old_free_data = connection->free_dispatch_status_data;
5060 connection->dispatch_status_function = function;
5061 connection->dispatch_status_data = data;
5062 connection->free_dispatch_status_data = free_data_function;
5064 CONNECTION_UNLOCK (connection);
5066 /* Callback outside the lock */
5068 (*old_free_data) (old_data);
5072 * Get the UNIX file descriptor of the connection, if any. This can
5073 * be used for SELinux access control checks with getpeercon() for
5074 * example. DO NOT read or write to the file descriptor, or try to
5075 * select() on it; use DBusWatch for main loop integration. Not all
5076 * connections will have a file descriptor. So for adding descriptors
5077 * to the main loop, use dbus_watch_get_unix_fd() and so forth.
5079 * If the connection is socket-based, you can also use
5080 * dbus_connection_get_socket(), which will work on Windows too.
5081 * This function always fails on Windows.
5083 * Right now the returned descriptor is always a socket, but
5084 * that is not guaranteed.
5086 * @param connection the connection
5087 * @param fd return location for the file descriptor.
5088 * @returns #TRUE if fd is successfully obtained.
5091 dbus_connection_get_unix_fd (DBusConnection *connection,
5094 _dbus_return_val_if_fail (connection != NULL, FALSE);
5095 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5098 /* FIXME do this on a lower level */
5102 return dbus_connection_get_socket(connection, fd);
5106 * Gets the underlying Windows or UNIX socket file descriptor
5107 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
5108 * select() on it; use DBusWatch for main loop integration. Not all
5109 * connections will have a socket. So for adding descriptors
5110 * to the main loop, use dbus_watch_get_socket() and so forth.
5112 * If the connection is not socket-based, this function will return FALSE,
5113 * even if the connection does have a file descriptor of some kind.
5114 * i.e. this function always returns specifically a socket file descriptor.
5116 * @param connection the connection
5117 * @param fd return location for the file descriptor.
5118 * @returns #TRUE if fd is successfully obtained.
5121 dbus_connection_get_socket(DBusConnection *connection,
5126 _dbus_return_val_if_fail (connection != NULL, FALSE);
5127 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5129 CONNECTION_LOCK (connection);
5131 retval = _dbus_transport_get_socket_fd (connection->transport,
5134 CONNECTION_UNLOCK (connection);
5141 * Gets the UNIX user ID of the connection if known. Returns #TRUE if
5142 * the uid is filled in. Always returns #FALSE on non-UNIX platforms
5143 * for now, though in theory someone could hook Windows to NIS or
5144 * something. Always returns #FALSE prior to authenticating the
5147 * The UID is only read by servers from clients; clients can't usually
5148 * get the UID of servers, because servers do not authenticate to
5149 * clients. The returned UID is the UID the connection authenticated
5152 * The message bus is a server and the apps connecting to the bus
5155 * You can ask the bus to tell you the UID of another connection though
5156 * if you like; this is done with dbus_bus_get_unix_user().
5158 * @param connection the connection
5159 * @param uid return location for the user ID
5160 * @returns #TRUE if uid is filled in with a valid user ID
5163 dbus_connection_get_unix_user (DBusConnection *connection,
5168 _dbus_return_val_if_fail (connection != NULL, FALSE);
5169 _dbus_return_val_if_fail (uid != NULL, FALSE);
5171 CONNECTION_LOCK (connection);
5173 if (!_dbus_transport_try_to_authenticate (connection->transport))
5176 result = _dbus_transport_get_unix_user (connection->transport,
5180 _dbus_assert (!result);
5183 CONNECTION_UNLOCK (connection);
5189 * Gets the process ID of the connection if any.
5190 * Returns #TRUE if the pid is filled in.
5191 * Always returns #FALSE prior to authenticating the
5194 * @param connection the connection
5195 * @param pid return location for the process ID
5196 * @returns #TRUE if uid is filled in with a valid process ID
5199 dbus_connection_get_unix_process_id (DBusConnection *connection,
5204 _dbus_return_val_if_fail (connection != NULL, FALSE);
5205 _dbus_return_val_if_fail (pid != NULL, FALSE);
5207 CONNECTION_LOCK (connection);
5209 if (!_dbus_transport_try_to_authenticate (connection->transport))
5212 result = _dbus_transport_get_unix_process_id (connection->transport,
5215 CONNECTION_UNLOCK (connection);
5221 * Gets the ADT audit data of the connection if any.
5222 * Returns #TRUE if the structure pointer is returned.
5223 * Always returns #FALSE prior to authenticating the
5226 * @param connection the connection
5227 * @param data return location for audit data
5228 * @param data_size return location for length of audit data
5229 * @returns #TRUE if audit data is filled in with a valid ucred pointer
5232 dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
5234 dbus_int32_t *data_size)
5238 _dbus_return_val_if_fail (connection != NULL, FALSE);
5239 _dbus_return_val_if_fail (data != NULL, FALSE);
5240 _dbus_return_val_if_fail (data_size != NULL, FALSE);
5242 CONNECTION_LOCK (connection);
5244 if (!_dbus_transport_try_to_authenticate (connection->transport))
5247 result = _dbus_transport_get_adt_audit_session_data (connection->transport,
5250 CONNECTION_UNLOCK (connection);
5256 * Sets a predicate function used to determine whether a given user ID
5257 * is allowed to connect. When an incoming connection has
5258 * authenticated with a particular user ID, this function is called;
5259 * if it returns #TRUE, the connection is allowed to proceed,
5260 * otherwise the connection is disconnected.
5262 * If the function is set to #NULL (as it is by default), then
5263 * only the same UID as the server process will be allowed to
5264 * connect. Also, root is always allowed to connect.
5266 * On Windows, the function will be set and its free_data_function will
5267 * be invoked when the connection is freed or a new function is set.
5268 * However, the function will never be called, because there are
5269 * no UNIX user ids to pass to it, or at least none of the existing
5270 * auth protocols would allow authenticating as a UNIX user on Windows.
5272 * @param connection the connection
5273 * @param function the predicate
5274 * @param data data to pass to the predicate
5275 * @param free_data_function function to free the data
5278 dbus_connection_set_unix_user_function (DBusConnection *connection,
5279 DBusAllowUnixUserFunction function,
5281 DBusFreeFunction free_data_function)
5283 void *old_data = NULL;
5284 DBusFreeFunction old_free_function = NULL;
5286 _dbus_return_if_fail (connection != NULL);
5288 CONNECTION_LOCK (connection);
5289 _dbus_transport_set_unix_user_function (connection->transport,
5290 function, data, free_data_function,
5291 &old_data, &old_free_function);
5292 CONNECTION_UNLOCK (connection);
5294 if (old_free_function != NULL)
5295 (* old_free_function) (old_data);
5299 * Gets the Windows user SID of the connection if known. Returns
5300 * #TRUE if the ID is filled in. Always returns #FALSE on non-Windows
5301 * platforms for now, though in theory someone could hook UNIX to
5302 * Active Directory or something. Always returns #FALSE prior to
5303 * authenticating the connection.
5305 * The user is only read by servers from clients; clients can't usually
5306 * get the user of servers, because servers do not authenticate to
5307 * clients. The returned user is the user the connection authenticated
5310 * The message bus is a server and the apps connecting to the bus
5313 * The returned user string has to be freed with dbus_free().
5315 * The return value indicates whether the user SID is available;
5316 * if it's available but we don't have the memory to copy it,
5317 * then the return value is #TRUE and #NULL is given as the SID.
5319 * @todo We would like to be able to say "You can ask the bus to tell
5320 * you the user of another connection though if you like; this is done
5321 * with dbus_bus_get_windows_user()." But this has to be implemented
5322 * in bus/driver.c and dbus/dbus-bus.c, and is pointless anyway
5323 * since on Windows we only use the session bus for now.
5325 * @param connection the connection
5326 * @param windows_sid_p return location for an allocated copy of the user ID, or #NULL if no memory
5327 * @returns #TRUE if user is available (returned value may be #NULL anyway if no memory)
5330 dbus_connection_get_windows_user (DBusConnection *connection,
5331 char **windows_sid_p)
5335 _dbus_return_val_if_fail (connection != NULL, FALSE);
5336 _dbus_return_val_if_fail (windows_sid_p != NULL, FALSE);
5338 CONNECTION_LOCK (connection);
5340 if (!_dbus_transport_try_to_authenticate (connection->transport))
5343 result = _dbus_transport_get_windows_user (connection->transport,
5347 _dbus_assert (!result);
5350 CONNECTION_UNLOCK (connection);
5356 * Sets a predicate function used to determine whether a given user ID
5357 * is allowed to connect. When an incoming connection has
5358 * authenticated with a particular user ID, this function is called;
5359 * if it returns #TRUE, the connection is allowed to proceed,
5360 * otherwise the connection is disconnected.
5362 * If the function is set to #NULL (as it is by default), then
5363 * only the same user owning the server process will be allowed to
5366 * On UNIX, the function will be set and its free_data_function will
5367 * be invoked when the connection is freed or a new function is set.
5368 * However, the function will never be called, because there is no
5369 * way right now to authenticate as a Windows user on UNIX.
5371 * @param connection the connection
5372 * @param function the predicate
5373 * @param data data to pass to the predicate
5374 * @param free_data_function function to free the data
5377 dbus_connection_set_windows_user_function (DBusConnection *connection,
5378 DBusAllowWindowsUserFunction function,
5380 DBusFreeFunction free_data_function)
5382 void *old_data = NULL;
5383 DBusFreeFunction old_free_function = NULL;
5385 _dbus_return_if_fail (connection != NULL);
5387 CONNECTION_LOCK (connection);
5388 _dbus_transport_set_windows_user_function (connection->transport,
5389 function, data, free_data_function,
5390 &old_data, &old_free_function);
5391 CONNECTION_UNLOCK (connection);
5393 if (old_free_function != NULL)
5394 (* old_free_function) (old_data);
5398 * This function must be called on the server side of a connection when the
5399 * connection is first seen in the #DBusNewConnectionFunction. If set to
5400 * #TRUE (the default is #FALSE), then the connection can proceed even if
5401 * the client does not authenticate as some user identity, i.e. clients
5402 * can connect anonymously.
5404 * This setting interacts with the available authorization mechanisms
5405 * (see dbus_server_set_auth_mechanisms()). Namely, an auth mechanism
5406 * such as ANONYMOUS that supports anonymous auth must be included in
5407 * the list of available mechanisms for anonymous login to work.
5409 * This setting also changes the default rule for connections
5410 * authorized as a user; normally, if a connection authorizes as
5411 * a user identity, it is permitted if the user identity is
5412 * root or the user identity matches the user identity of the server
5413 * process. If anonymous connections are allowed, however,
5414 * then any user identity is allowed.
5416 * You can override the rules for connections authorized as a
5417 * user identity with dbus_connection_set_unix_user_function()
5418 * and dbus_connection_set_windows_user_function().
5420 * @param connection the connection
5421 * @param value whether to allow authentication as an anonymous user
5424 dbus_connection_set_allow_anonymous (DBusConnection *connection,
5427 _dbus_return_if_fail (connection != NULL);
5429 CONNECTION_LOCK (connection);
5430 _dbus_transport_set_allow_anonymous (connection->transport, value);
5431 CONNECTION_UNLOCK (connection);
5436 * Normally #DBusConnection automatically handles all messages to the
5437 * org.freedesktop.DBus.Peer interface. However, the message bus wants
5438 * to be able to route methods on that interface through the bus and
5439 * to other applications. If routing peer messages is enabled, then
5440 * messages with the org.freedesktop.DBus.Peer interface that also
5441 * have a bus destination name set will not be automatically
5442 * handled by the #DBusConnection and instead will be dispatched
5443 * normally to the application.
5445 * If a normal application sets this flag, it can break things badly.
5446 * So don't set this unless you are the message bus.
5448 * @param connection the connection
5449 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
5452 dbus_connection_set_route_peer_messages (DBusConnection *connection,
5455 _dbus_return_if_fail (connection != NULL);
5457 CONNECTION_LOCK (connection);
5458 connection->route_peer_messages = value;
5459 CONNECTION_UNLOCK (connection);
5463 * Adds a message filter. Filters are handlers that are run on all
5464 * incoming messages, prior to the objects registered with
5465 * dbus_connection_register_object_path(). Filters are run in the
5466 * order that they were added. The same handler can be added as a
5467 * filter more than once, in which case it will be run more than once.
5468 * Filters added during a filter callback won't be run on the message
5471 * @todo we don't run filters on messages while blocking without
5472 * entering the main loop, since filters are run as part of
5473 * dbus_connection_dispatch(). This is probably a feature, as filters
5474 * could create arbitrary reentrancy. But kind of sucks if you're
5475 * trying to filter METHOD_RETURN for some reason.
5477 * @param connection the connection
5478 * @param function function to handle messages
5479 * @param user_data user data to pass to the function
5480 * @param free_data_function function to use for freeing user data
5481 * @returns #TRUE on success, #FALSE if not enough memory.
5484 dbus_connection_add_filter (DBusConnection *connection,
5485 DBusHandleMessageFunction function,
5487 DBusFreeFunction free_data_function)
5489 DBusMessageFilter *filter;
5491 _dbus_return_val_if_fail (connection != NULL, FALSE);
5492 _dbus_return_val_if_fail (function != NULL, FALSE);
5494 filter = dbus_new0 (DBusMessageFilter, 1);
5498 _dbus_atomic_inc (&filter->refcount);
5500 CONNECTION_LOCK (connection);
5502 if (!_dbus_list_append (&connection->filter_list,
5505 _dbus_message_filter_unref (filter);
5506 CONNECTION_UNLOCK (connection);
5510 /* Fill in filter after all memory allocated,
5511 * so we don't run the free_user_data_function
5512 * if the add_filter() fails
5515 filter->function = function;
5516 filter->user_data = user_data;
5517 filter->free_user_data_function = free_data_function;
5519 CONNECTION_UNLOCK (connection);
5524 * Removes a previously-added message filter. It is a programming
5525 * error to call this function for a handler that has not been added
5526 * as a filter. If the given handler was added more than once, only
5527 * one instance of it will be removed (the most recently-added
5530 * @param connection the connection
5531 * @param function the handler to remove
5532 * @param user_data user data for the handler to remove
5536 dbus_connection_remove_filter (DBusConnection *connection,
5537 DBusHandleMessageFunction function,
5541 DBusMessageFilter *filter;
5543 _dbus_return_if_fail (connection != NULL);
5544 _dbus_return_if_fail (function != NULL);
5546 CONNECTION_LOCK (connection);
5550 link = _dbus_list_get_last_link (&connection->filter_list);
5551 while (link != NULL)
5553 filter = link->data;
5555 if (filter->function == function &&
5556 filter->user_data == user_data)
5558 _dbus_list_remove_link (&connection->filter_list, link);
5559 filter->function = NULL;
5564 link = _dbus_list_get_prev_link (&connection->filter_list, link);
5568 CONNECTION_UNLOCK (connection);
5570 #ifndef DBUS_DISABLE_CHECKS
5573 _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5574 function, user_data);
5579 /* Call application code */
5580 if (filter->free_user_data_function)
5581 (* filter->free_user_data_function) (filter->user_data);
5583 filter->free_user_data_function = NULL;
5584 filter->user_data = NULL;
5586 _dbus_message_filter_unref (filter);
5590 * Registers a handler for a given path or subsection in the object
5591 * hierarchy. The given vtable handles messages sent to exactly the
5592 * given path or also for paths bellow that, depending on fallback
5595 * @param connection the connection
5596 * @param fallback whether to handle messages also for "subdirectory"
5597 * @param path a '/' delimited string of path elements
5598 * @param vtable the virtual table
5599 * @param user_data data to pass to functions in the vtable
5600 * @param error address where an error can be returned
5601 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5602 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5605 _dbus_connection_register_object_path (DBusConnection *connection,
5606 dbus_bool_t fallback,
5608 const DBusObjectPathVTable *vtable,
5612 char **decomposed_path;
5615 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5618 CONNECTION_LOCK (connection);
5620 retval = _dbus_object_tree_register (connection->objects,
5622 (const char **) decomposed_path, vtable,
5625 CONNECTION_UNLOCK (connection);
5627 dbus_free_string_array (decomposed_path);
5633 * Registers a handler for a given path in the object hierarchy.
5634 * The given vtable handles messages sent to exactly the given path.
5636 * @param connection the connection
5637 * @param path a '/' delimited string of path elements
5638 * @param vtable the virtual table
5639 * @param user_data data to pass to functions in the vtable
5640 * @param error address where an error can be returned
5641 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5642 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5645 dbus_connection_try_register_object_path (DBusConnection *connection,
5647 const DBusObjectPathVTable *vtable,
5651 _dbus_return_val_if_fail (connection != NULL, FALSE);
5652 _dbus_return_val_if_fail (path != NULL, FALSE);
5653 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5654 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5656 return _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, error);
5660 * Registers a handler for a given path in the object hierarchy.
5661 * The given vtable handles messages sent to exactly the given path.
5663 * It is a bug to call this function for object paths which already
5664 * have a handler. Use dbus_connection_try_register_object_path() if this
5665 * might be the case.
5667 * @param connection the connection
5668 * @param path a '/' delimited string of path elements
5669 * @param vtable the virtual table
5670 * @param user_data data to pass to functions in the vtable
5671 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5672 * #DBUS_ERROR_OBJECT_PATH_IN_USE) ocurred
5675 dbus_connection_register_object_path (DBusConnection *connection,
5677 const DBusObjectPathVTable *vtable,
5681 DBusError error = DBUS_ERROR_INIT;
5683 _dbus_return_val_if_fail (connection != NULL, FALSE);
5684 _dbus_return_val_if_fail (path != NULL, FALSE);
5685 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5686 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5688 retval = _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, &error);
5690 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5692 _dbus_warn ("%s\n", error.message);
5693 dbus_error_free (&error);
5701 * Registers a fallback handler for a given subsection of the object
5702 * hierarchy. The given vtable handles messages at or below the given
5703 * path. You can use this to establish a default message handling
5704 * policy for a whole "subdirectory."
5706 * @param connection the connection
5707 * @param path a '/' delimited string of path elements
5708 * @param vtable the virtual table
5709 * @param user_data data to pass to functions in the vtable
5710 * @param error address where an error can be returned
5711 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5712 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5715 dbus_connection_try_register_fallback (DBusConnection *connection,
5717 const DBusObjectPathVTable *vtable,
5721 _dbus_return_val_if_fail (connection != NULL, FALSE);
5722 _dbus_return_val_if_fail (path != NULL, FALSE);
5723 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5724 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5726 return _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, error);
5730 * Registers a fallback handler for a given subsection of the object
5731 * hierarchy. The given vtable handles messages at or below the given
5732 * path. You can use this to establish a default message handling
5733 * policy for a whole "subdirectory."
5735 * It is a bug to call this function for object paths which already
5736 * have a handler. Use dbus_connection_try_register_fallback() if this
5737 * might be the case.
5739 * @param connection the connection
5740 * @param path a '/' delimited string of path elements
5741 * @param vtable the virtual table
5742 * @param user_data data to pass to functions in the vtable
5743 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5744 * #DBUS_ERROR_OBJECT_PATH_IN_USE) occured
5747 dbus_connection_register_fallback (DBusConnection *connection,
5749 const DBusObjectPathVTable *vtable,
5753 DBusError error = DBUS_ERROR_INIT;
5755 _dbus_return_val_if_fail (connection != NULL, FALSE);
5756 _dbus_return_val_if_fail (path != NULL, FALSE);
5757 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5758 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5760 retval = _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, &error);
5762 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5764 _dbus_warn ("%s\n", error.message);
5765 dbus_error_free (&error);
5773 * Unregisters the handler registered with exactly the given path.
5774 * It's a bug to call this function for a path that isn't registered.
5775 * Can unregister both fallback paths and object paths.
5777 * @param connection the connection
5778 * @param path a '/' delimited string of path elements
5779 * @returns #FALSE if not enough memory
5782 dbus_connection_unregister_object_path (DBusConnection *connection,
5785 char **decomposed_path;
5787 _dbus_return_val_if_fail (connection != NULL, FALSE);
5788 _dbus_return_val_if_fail (path != NULL, FALSE);
5789 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5791 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5794 CONNECTION_LOCK (connection);
5796 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5798 dbus_free_string_array (decomposed_path);
5804 * Gets the user data passed to dbus_connection_register_object_path()
5805 * or dbus_connection_register_fallback(). If nothing was registered
5806 * at this path, the data is filled in with #NULL.
5808 * @param connection the connection
5809 * @param path the path you registered with
5810 * @param data_p location to store the user data, or #NULL
5811 * @returns #FALSE if not enough memory
5814 dbus_connection_get_object_path_data (DBusConnection *connection,
5818 char **decomposed_path;
5820 _dbus_return_val_if_fail (connection != NULL, FALSE);
5821 _dbus_return_val_if_fail (path != NULL, FALSE);
5822 _dbus_return_val_if_fail (data_p != NULL, FALSE);
5826 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5829 CONNECTION_LOCK (connection);
5831 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5833 CONNECTION_UNLOCK (connection);
5835 dbus_free_string_array (decomposed_path);
5841 * Lists the registered fallback handlers and object path handlers at
5842 * the given parent_path. The returned array should be freed with
5843 * dbus_free_string_array().
5845 * @param connection the connection
5846 * @param parent_path the path to list the child handlers of
5847 * @param child_entries returns #NULL-terminated array of children
5848 * @returns #FALSE if no memory to allocate the child entries
5851 dbus_connection_list_registered (DBusConnection *connection,
5852 const char *parent_path,
5853 char ***child_entries)
5855 char **decomposed_path;
5857 _dbus_return_val_if_fail (connection != NULL, FALSE);
5858 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5859 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5860 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5862 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5865 CONNECTION_LOCK (connection);
5867 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5868 (const char **) decomposed_path,
5870 dbus_free_string_array (decomposed_path);
5875 static DBusDataSlotAllocator slot_allocator =
5876 _DBUS_DATA_SLOT_ALLOCATOR_INIT (_DBUS_LOCK_NAME (connection_slots));
5879 * Allocates an integer ID to be used for storing application-specific
5880 * data on any DBusConnection. The allocated ID may then be used
5881 * with dbus_connection_set_data() and dbus_connection_get_data().
5882 * The passed-in slot must be initialized to -1, and is filled in
5883 * with the slot ID. If the passed-in slot is not -1, it's assumed
5884 * to be already allocated, and its refcount is incremented.
5886 * The allocated slot is global, i.e. all DBusConnection objects will
5887 * have a slot with the given integer ID reserved.
5889 * @param slot_p address of a global variable storing the slot
5890 * @returns #FALSE on failure (no memory)
5893 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5895 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5900 * Deallocates a global ID for connection data slots.
5901 * dbus_connection_get_data() and dbus_connection_set_data() may no
5902 * longer be used with this slot. Existing data stored on existing
5903 * DBusConnection objects will be freed when the connection is
5904 * finalized, but may not be retrieved (and may only be replaced if
5905 * someone else reallocates the slot). When the refcount on the
5906 * passed-in slot reaches 0, it is set to -1.
5908 * @param slot_p address storing the slot to deallocate
5911 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5913 _dbus_return_if_fail (*slot_p >= 0);
5915 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5919 * Stores a pointer on a DBusConnection, along
5920 * with an optional function to be used for freeing
5921 * the data when the data is set again, or when
5922 * the connection is finalized. The slot number
5923 * must have been allocated with dbus_connection_allocate_data_slot().
5925 * @note This function does not take the
5926 * main thread lock on DBusConnection, which allows it to be
5927 * used from inside watch and timeout functions. (See the
5928 * note in docs for dbus_connection_set_watch_functions().)
5929 * A side effect of this is that you need to know there's
5930 * a reference held on the connection while invoking
5931 * dbus_connection_set_data(), or the connection could be
5932 * finalized during dbus_connection_set_data().
5934 * @param connection the connection
5935 * @param slot the slot number
5936 * @param data the data to store
5937 * @param free_data_func finalizer function for the data
5938 * @returns #TRUE if there was enough memory to store the data
5941 dbus_connection_set_data (DBusConnection *connection,
5944 DBusFreeFunction free_data_func)
5946 DBusFreeFunction old_free_func;
5950 _dbus_return_val_if_fail (connection != NULL, FALSE);
5951 _dbus_return_val_if_fail (slot >= 0, FALSE);
5953 SLOTS_LOCK (connection);
5955 retval = _dbus_data_slot_list_set (&slot_allocator,
5956 &connection->slot_list,
5957 slot, data, free_data_func,
5958 &old_free_func, &old_data);
5960 SLOTS_UNLOCK (connection);
5964 /* Do the actual free outside the connection lock */
5966 (* old_free_func) (old_data);
5973 * Retrieves data previously set with dbus_connection_set_data().
5974 * The slot must still be allocated (must not have been freed).
5976 * @note This function does not take the
5977 * main thread lock on DBusConnection, which allows it to be
5978 * used from inside watch and timeout functions. (See the
5979 * note in docs for dbus_connection_set_watch_functions().)
5980 * A side effect of this is that you need to know there's
5981 * a reference held on the connection while invoking
5982 * dbus_connection_get_data(), or the connection could be
5983 * finalized during dbus_connection_get_data().
5985 * @param connection the connection
5986 * @param slot the slot to get data from
5987 * @returns the data, or #NULL if not found
5990 dbus_connection_get_data (DBusConnection *connection,
5995 _dbus_return_val_if_fail (connection != NULL, NULL);
5996 _dbus_return_val_if_fail (slot >= 0, NULL);
5998 SLOTS_LOCK (connection);
6000 res = _dbus_data_slot_list_get (&slot_allocator,
6001 &connection->slot_list,
6004 SLOTS_UNLOCK (connection);
6010 * This function sets a global flag for whether dbus_connection_new()
6011 * will set SIGPIPE behavior to SIG_IGN.
6013 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
6016 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
6018 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
6022 * Specifies the maximum size message this connection is allowed to
6023 * receive. Larger messages will result in disconnecting the
6026 * @param connection a #DBusConnection
6027 * @param size maximum message size the connection can receive, in bytes
6030 dbus_connection_set_max_message_size (DBusConnection *connection,
6033 _dbus_return_if_fail (connection != NULL);
6035 CONNECTION_LOCK (connection);
6036 _dbus_transport_set_max_message_size (connection->transport,
6038 CONNECTION_UNLOCK (connection);
6042 * Gets the value set by dbus_connection_set_max_message_size().
6044 * @param connection the connection
6045 * @returns the max size of a single message
6048 dbus_connection_get_max_message_size (DBusConnection *connection)
6052 _dbus_return_val_if_fail (connection != NULL, 0);
6054 CONNECTION_LOCK (connection);
6055 res = _dbus_transport_get_max_message_size (connection->transport);
6056 CONNECTION_UNLOCK (connection);
6061 * Specifies the maximum number of unix fds a message on this
6062 * connection is allowed to receive. Messages with more unix fds will
6063 * result in disconnecting the connection.
6065 * @param connection a #DBusConnection
6066 * @param n maximum message unix fds the connection can receive
6069 dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
6072 _dbus_return_if_fail (connection != NULL);
6074 CONNECTION_LOCK (connection);
6075 _dbus_transport_set_max_message_unix_fds (connection->transport,
6077 CONNECTION_UNLOCK (connection);
6081 * Gets the value set by dbus_connection_set_max_message_unix_fds().
6083 * @param connection the connection
6084 * @returns the max numer of unix fds of a single message
6087 dbus_connection_get_max_message_unix_fds (DBusConnection *connection)
6091 _dbus_return_val_if_fail (connection != NULL, 0);
6093 CONNECTION_LOCK (connection);
6094 res = _dbus_transport_get_max_message_unix_fds (connection->transport);
6095 CONNECTION_UNLOCK (connection);
6100 * Sets the maximum total number of bytes that can be used for all messages
6101 * received on this connection. Messages count toward the maximum until
6102 * they are finalized. When the maximum is reached, the connection will
6103 * not read more data until some messages are finalized.
6105 * The semantics of the maximum are: if outstanding messages are
6106 * already above the maximum, additional messages will not be read.
6107 * The semantics are not: if the next message would cause us to exceed
6108 * the maximum, we don't read it. The reason is that we don't know the
6109 * size of a message until after we read it.
6111 * Thus, the max live messages size can actually be exceeded
6112 * by up to the maximum size of a single message.
6114 * Also, if we read say 1024 bytes off the wire in a single read(),
6115 * and that contains a half-dozen small messages, we may exceed the
6116 * size max by that amount. But this should be inconsequential.
6118 * This does imply that we can't call read() with a buffer larger
6119 * than we're willing to exceed this limit by.
6121 * @param connection the connection
6122 * @param size the maximum size in bytes of all outstanding messages
6125 dbus_connection_set_max_received_size (DBusConnection *connection,
6128 _dbus_return_if_fail (connection != NULL);
6130 CONNECTION_LOCK (connection);
6131 _dbus_transport_set_max_received_size (connection->transport,
6133 CONNECTION_UNLOCK (connection);
6137 * Gets the value set by dbus_connection_set_max_received_size().
6139 * @param connection the connection
6140 * @returns the max size of all live messages
6143 dbus_connection_get_max_received_size (DBusConnection *connection)
6147 _dbus_return_val_if_fail (connection != NULL, 0);
6149 CONNECTION_LOCK (connection);
6150 res = _dbus_transport_get_max_received_size (connection->transport);
6151 CONNECTION_UNLOCK (connection);
6156 * Sets the maximum total number of unix fds that can be used for all messages
6157 * received on this connection. Messages count toward the maximum until
6158 * they are finalized. When the maximum is reached, the connection will
6159 * not read more data until some messages are finalized.
6161 * The semantics are analogous to those of dbus_connection_set_max_received_size().
6163 * @param connection the connection
6164 * @param n the maximum size in bytes of all outstanding messages
6167 dbus_connection_set_max_received_unix_fds (DBusConnection *connection,
6170 _dbus_return_if_fail (connection != NULL);
6172 CONNECTION_LOCK (connection);
6173 _dbus_transport_set_max_received_unix_fds (connection->transport,
6175 CONNECTION_UNLOCK (connection);
6179 * Gets the value set by dbus_connection_set_max_received_unix_fds().
6181 * @param connection the connection
6182 * @returns the max unix fds of all live messages
6185 dbus_connection_get_max_received_unix_fds (DBusConnection *connection)
6189 _dbus_return_val_if_fail (connection != NULL, 0);
6191 CONNECTION_LOCK (connection);
6192 res = _dbus_transport_get_max_received_unix_fds (connection->transport);
6193 CONNECTION_UNLOCK (connection);
6198 * Gets the approximate size in bytes of all messages in the outgoing
6199 * message queue. The size is approximate in that you shouldn't use
6200 * it to decide how many bytes to read off the network or anything
6201 * of that nature, as optimizations may choose to tell small white lies
6202 * to avoid performance overhead.
6204 * @param connection the connection
6205 * @returns the number of bytes that have been queued up but not sent
6208 dbus_connection_get_outgoing_size (DBusConnection *connection)
6212 _dbus_return_val_if_fail (connection != NULL, 0);
6214 CONNECTION_LOCK (connection);
6215 res = _dbus_counter_get_size_value (connection->outgoing_counter);
6216 CONNECTION_UNLOCK (connection);
6220 #ifdef DBUS_ENABLE_STATS
6222 _dbus_connection_get_stats (DBusConnection *connection,
6223 dbus_uint32_t *in_messages,
6224 dbus_uint32_t *in_bytes,
6225 dbus_uint32_t *in_fds,
6226 dbus_uint32_t *in_peak_bytes,
6227 dbus_uint32_t *in_peak_fds,
6228 dbus_uint32_t *out_messages,
6229 dbus_uint32_t *out_bytes,
6230 dbus_uint32_t *out_fds,
6231 dbus_uint32_t *out_peak_bytes,
6232 dbus_uint32_t *out_peak_fds)
6234 CONNECTION_LOCK (connection);
6236 if (in_messages != NULL)
6237 *in_messages = connection->n_incoming;
6239 _dbus_transport_get_stats (connection->transport,
6240 in_bytes, in_fds, in_peak_bytes, in_peak_fds);
6242 if (out_messages != NULL)
6243 *out_messages = connection->n_outgoing;
6245 if (out_bytes != NULL)
6246 *out_bytes = _dbus_counter_get_size_value (connection->outgoing_counter);
6248 if (out_fds != NULL)
6249 *out_fds = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6251 if (out_peak_bytes != NULL)
6252 *out_peak_bytes = _dbus_counter_get_peak_size_value (connection->outgoing_counter);
6254 if (out_peak_fds != NULL)
6255 *out_peak_fds = _dbus_counter_get_peak_unix_fd_value (connection->outgoing_counter);
6257 CONNECTION_UNLOCK (connection);
6259 #endif /* DBUS_ENABLE_STATS */
6262 * Gets the approximate number of uni fds of all messages in the
6263 * outgoing message queue.
6265 * @param connection the connection
6266 * @returns the number of unix fds that have been queued up but not sent
6269 dbus_connection_get_outgoing_unix_fds (DBusConnection *connection)
6273 _dbus_return_val_if_fail (connection != NULL, 0);
6275 CONNECTION_LOCK (connection);
6276 res = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6277 CONNECTION_UNLOCK (connection);
6281 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
6283 * Returns the address of the transport object of this connection
6285 * @param connection the connection
6286 * @returns the address string
6289 _dbus_connection_get_address (DBusConnection *connection)
6291 return _dbus_transport_get_address (connection->transport);