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_mutex_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_mutex_lock ((connection)->slot_mutex); \
79 #define SLOTS_UNLOCK(connection) do { \
80 _dbus_mutex_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 * Internal struct representing a message filter function
209 typedef struct DBusMessageFilter DBusMessageFilter;
212 * Internal struct representing a message filter function
214 struct DBusMessageFilter
216 DBusAtomic refcount; /**< Reference count */
217 DBusHandleMessageFunction function; /**< Function to call to filter */
218 void *user_data; /**< User data for the function */
219 DBusFreeFunction free_user_data_function; /**< Function to free the user data */
224 * Internals of DBusPreallocatedSend
226 struct DBusPreallocatedSend
228 DBusConnection *connection; /**< Connection we'd send the message to */
229 DBusList *queue_link; /**< Preallocated link in the queue */
230 DBusList *counter_link; /**< Preallocated link in the resource counter */
233 #if HAVE_DECL_MSG_NOSIGNAL
234 static dbus_bool_t _dbus_modify_sigpipe = FALSE;
236 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
240 * Implementation details of DBusConnection. All fields are private.
242 struct DBusConnection
244 DBusAtomic refcount; /**< Reference count. */
246 DBusMutex *mutex; /**< Lock on the entire DBusConnection */
248 DBusMutex *dispatch_mutex; /**< Protects dispatch_acquired */
249 DBusCondVar *dispatch_cond; /**< Notify when dispatch_acquired is available */
250 DBusMutex *io_path_mutex; /**< Protects io_path_acquired */
251 DBusCondVar *io_path_cond; /**< Notify when io_path_acquired is available */
253 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
254 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
255 DBusList *expired_messages; /**< Messages that will be released when we next unlock. */
257 DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
258 * dispatch_acquired will be set by the borrower
261 int n_outgoing; /**< Length of outgoing queue. */
262 int n_incoming; /**< Length of incoming queue. */
264 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
266 DBusTransport *transport; /**< Object that sends/receives messages over network. */
267 DBusWatchList *watches; /**< Stores active watches. */
268 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
270 DBusList *filter_list; /**< List of filters. */
272 DBusMutex *slot_mutex; /**< Lock on slot_list so overall connection lock need not be taken */
273 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
275 DBusHashTable *pending_replies; /**< Hash of message serials to #DBusPendingCall. */
277 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
278 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
280 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
281 void *wakeup_main_data; /**< Application data for wakeup_main_function */
282 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
284 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
285 void *dispatch_status_data; /**< Application data for dispatch_status_function */
286 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
288 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
290 DBusList *link_cache; /**< A cache of linked list links to prevent contention
291 * for the global linked list mempool lock
293 DBusObjectTree *objects; /**< Object path handlers registered with this connection */
295 char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
297 /* These two MUST be bools and not bitfields, because they are protected by a separate lock
298 * from connection->mutex and all bitfields in a word have to be read/written together.
299 * So you can't have a different lock for different bitfields in the same word.
301 dbus_bool_t dispatch_acquired; /**< Someone has dispatch path (can drain incoming queue) */
302 dbus_bool_t io_path_acquired; /**< Someone has transport io path (can use the transport to read/write messages) */
304 unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
306 unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
308 unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
310 unsigned int disconnected_message_arrived : 1; /**< We popped or are dispatching the disconnected message.
311 * if the disconnect_message_link is NULL then we queued it, but
312 * this flag is whether it got to the head of the queue.
314 unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
315 * such as closing the connection.
318 #ifndef DBUS_DISABLE_CHECKS
319 unsigned int have_connection_lock : 1; /**< Used to check locking */
322 #ifndef DBUS_DISABLE_CHECKS
323 int generation; /**< _dbus_current_generation that should correspond to this connection */
327 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
328 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
329 DBusDispatchStatus new_status);
330 static void _dbus_connection_last_unref (DBusConnection *connection);
331 static void _dbus_connection_acquire_dispatch (DBusConnection *connection);
332 static void _dbus_connection_release_dispatch (DBusConnection *connection);
333 static DBusDispatchStatus _dbus_connection_flush_unlocked (DBusConnection *connection);
334 static void _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection);
335 static dbus_bool_t _dbus_connection_get_is_connected_unlocked (DBusConnection *connection);
336 static dbus_bool_t _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
337 dbus_uint32_t client_serial);
339 static DBusMessageFilter *
340 _dbus_message_filter_ref (DBusMessageFilter *filter)
342 #ifdef DBUS_DISABLE_ASSERT
343 _dbus_atomic_inc (&filter->refcount);
345 dbus_int32_t old_value;
347 old_value = _dbus_atomic_inc (&filter->refcount);
348 _dbus_assert (old_value > 0);
355 _dbus_message_filter_unref (DBusMessageFilter *filter)
357 dbus_int32_t old_value;
359 old_value = _dbus_atomic_dec (&filter->refcount);
360 _dbus_assert (old_value > 0);
364 if (filter->free_user_data_function)
365 (* filter->free_user_data_function) (filter->user_data);
372 * Acquires the connection lock.
374 * @param connection the connection.
377 _dbus_connection_lock (DBusConnection *connection)
379 CONNECTION_LOCK (connection);
383 * Releases the connection lock.
385 * @param connection the connection.
388 _dbus_connection_unlock (DBusConnection *connection)
390 DBusList *expired_messages;
395 _dbus_verbose ("UNLOCK\n");
398 /* If we had messages that expired (fell off the incoming or outgoing
399 * queues) while we were locked, actually release them now */
400 expired_messages = connection->expired_messages;
401 connection->expired_messages = NULL;
403 RELEASING_LOCK_CHECK (connection);
404 _dbus_mutex_unlock (connection->mutex);
406 for (iter = _dbus_list_get_first_link (&expired_messages);
408 iter = _dbus_list_get_next_link (&expired_messages, iter))
410 DBusMessage *message = iter->data;
412 dbus_message_unref (message);
416 /* Take the lock back for a moment, to copy the links into the link
417 * cache. FIXME: with this extra cost, is it still advantageous to have
419 _dbus_mutex_lock (connection->mutex);
421 for (iter = _dbus_list_pop_first_link (&expired_messages);
423 iter = _dbus_list_pop_first_link (&expired_messages))
424 _dbus_list_prepend_link (&connection->link_cache, iter);
426 _dbus_mutex_unlock (connection->mutex);
430 * Wakes up the main loop if it is sleeping
431 * Needed if we're e.g. queueing outgoing messages
432 * on a thread while the mainloop sleeps.
434 * @param connection the connection.
437 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
439 if (connection->wakeup_main_function)
440 (*connection->wakeup_main_function) (connection->wakeup_main_data);
443 #ifdef DBUS_BUILD_TESTS
444 /* For now this function isn't used */
446 * Adds a message to the incoming message queue, returning #FALSE
447 * if there's insufficient memory to queue the message.
448 * Does not take over refcount of the message.
450 * @param connection the connection.
451 * @param message the message to queue.
452 * @returns #TRUE on success.
455 _dbus_connection_queue_received_message (DBusConnection *connection,
456 DBusMessage *message)
460 link = _dbus_list_alloc_link (message);
464 dbus_message_ref (message);
465 _dbus_connection_queue_received_message_link (connection, link);
471 * Gets the locks so we can examine them
473 * @param connection the connection.
474 * @param mutex_loc return for the location of the main mutex pointer
475 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
476 * @param io_path_mutex_loc return location of the io_path mutex pointer
477 * @param dispatch_cond_loc return location of the dispatch conditional
479 * @param io_path_cond_loc return location of the io_path conditional
483 _dbus_connection_test_get_locks (DBusConnection *connection,
484 DBusMutex **mutex_loc,
485 DBusMutex **dispatch_mutex_loc,
486 DBusMutex **io_path_mutex_loc,
487 DBusCondVar **dispatch_cond_loc,
488 DBusCondVar **io_path_cond_loc)
490 *mutex_loc = connection->mutex;
491 *dispatch_mutex_loc = connection->dispatch_mutex;
492 *io_path_mutex_loc = connection->io_path_mutex;
493 *dispatch_cond_loc = connection->dispatch_cond;
494 *io_path_cond_loc = connection->io_path_cond;
499 * Adds a message-containing list link to the incoming message queue,
500 * taking ownership of the link and the message's current refcount.
501 * Cannot fail due to lack of memory.
503 * @param connection the connection.
504 * @param link the message link to queue.
507 _dbus_connection_queue_received_message_link (DBusConnection *connection,
510 DBusPendingCall *pending;
511 dbus_uint32_t reply_serial;
512 DBusMessage *message;
514 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
516 _dbus_list_append_link (&connection->incoming_messages,
518 message = link->data;
520 /* If this is a reply we're waiting on, remove timeout for it */
521 reply_serial = dbus_message_get_reply_serial (message);
522 if (reply_serial != 0)
524 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
528 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
529 _dbus_connection_remove_timeout_unlocked (connection,
530 _dbus_pending_call_get_timeout_unlocked (pending));
532 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
538 connection->n_incoming += 1;
540 _dbus_connection_wakeup_mainloop (connection);
542 _dbus_verbose ("Message %p (%s %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
544 dbus_message_type_to_string (dbus_message_get_type (message)),
545 dbus_message_get_path (message) ?
546 dbus_message_get_path (message) :
548 dbus_message_get_interface (message) ?
549 dbus_message_get_interface (message) :
551 dbus_message_get_member (message) ?
552 dbus_message_get_member (message) :
554 dbus_message_get_signature (message),
555 dbus_message_get_reply_serial (message),
557 connection->n_incoming);}
560 * Adds a link + message to the incoming message queue.
561 * Can't fail. Takes ownership of both link and message.
563 * @param connection the connection.
564 * @param link the list node and message to queue.
568 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
571 HAVE_LOCK_CHECK (connection);
573 _dbus_list_append_link (&connection->incoming_messages, link);
575 connection->n_incoming += 1;
577 _dbus_connection_wakeup_mainloop (connection);
579 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
580 link->data, connection, connection->n_incoming);
585 * Checks whether there are messages in the outgoing message queue.
586 * Called with connection lock held.
588 * @param connection the connection.
589 * @returns #TRUE if the outgoing queue is non-empty.
592 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
594 HAVE_LOCK_CHECK (connection);
595 return connection->outgoing_messages != NULL;
599 * Checks whether there are messages in the outgoing message queue.
600 * Use dbus_connection_flush() to block until all outgoing
601 * messages have been written to the underlying transport
602 * (such as a socket).
604 * @param connection the connection.
605 * @returns #TRUE if the outgoing queue is non-empty.
608 dbus_connection_has_messages_to_send (DBusConnection *connection)
612 _dbus_return_val_if_fail (connection != NULL, FALSE);
614 CONNECTION_LOCK (connection);
615 v = _dbus_connection_has_messages_to_send_unlocked (connection);
616 CONNECTION_UNLOCK (connection);
622 * Gets the next outgoing message. The message remains in the
623 * queue, and the caller does not own a reference to it.
625 * @param connection the connection.
626 * @returns the message to be sent.
629 _dbus_connection_get_message_to_send (DBusConnection *connection)
631 HAVE_LOCK_CHECK (connection);
633 return _dbus_list_get_last (&connection->outgoing_messages);
637 * Notifies the connection that a message has been sent, so the
638 * message can be removed from the outgoing queue.
639 * Called with the connection lock held.
641 * @param connection the connection.
642 * @param message the message that was sent.
645 _dbus_connection_message_sent_unlocked (DBusConnection *connection,
646 DBusMessage *message)
650 HAVE_LOCK_CHECK (connection);
652 /* This can be called before we even complete authentication, since
653 * it's called on disconnect to clean up the outgoing queue.
654 * It's also called as we successfully send each message.
657 link = _dbus_list_get_last_link (&connection->outgoing_messages);
658 _dbus_assert (link != NULL);
659 _dbus_assert (link->data == message);
661 _dbus_list_unlink (&connection->outgoing_messages,
663 _dbus_list_prepend_link (&connection->expired_messages, link);
665 connection->n_outgoing -= 1;
667 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
669 dbus_message_type_to_string (dbus_message_get_type (message)),
670 dbus_message_get_path (message) ?
671 dbus_message_get_path (message) :
673 dbus_message_get_interface (message) ?
674 dbus_message_get_interface (message) :
676 dbus_message_get_member (message) ?
677 dbus_message_get_member (message) :
679 dbus_message_get_signature (message),
680 connection, connection->n_outgoing);
682 /* It's OK that in principle we call the notify function, because for the
683 * outgoing limit, there isn't one */
684 _dbus_message_remove_counter (message, connection->outgoing_counter,
687 /* Save this link in the link cache also */
688 _dbus_list_prepend_link (&connection->link_cache, link);
690 /* The message will actually be unreffed when we unlock */
693 /** Function to be called in protected_change_watch() with refcount held */
694 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
696 /** Function to be called in protected_change_watch() with refcount held */
697 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
699 /** Function to be called in protected_change_watch() with refcount held */
700 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
702 dbus_bool_t enabled);
705 protected_change_watch (DBusConnection *connection,
707 DBusWatchAddFunction add_function,
708 DBusWatchRemoveFunction remove_function,
709 DBusWatchToggleFunction toggle_function,
714 HAVE_LOCK_CHECK (connection);
716 /* The original purpose of protected_change_watch() was to hold a
717 * ref on the connection while dropping the connection lock, then
718 * calling out to the app. This was a broken hack that did not
719 * work, since the connection was in a hosed state (no WatchList
720 * field) while calling out.
722 * So for now we'll just keep the lock while calling out. This means
723 * apps are not allowed to call DBusConnection methods inside a
724 * watch function or they will deadlock.
726 * The "real fix" is to use the _and_unlock() pattern found
727 * elsewhere in the code, to defer calling out to the app until
728 * we're about to drop locks and return flow of control to the app
731 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
734 if (connection->watches)
737 retval = (* add_function) (connection->watches, watch);
738 else if (remove_function)
741 (* remove_function) (connection->watches, watch);
746 (* toggle_function) (connection->watches, watch, enabled);
756 * Adds a watch using the connection's DBusAddWatchFunction if
757 * available. Otherwise records the watch to be added when said
758 * function is available. Also re-adds the watch if the
759 * DBusAddWatchFunction changes. May fail due to lack of memory.
760 * Connection lock should be held when calling this.
762 * @param connection the connection.
763 * @param watch the watch to add.
764 * @returns #TRUE on success.
767 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
770 return protected_change_watch (connection, watch,
771 _dbus_watch_list_add_watch,
776 * Removes a watch using the connection's DBusRemoveWatchFunction
777 * if available. It's an error to call this function on a watch
778 * that was not previously added.
779 * Connection lock should be held when calling this.
781 * @param connection the connection.
782 * @param watch the watch to remove.
785 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
788 protected_change_watch (connection, watch,
790 _dbus_watch_list_remove_watch,
795 * Toggles a watch and notifies app via connection's
796 * DBusWatchToggledFunction if available. It's an error to call this
797 * function on a watch that was not previously added.
798 * Connection lock should be held when calling this.
800 * @param connection the connection.
801 * @param watch the watch to toggle.
802 * @param enabled whether to enable or disable
805 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
809 _dbus_assert (watch != NULL);
811 protected_change_watch (connection, watch,
813 _dbus_watch_list_toggle_watch,
817 /** Function to be called in protected_change_timeout() with refcount held */
818 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
819 DBusTimeout *timeout);
820 /** Function to be called in protected_change_timeout() with refcount held */
821 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
822 DBusTimeout *timeout);
823 /** Function to be called in protected_change_timeout() with refcount held */
824 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
825 DBusTimeout *timeout,
826 dbus_bool_t enabled);
829 protected_change_timeout (DBusConnection *connection,
830 DBusTimeout *timeout,
831 DBusTimeoutAddFunction add_function,
832 DBusTimeoutRemoveFunction remove_function,
833 DBusTimeoutToggleFunction toggle_function,
838 HAVE_LOCK_CHECK (connection);
840 /* The original purpose of protected_change_timeout() was to hold a
841 * ref on the connection while dropping the connection lock, then
842 * calling out to the app. This was a broken hack that did not
843 * work, since the connection was in a hosed state (no TimeoutList
844 * field) while calling out.
846 * So for now we'll just keep the lock while calling out. This means
847 * apps are not allowed to call DBusConnection methods inside a
848 * timeout function or they will deadlock.
850 * The "real fix" is to use the _and_unlock() pattern found
851 * elsewhere in the code, to defer calling out to the app until
852 * we're about to drop locks and return flow of control to the app
855 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
858 if (connection->timeouts)
861 retval = (* add_function) (connection->timeouts, timeout);
862 else if (remove_function)
865 (* remove_function) (connection->timeouts, timeout);
870 (* toggle_function) (connection->timeouts, timeout, enabled);
879 * Adds a timeout using the connection's DBusAddTimeoutFunction if
880 * available. Otherwise records the timeout to be added when said
881 * function is available. Also re-adds the timeout if the
882 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
883 * The timeout will fire repeatedly until removed.
884 * Connection lock should be held when calling this.
886 * @param connection the connection.
887 * @param timeout the timeout to add.
888 * @returns #TRUE on success.
891 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
892 DBusTimeout *timeout)
894 return protected_change_timeout (connection, timeout,
895 _dbus_timeout_list_add_timeout,
900 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
901 * if available. It's an error to call this function on a timeout
902 * that was not previously added.
903 * Connection lock should be held when calling this.
905 * @param connection the connection.
906 * @param timeout the timeout to remove.
909 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
910 DBusTimeout *timeout)
912 protected_change_timeout (connection, timeout,
914 _dbus_timeout_list_remove_timeout,
919 * Toggles a timeout and notifies app via connection's
920 * DBusTimeoutToggledFunction if available. It's an error to call this
921 * function on a timeout that was not previously added.
922 * Connection lock should be held when calling this.
924 * @param connection the connection.
925 * @param timeout the timeout to toggle.
926 * @param enabled whether to enable or disable
929 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
930 DBusTimeout *timeout,
933 protected_change_timeout (connection, timeout,
935 _dbus_timeout_list_toggle_timeout,
940 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
941 DBusPendingCall *pending)
943 dbus_uint32_t reply_serial;
944 DBusTimeout *timeout;
946 HAVE_LOCK_CHECK (connection);
948 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
950 _dbus_assert (reply_serial != 0);
952 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
956 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
959 if (!_dbus_hash_table_insert_int (connection->pending_replies,
963 _dbus_connection_remove_timeout_unlocked (connection, timeout);
965 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
966 HAVE_LOCK_CHECK (connection);
970 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
974 if (!_dbus_hash_table_insert_int (connection->pending_replies,
978 HAVE_LOCK_CHECK (connection);
983 _dbus_pending_call_ref_unlocked (pending);
985 HAVE_LOCK_CHECK (connection);
991 free_pending_call_on_hash_removal (void *data)
993 DBusPendingCall *pending;
994 DBusConnection *connection;
1001 connection = _dbus_pending_call_get_connection_unlocked (pending);
1003 HAVE_LOCK_CHECK (connection);
1005 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
1007 _dbus_connection_remove_timeout_unlocked (connection,
1008 _dbus_pending_call_get_timeout_unlocked (pending));
1010 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
1013 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
1014 * here, but the pending call finalizer could in principle call out to
1015 * application code so we pretty much have to... some larger code reorg
1018 _dbus_connection_ref_unlocked (connection);
1019 _dbus_pending_call_unref_and_unlock (pending);
1020 CONNECTION_LOCK (connection);
1021 _dbus_connection_unref_unlocked (connection);
1025 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
1026 DBusPendingCall *pending)
1028 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
1031 _dbus_hash_table_remove_int (connection->pending_replies,
1032 _dbus_pending_call_get_reply_serial_unlocked (pending));
1036 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
1037 DBusPendingCall *pending)
1039 /* The idea here is to avoid finalizing the pending call
1040 * with the lock held, since there's a destroy notifier
1041 * in pending call that goes out to application code.
1043 * There's an extra unlock inside the hash table
1044 * "free pending call" function FIXME...
1046 _dbus_pending_call_ref_unlocked (pending);
1047 _dbus_hash_table_remove_int (connection->pending_replies,
1048 _dbus_pending_call_get_reply_serial_unlocked (pending));
1050 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
1051 _dbus_connection_remove_timeout_unlocked (connection,
1052 _dbus_pending_call_get_timeout_unlocked (pending));
1054 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
1056 _dbus_pending_call_unref_and_unlock (pending);
1060 * Removes a pending call from the connection, such that
1061 * the pending reply will be ignored. May drop the last
1062 * reference to the pending call.
1064 * @param connection the connection
1065 * @param pending the pending call
1068 _dbus_connection_remove_pending_call (DBusConnection *connection,
1069 DBusPendingCall *pending)
1071 CONNECTION_LOCK (connection);
1072 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
1076 * Acquire the transporter I/O path. This must be done before
1077 * doing any I/O in the transporter. May sleep and drop the
1078 * IO path mutex while waiting for the I/O path.
1080 * @param connection the connection.
1081 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1082 * @returns TRUE if the I/O path was acquired.
1085 _dbus_connection_acquire_io_path (DBusConnection *connection,
1086 int timeout_milliseconds)
1088 dbus_bool_t we_acquired;
1090 HAVE_LOCK_CHECK (connection);
1092 /* We don't want the connection to vanish */
1093 _dbus_connection_ref_unlocked (connection);
1095 /* We will only touch io_path_acquired which is protected by our mutex */
1096 CONNECTION_UNLOCK (connection);
1098 _dbus_verbose ("locking io_path_mutex\n");
1099 _dbus_mutex_lock (connection->io_path_mutex);
1101 _dbus_verbose ("start connection->io_path_acquired = %d timeout = %d\n",
1102 connection->io_path_acquired, timeout_milliseconds);
1104 we_acquired = FALSE;
1106 if (connection->io_path_acquired)
1108 if (timeout_milliseconds != -1)
1110 _dbus_verbose ("waiting %d for IO path to be acquirable\n",
1111 timeout_milliseconds);
1113 if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1114 connection->io_path_mutex,
1115 timeout_milliseconds))
1117 /* We timed out before anyone signaled. */
1118 /* (writing the loop to handle the !timedout case by
1119 * waiting longer if needed is a pain since dbus
1120 * wraps pthread_cond_timedwait to take a relative
1121 * time instead of absolute, something kind of stupid
1122 * on our part. for now it doesn't matter, we will just
1123 * end up back here eventually.)
1129 while (connection->io_path_acquired)
1131 _dbus_verbose ("waiting for IO path to be acquirable\n");
1132 _dbus_condvar_wait (connection->io_path_cond,
1133 connection->io_path_mutex);
1138 if (!connection->io_path_acquired)
1141 connection->io_path_acquired = TRUE;
1144 _dbus_verbose ("end connection->io_path_acquired = %d we_acquired = %d\n",
1145 connection->io_path_acquired, we_acquired);
1147 _dbus_verbose ("unlocking io_path_mutex\n");
1148 _dbus_mutex_unlock (connection->io_path_mutex);
1150 CONNECTION_LOCK (connection);
1152 HAVE_LOCK_CHECK (connection);
1154 _dbus_connection_unref_unlocked (connection);
1160 * Release the I/O path when you're done with it. Only call
1161 * after you've acquired the I/O. Wakes up at most one thread
1162 * currently waiting to acquire the I/O path.
1164 * @param connection the connection.
1167 _dbus_connection_release_io_path (DBusConnection *connection)
1169 HAVE_LOCK_CHECK (connection);
1171 _dbus_verbose ("locking io_path_mutex\n");
1172 _dbus_mutex_lock (connection->io_path_mutex);
1174 _dbus_assert (connection->io_path_acquired);
1176 _dbus_verbose ("start connection->io_path_acquired = %d\n",
1177 connection->io_path_acquired);
1179 connection->io_path_acquired = FALSE;
1180 _dbus_condvar_wake_one (connection->io_path_cond);
1182 _dbus_verbose ("unlocking io_path_mutex\n");
1183 _dbus_mutex_unlock (connection->io_path_mutex);
1187 * Queues incoming messages and sends outgoing messages for this
1188 * connection, optionally blocking in the process. Each call to
1189 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1190 * time and then read or write data if possible.
1192 * The purpose of this function is to be able to flush outgoing
1193 * messages or queue up incoming messages without returning
1194 * control to the application and causing reentrancy weirdness.
1196 * The flags parameter allows you to specify whether to
1197 * read incoming messages, write outgoing messages, or both,
1198 * and whether to block if no immediate action is possible.
1200 * The timeout_milliseconds parameter does nothing unless the
1201 * iteration is blocking.
1203 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1204 * wasn't specified, then it's impossible to block, even if
1205 * you specify DBUS_ITERATION_BLOCK; in that case the function
1206 * returns immediately.
1208 * If pending is not NULL then a check is made if the pending call
1209 * is completed after the io path has been required. If the call
1210 * has been completed nothing is done. This must be done since
1211 * the _dbus_connection_acquire_io_path releases the connection
1214 * Called with connection lock held.
1216 * @param connection the connection.
1217 * @param pending the pending call that should be checked or NULL
1218 * @param flags iteration flags.
1219 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1222 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1223 DBusPendingCall *pending,
1225 int timeout_milliseconds)
1227 _dbus_verbose ("start\n");
1229 HAVE_LOCK_CHECK (connection);
1231 if (connection->n_outgoing == 0)
1232 flags &= ~DBUS_ITERATION_DO_WRITING;
1234 if (_dbus_connection_acquire_io_path (connection,
1235 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1237 HAVE_LOCK_CHECK (connection);
1239 if ( (pending != NULL) && _dbus_pending_call_get_completed_unlocked(pending))
1241 _dbus_verbose ("pending call completed while acquiring I/O path");
1243 else if ( (pending != NULL) &&
1244 _dbus_connection_peek_for_reply_unlocked (connection,
1245 _dbus_pending_call_get_reply_serial_unlocked (pending)))
1247 _dbus_verbose ("pending call completed while acquiring I/O path (reply found in queue)");
1251 _dbus_transport_do_iteration (connection->transport,
1252 flags, timeout_milliseconds);
1255 _dbus_connection_release_io_path (connection);
1258 HAVE_LOCK_CHECK (connection);
1260 _dbus_verbose ("end\n");
1264 * Creates a new connection for the given transport. A transport
1265 * represents a message stream that uses some concrete mechanism, such
1266 * as UNIX domain sockets. May return #NULL if insufficient
1267 * memory exists to create the connection.
1269 * @param transport the transport.
1270 * @returns the new connection, or #NULL on failure.
1273 _dbus_connection_new_for_transport (DBusTransport *transport)
1275 DBusConnection *connection;
1276 DBusWatchList *watch_list;
1277 DBusTimeoutList *timeout_list;
1278 DBusHashTable *pending_replies;
1279 DBusList *disconnect_link;
1280 DBusMessage *disconnect_message;
1281 DBusCounter *outgoing_counter;
1282 DBusObjectTree *objects;
1286 pending_replies = NULL;
1287 timeout_list = NULL;
1288 disconnect_link = NULL;
1289 disconnect_message = NULL;
1290 outgoing_counter = NULL;
1293 watch_list = _dbus_watch_list_new ();
1294 if (watch_list == NULL)
1297 timeout_list = _dbus_timeout_list_new ();
1298 if (timeout_list == NULL)
1302 _dbus_hash_table_new (DBUS_HASH_INT,
1304 (DBusFreeFunction)free_pending_call_on_hash_removal);
1305 if (pending_replies == NULL)
1308 connection = dbus_new0 (DBusConnection, 1);
1309 if (connection == NULL)
1312 _dbus_mutex_new_at_location (&connection->mutex);
1313 if (connection->mutex == NULL)
1316 _dbus_mutex_new_at_location (&connection->io_path_mutex);
1317 if (connection->io_path_mutex == NULL)
1320 _dbus_mutex_new_at_location (&connection->dispatch_mutex);
1321 if (connection->dispatch_mutex == NULL)
1324 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1325 if (connection->dispatch_cond == NULL)
1328 _dbus_condvar_new_at_location (&connection->io_path_cond);
1329 if (connection->io_path_cond == NULL)
1332 _dbus_mutex_new_at_location (&connection->slot_mutex);
1333 if (connection->slot_mutex == NULL)
1336 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1337 DBUS_INTERFACE_LOCAL,
1340 if (disconnect_message == NULL)
1343 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1344 if (disconnect_link == NULL)
1347 outgoing_counter = _dbus_counter_new ();
1348 if (outgoing_counter == NULL)
1351 objects = _dbus_object_tree_new (connection);
1352 if (objects == NULL)
1355 if (_dbus_modify_sigpipe)
1356 _dbus_disable_sigpipe ();
1358 /* initialized to 0: use atomic op to avoid mixing atomic and non-atomic */
1359 _dbus_atomic_inc (&connection->refcount);
1360 connection->transport = transport;
1361 connection->watches = watch_list;
1362 connection->timeouts = timeout_list;
1363 connection->pending_replies = pending_replies;
1364 connection->outgoing_counter = outgoing_counter;
1365 connection->filter_list = NULL;
1366 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1367 connection->objects = objects;
1368 connection->exit_on_disconnect = FALSE;
1369 connection->shareable = FALSE;
1370 connection->route_peer_messages = FALSE;
1371 connection->disconnected_message_arrived = FALSE;
1372 connection->disconnected_message_processed = FALSE;
1374 #ifndef DBUS_DISABLE_CHECKS
1375 connection->generation = _dbus_current_generation;
1378 _dbus_data_slot_list_init (&connection->slot_list);
1380 connection->client_serial = 1;
1382 connection->disconnect_message_link = disconnect_link;
1384 CONNECTION_LOCK (connection);
1386 if (!_dbus_transport_set_connection (transport, connection))
1388 CONNECTION_UNLOCK (connection);
1393 _dbus_transport_ref (transport);
1395 CONNECTION_UNLOCK (connection);
1400 if (disconnect_message != NULL)
1401 dbus_message_unref (disconnect_message);
1403 if (disconnect_link != NULL)
1404 _dbus_list_free_link (disconnect_link);
1406 if (connection != NULL)
1408 _dbus_condvar_free_at_location (&connection->io_path_cond);
1409 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1410 _dbus_mutex_free_at_location (&connection->mutex);
1411 _dbus_mutex_free_at_location (&connection->io_path_mutex);
1412 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
1413 _dbus_mutex_free_at_location (&connection->slot_mutex);
1414 dbus_free (connection);
1416 if (pending_replies)
1417 _dbus_hash_table_unref (pending_replies);
1420 _dbus_watch_list_free (watch_list);
1423 _dbus_timeout_list_free (timeout_list);
1425 if (outgoing_counter)
1426 _dbus_counter_unref (outgoing_counter);
1429 _dbus_object_tree_unref (objects);
1435 * Increments the reference count of a DBusConnection.
1436 * Requires that the caller already holds the connection lock.
1438 * @param connection the connection.
1439 * @returns the connection.
1442 _dbus_connection_ref_unlocked (DBusConnection *connection)
1444 _dbus_assert (connection != NULL);
1445 _dbus_assert (connection->generation == _dbus_current_generation);
1447 HAVE_LOCK_CHECK (connection);
1449 _dbus_atomic_inc (&connection->refcount);
1455 * Decrements the reference count of a DBusConnection.
1456 * Requires that the caller already holds the connection lock.
1458 * @param connection the connection.
1461 _dbus_connection_unref_unlocked (DBusConnection *connection)
1463 dbus_bool_t last_unref;
1465 HAVE_LOCK_CHECK (connection);
1467 _dbus_assert (connection != NULL);
1469 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1472 _dbus_connection_last_unref (connection);
1475 static dbus_uint32_t
1476 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1478 dbus_uint32_t serial;
1480 serial = connection->client_serial++;
1482 if (connection->client_serial == 0)
1483 connection->client_serial = 1;
1489 * A callback for use with dbus_watch_new() to create a DBusWatch.
1491 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1492 * and the virtual handle_watch in DBusTransport if we got rid of it.
1493 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1496 * @param watch the watch.
1497 * @param condition the current condition of the file descriptors being watched.
1498 * @param data must be a pointer to a #DBusConnection
1499 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1502 _dbus_connection_handle_watch (DBusWatch *watch,
1503 unsigned int condition,
1506 DBusConnection *connection;
1508 DBusDispatchStatus status;
1512 _dbus_verbose ("start\n");
1514 CONNECTION_LOCK (connection);
1516 if (!_dbus_connection_acquire_io_path (connection, 1))
1518 /* another thread is handling the message */
1519 CONNECTION_UNLOCK (connection);
1523 HAVE_LOCK_CHECK (connection);
1524 retval = _dbus_transport_handle_watch (connection->transport,
1527 _dbus_connection_release_io_path (connection);
1529 HAVE_LOCK_CHECK (connection);
1531 _dbus_verbose ("middle\n");
1533 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1535 /* this calls out to user code */
1536 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1538 _dbus_verbose ("end\n");
1543 _DBUS_DEFINE_GLOBAL_LOCK (shared_connections);
1544 static DBusHashTable *shared_connections = NULL;
1545 static DBusList *shared_connections_no_guid = NULL;
1548 close_connection_on_shutdown (DBusConnection *connection)
1550 DBusMessage *message;
1552 dbus_connection_ref (connection);
1553 _dbus_connection_close_possibly_shared (connection);
1555 /* Churn through to the Disconnected message */
1556 while ((message = dbus_connection_pop_message (connection)))
1558 dbus_message_unref (message);
1560 dbus_connection_unref (connection);
1564 shared_connections_shutdown (void *data)
1568 _DBUS_LOCK (shared_connections);
1570 /* This is a little bit unpleasant... better ideas? */
1571 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1573 DBusConnection *connection;
1576 _dbus_hash_iter_init (shared_connections, &iter);
1577 _dbus_hash_iter_next (&iter);
1579 connection = _dbus_hash_iter_get_value (&iter);
1581 _DBUS_UNLOCK (shared_connections);
1582 close_connection_on_shutdown (connection);
1583 _DBUS_LOCK (shared_connections);
1585 /* The connection should now be dead and not in our hash ... */
1586 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1589 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1591 _dbus_hash_table_unref (shared_connections);
1592 shared_connections = NULL;
1594 if (shared_connections_no_guid != NULL)
1596 DBusConnection *connection;
1597 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1598 while (connection != NULL)
1600 _DBUS_UNLOCK (shared_connections);
1601 close_connection_on_shutdown (connection);
1602 _DBUS_LOCK (shared_connections);
1603 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1607 shared_connections_no_guid = NULL;
1609 _DBUS_UNLOCK (shared_connections);
1613 connection_lookup_shared (DBusAddressEntry *entry,
1614 DBusConnection **result)
1616 _dbus_verbose ("checking for existing connection\n");
1620 _DBUS_LOCK (shared_connections);
1622 if (shared_connections == NULL)
1624 _dbus_verbose ("creating shared_connections hash table\n");
1626 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1629 if (shared_connections == NULL)
1631 _DBUS_UNLOCK (shared_connections);
1635 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1637 _dbus_hash_table_unref (shared_connections);
1638 shared_connections = NULL;
1639 _DBUS_UNLOCK (shared_connections);
1643 _dbus_verbose (" successfully created shared_connections\n");
1645 _DBUS_UNLOCK (shared_connections);
1646 return TRUE; /* no point looking up in the hash we just made */
1652 guid = dbus_address_entry_get_value (entry, "guid");
1656 DBusConnection *connection;
1658 connection = _dbus_hash_table_lookup_string (shared_connections,
1663 /* The DBusConnection can't be finalized without taking
1664 * the shared_connections lock to remove it from the
1665 * hash. So it's safe to ref the connection here.
1666 * However, it may be disconnected if the Disconnected
1667 * message hasn't been processed yet, in which case we
1668 * want to pretend it isn't in the hash and avoid
1671 * The idea is to avoid ever returning a disconnected connection
1672 * from dbus_connection_open(). We could just synchronously
1673 * drop our shared ref to the connection on connection disconnect,
1674 * and then assert here that the connection is connected, but
1675 * that causes reentrancy headaches.
1677 CONNECTION_LOCK (connection);
1678 if (_dbus_connection_get_is_connected_unlocked (connection))
1680 _dbus_connection_ref_unlocked (connection);
1681 *result = connection;
1682 _dbus_verbose ("looked up existing connection to server guid %s\n",
1687 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1690 CONNECTION_UNLOCK (connection);
1694 _DBUS_UNLOCK (shared_connections);
1700 connection_record_shared_unlocked (DBusConnection *connection,
1704 char *guid_in_connection;
1706 HAVE_LOCK_CHECK (connection);
1707 _dbus_assert (connection->server_guid == NULL);
1708 _dbus_assert (connection->shareable);
1710 /* get a hard ref on this connection, even if
1711 * we won't in fact store it in the hash, we still
1712 * need to hold a ref on it until it's disconnected.
1714 _dbus_connection_ref_unlocked (connection);
1718 _DBUS_LOCK (shared_connections);
1720 if (!_dbus_list_prepend (&shared_connections_no_guid, connection))
1722 _DBUS_UNLOCK (shared_connections);
1726 _DBUS_UNLOCK (shared_connections);
1727 return TRUE; /* don't store in the hash */
1730 /* A separate copy of the key is required in the hash table, because
1731 * we don't have a lock on the connection when we are doing a hash
1735 guid_key = _dbus_strdup (guid);
1736 if (guid_key == NULL)
1739 guid_in_connection = _dbus_strdup (guid);
1740 if (guid_in_connection == NULL)
1742 dbus_free (guid_key);
1746 _DBUS_LOCK (shared_connections);
1747 _dbus_assert (shared_connections != NULL);
1749 if (!_dbus_hash_table_insert_string (shared_connections,
1750 guid_key, connection))
1752 dbus_free (guid_key);
1753 dbus_free (guid_in_connection);
1754 _DBUS_UNLOCK (shared_connections);
1758 connection->server_guid = guid_in_connection;
1760 _dbus_verbose ("stored connection to %s to be shared\n",
1761 connection->server_guid);
1763 _DBUS_UNLOCK (shared_connections);
1765 _dbus_assert (connection->server_guid != NULL);
1771 connection_forget_shared_unlocked (DBusConnection *connection)
1773 HAVE_LOCK_CHECK (connection);
1775 if (!connection->shareable)
1778 _DBUS_LOCK (shared_connections);
1780 if (connection->server_guid != NULL)
1782 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1783 connection->server_guid);
1785 if (!_dbus_hash_table_remove_string (shared_connections,
1786 connection->server_guid))
1787 _dbus_assert_not_reached ("connection was not in the shared table");
1789 dbus_free (connection->server_guid);
1790 connection->server_guid = NULL;
1794 _dbus_list_remove (&shared_connections_no_guid, connection);
1797 _DBUS_UNLOCK (shared_connections);
1799 /* remove our reference held on all shareable connections */
1800 _dbus_connection_unref_unlocked (connection);
1803 static DBusConnection*
1804 connection_try_from_address_entry (DBusAddressEntry *entry,
1807 DBusTransport *transport;
1808 DBusConnection *connection;
1810 transport = _dbus_transport_open (entry, error);
1812 if (transport == NULL)
1814 _DBUS_ASSERT_ERROR_IS_SET (error);
1818 connection = _dbus_connection_new_for_transport (transport);
1820 _dbus_transport_unref (transport);
1822 if (connection == NULL)
1824 _DBUS_SET_OOM (error);
1828 #ifndef DBUS_DISABLE_CHECKS
1829 _dbus_assert (!connection->have_connection_lock);
1835 * If the shared parameter is true, then any existing connection will
1836 * be used (and if a new connection is created, it will be available
1837 * for use by others). If the shared parameter is false, a new
1838 * connection will always be created, and the new connection will
1839 * never be returned to other callers.
1841 * @param address the address
1842 * @param shared whether the connection is shared or private
1843 * @param error error return
1844 * @returns the connection or #NULL on error
1846 static DBusConnection*
1847 _dbus_connection_open_internal (const char *address,
1851 DBusConnection *connection;
1852 DBusAddressEntry **entries;
1853 DBusError tmp_error = DBUS_ERROR_INIT;
1854 DBusError first_error = DBUS_ERROR_INIT;
1857 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1859 _dbus_verbose ("opening %s connection to: %s\n",
1860 shared ? "shared" : "private", address);
1862 if (!dbus_parse_address (address, &entries, &len, error))
1865 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1869 for (i = 0; i < len; i++)
1873 if (!connection_lookup_shared (entries[i], &connection))
1874 _DBUS_SET_OOM (&tmp_error);
1877 if (connection == NULL)
1879 connection = connection_try_from_address_entry (entries[i],
1882 if (connection != NULL && shared)
1886 connection->shareable = TRUE;
1888 /* guid may be NULL */
1889 guid = dbus_address_entry_get_value (entries[i], "guid");
1891 CONNECTION_LOCK (connection);
1893 if (!connection_record_shared_unlocked (connection, guid))
1895 _DBUS_SET_OOM (&tmp_error);
1896 _dbus_connection_close_possibly_shared_and_unlock (connection);
1897 dbus_connection_unref (connection);
1901 CONNECTION_UNLOCK (connection);
1908 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1911 dbus_move_error (&tmp_error, &first_error);
1913 dbus_error_free (&tmp_error);
1916 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1917 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1919 if (connection == NULL)
1921 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1922 dbus_move_error (&first_error, error);
1925 dbus_error_free (&first_error);
1927 dbus_address_entries_free (entries);
1932 * Closes a shared OR private connection, while dbus_connection_close() can
1933 * only be used on private connections. Should only be called by the
1934 * dbus code that owns the connection - an owner must be known,
1935 * the open/close state is like malloc/free, not like ref/unref.
1937 * @param connection the connection
1940 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1942 _dbus_assert (connection != NULL);
1943 _dbus_assert (connection->generation == _dbus_current_generation);
1945 CONNECTION_LOCK (connection);
1946 _dbus_connection_close_possibly_shared_and_unlock (connection);
1949 static DBusPreallocatedSend*
1950 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1952 DBusPreallocatedSend *preallocated;
1954 HAVE_LOCK_CHECK (connection);
1956 _dbus_assert (connection != NULL);
1958 preallocated = dbus_new (DBusPreallocatedSend, 1);
1959 if (preallocated == NULL)
1962 if (connection->link_cache != NULL)
1964 preallocated->queue_link =
1965 _dbus_list_pop_first_link (&connection->link_cache);
1966 preallocated->queue_link->data = NULL;
1970 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1971 if (preallocated->queue_link == NULL)
1975 if (connection->link_cache != NULL)
1977 preallocated->counter_link =
1978 _dbus_list_pop_first_link (&connection->link_cache);
1979 preallocated->counter_link->data = connection->outgoing_counter;
1983 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1984 if (preallocated->counter_link == NULL)
1988 _dbus_counter_ref (preallocated->counter_link->data);
1990 preallocated->connection = connection;
1992 return preallocated;
1995 _dbus_list_free_link (preallocated->queue_link);
1997 dbus_free (preallocated);
2002 /* Called with lock held, does not update dispatch status */
2004 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
2005 DBusPreallocatedSend *preallocated,
2006 DBusMessage *message,
2007 dbus_uint32_t *client_serial)
2009 dbus_uint32_t serial;
2011 preallocated->queue_link->data = message;
2012 _dbus_list_prepend_link (&connection->outgoing_messages,
2013 preallocated->queue_link);
2015 /* It's OK that we'll never call the notify function, because for the
2016 * outgoing limit, there isn't one */
2017 _dbus_message_add_counter_link (message,
2018 preallocated->counter_link);
2020 dbus_free (preallocated);
2021 preallocated = NULL;
2023 dbus_message_ref (message);
2025 connection->n_outgoing += 1;
2027 _dbus_verbose ("Message %p (%s %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
2029 dbus_message_type_to_string (dbus_message_get_type (message)),
2030 dbus_message_get_path (message) ?
2031 dbus_message_get_path (message) :
2033 dbus_message_get_interface (message) ?
2034 dbus_message_get_interface (message) :
2036 dbus_message_get_member (message) ?
2037 dbus_message_get_member (message) :
2039 dbus_message_get_signature (message),
2040 dbus_message_get_destination (message) ?
2041 dbus_message_get_destination (message) :
2044 connection->n_outgoing);
2046 if (dbus_message_get_serial (message) == 0)
2048 serial = _dbus_connection_get_next_client_serial (connection);
2049 dbus_message_set_serial (message, serial);
2051 *client_serial = serial;
2056 *client_serial = dbus_message_get_serial (message);
2059 _dbus_verbose ("Message %p serial is %u\n",
2060 message, dbus_message_get_serial (message));
2062 dbus_message_lock (message);
2064 /* Now we need to run an iteration to hopefully just write the messages
2065 * out immediately, and otherwise get them queued up
2067 _dbus_connection_do_iteration_unlocked (connection,
2069 DBUS_ITERATION_DO_WRITING,
2072 /* If stuff is still queued up, be sure we wake up the main loop */
2073 if (connection->n_outgoing > 0)
2074 _dbus_connection_wakeup_mainloop (connection);
2078 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2079 DBusPreallocatedSend *preallocated,
2080 DBusMessage *message,
2081 dbus_uint32_t *client_serial)
2083 DBusDispatchStatus status;
2085 HAVE_LOCK_CHECK (connection);
2087 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2089 message, client_serial);
2091 _dbus_verbose ("middle\n");
2092 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2094 /* this calls out to user code */
2095 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2099 * Like dbus_connection_send(), but assumes the connection
2100 * is already locked on function entry, and unlocks before returning.
2102 * @param connection the connection
2103 * @param message the message to send
2104 * @param client_serial return location for client serial of sent message
2105 * @returns #FALSE on out-of-memory
2108 _dbus_connection_send_and_unlock (DBusConnection *connection,
2109 DBusMessage *message,
2110 dbus_uint32_t *client_serial)
2112 DBusPreallocatedSend *preallocated;
2114 _dbus_assert (connection != NULL);
2115 _dbus_assert (message != NULL);
2117 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2118 if (preallocated == NULL)
2120 CONNECTION_UNLOCK (connection);
2124 _dbus_connection_send_preallocated_and_unlock (connection,
2132 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2133 * If the new connection function does not ref the connection, we want to close it.
2135 * A bit of a hack, probably the new connection function should have returned a value
2136 * for whether to close, or should have had to close the connection itself if it
2139 * But, this works OK as long as the new connection function doesn't do anything
2140 * crazy like keep the connection around without ref'ing it.
2142 * We have to lock the connection across refcount check and close in case
2143 * the new connection function spawns a thread that closes and unrefs.
2144 * In that case, if the app thread
2145 * closes and unrefs first, we'll harmlessly close again; if the app thread
2146 * still has the ref, we'll close and then the app will close harmlessly.
2147 * If the app unrefs without closing, the app is broken since if the
2148 * app refs from the new connection function it is supposed to also close.
2150 * If we didn't atomically check the refcount and close with the lock held
2151 * though, we could screw this up.
2153 * @param connection the connection
2156 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2158 dbus_int32_t refcount;
2160 CONNECTION_LOCK (connection);
2162 refcount = _dbus_atomic_get (&connection->refcount);
2163 /* The caller should have at least one ref */
2164 _dbus_assert (refcount >= 1);
2167 _dbus_connection_close_possibly_shared_and_unlock (connection);
2169 CONNECTION_UNLOCK (connection);
2174 * When a function that blocks has been called with a timeout, and we
2175 * run out of memory, the time to wait for memory is based on the
2176 * timeout. If the caller was willing to block a long time we wait a
2177 * relatively long time for memory, if they were only willing to block
2178 * briefly then we retry for memory at a rapid rate.
2180 * @timeout_milliseconds the timeout requested for blocking
2183 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2185 if (timeout_milliseconds == -1)
2186 _dbus_sleep_milliseconds (1000);
2187 else if (timeout_milliseconds < 100)
2188 ; /* just busy loop */
2189 else if (timeout_milliseconds <= 1000)
2190 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2192 _dbus_sleep_milliseconds (1000);
2195 static DBusMessage *
2196 generate_local_error_message (dbus_uint32_t serial,
2200 DBusMessage *message;
2201 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2205 if (!dbus_message_set_error_name (message, error_name))
2207 dbus_message_unref (message);
2212 dbus_message_set_no_reply (message, TRUE);
2214 if (!dbus_message_set_reply_serial (message,
2217 dbus_message_unref (message);
2222 if (error_msg != NULL)
2224 DBusMessageIter iter;
2226 dbus_message_iter_init_append (message, &iter);
2227 if (!dbus_message_iter_append_basic (&iter,
2231 dbus_message_unref (message);
2242 * Peek the incoming queue to see if we got reply for a specific serial
2245 _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
2246 dbus_uint32_t client_serial)
2249 HAVE_LOCK_CHECK (connection);
2251 link = _dbus_list_get_first_link (&connection->incoming_messages);
2253 while (link != NULL)
2255 DBusMessage *reply = link->data;
2257 if (dbus_message_get_reply_serial (reply) == client_serial)
2259 _dbus_verbose ("%s reply to %d found in queue\n", _DBUS_FUNCTION_NAME, client_serial);
2262 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2268 /* This is slightly strange since we can pop a message here without
2269 * the dispatch lock.
2272 check_for_reply_unlocked (DBusConnection *connection,
2273 dbus_uint32_t client_serial)
2277 HAVE_LOCK_CHECK (connection);
2279 link = _dbus_list_get_first_link (&connection->incoming_messages);
2281 while (link != NULL)
2283 DBusMessage *reply = link->data;
2285 if (dbus_message_get_reply_serial (reply) == client_serial)
2287 _dbus_list_remove_link (&connection->incoming_messages, link);
2288 connection->n_incoming -= 1;
2291 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2298 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2300 /* We can't iterate over the hash in the normal way since we'll be
2301 * dropping the lock for each item. So we restart the
2302 * iter each time as we drain the hash table.
2305 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2307 DBusPendingCall *pending;
2310 _dbus_hash_iter_init (connection->pending_replies, &iter);
2311 _dbus_hash_iter_next (&iter);
2313 pending = _dbus_hash_iter_get_value (&iter);
2314 _dbus_pending_call_ref_unlocked (pending);
2316 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2319 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
2320 _dbus_connection_remove_timeout_unlocked (connection,
2321 _dbus_pending_call_get_timeout_unlocked (pending));
2322 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2323 _dbus_hash_iter_remove_entry (&iter);
2325 _dbus_pending_call_unref_and_unlock (pending);
2326 CONNECTION_LOCK (connection);
2328 HAVE_LOCK_CHECK (connection);
2332 complete_pending_call_and_unlock (DBusConnection *connection,
2333 DBusPendingCall *pending,
2334 DBusMessage *message)
2336 _dbus_pending_call_set_reply_unlocked (pending, message);
2337 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2338 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2340 /* Must be called unlocked since it invokes app callback */
2341 _dbus_pending_call_complete (pending);
2342 dbus_pending_call_unref (pending);
2346 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2347 DBusPendingCall *pending)
2350 DBusDispatchStatus status;
2352 reply = check_for_reply_unlocked (connection,
2353 _dbus_pending_call_get_reply_serial_unlocked (pending));
2356 _dbus_verbose ("checked for reply\n");
2358 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2360 complete_pending_call_and_unlock (connection, pending, reply);
2361 dbus_message_unref (reply);
2363 CONNECTION_LOCK (connection);
2364 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2365 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2366 dbus_pending_call_unref (pending);
2375 * Blocks until a pending call times out or gets a reply.
2377 * Does not re-enter the main loop or run filter/path-registered
2378 * callbacks. The reply to the message will not be seen by
2381 * Returns immediately if pending call already got a reply.
2383 * @todo could use performance improvements (it keeps scanning
2384 * the whole message queue for example)
2386 * @param pending the pending call we block for a reply on
2389 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2391 long start_tv_sec, start_tv_usec;
2392 long tv_sec, tv_usec;
2393 DBusDispatchStatus status;
2394 DBusConnection *connection;
2395 dbus_uint32_t client_serial;
2396 DBusTimeout *timeout;
2397 int timeout_milliseconds, elapsed_milliseconds;
2399 _dbus_assert (pending != NULL);
2401 if (dbus_pending_call_get_completed (pending))
2404 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2406 connection = _dbus_pending_call_get_connection_and_lock (pending);
2408 /* Flush message queue - note, can affect dispatch status */
2409 _dbus_connection_flush_unlocked (connection);
2411 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2413 /* note that timeout_milliseconds is limited to a smallish value
2414 * in _dbus_pending_call_new() so overflows aren't possible
2417 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
2418 _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
2421 timeout_milliseconds = dbus_timeout_get_interval (timeout);
2423 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec\n",
2424 timeout_milliseconds,
2426 start_tv_sec, start_tv_usec);
2430 timeout_milliseconds = -1;
2432 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block for reply serial %u\n", client_serial);
2435 /* check to see if we already got the data off the socket */
2436 /* from another blocked pending call */
2437 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2440 /* Now we wait... */
2441 /* always block at least once as we know we don't have the reply yet */
2442 _dbus_connection_do_iteration_unlocked (connection,
2444 DBUS_ITERATION_DO_READING |
2445 DBUS_ITERATION_BLOCK,
2446 timeout_milliseconds);
2450 _dbus_verbose ("top of recheck\n");
2452 HAVE_LOCK_CHECK (connection);
2454 /* queue messages and get status */
2456 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2458 /* the get_completed() is in case a dispatch() while we were blocking
2459 * got the reply instead of us.
2461 if (_dbus_pending_call_get_completed_unlocked (pending))
2463 _dbus_verbose ("Pending call completed by dispatch\n");
2464 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2465 dbus_pending_call_unref (pending);
2469 if (status == DBUS_DISPATCH_DATA_REMAINS)
2471 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2475 _dbus_get_current_time (&tv_sec, &tv_usec);
2476 elapsed_milliseconds = (tv_sec - start_tv_sec) * 1000 +
2477 (tv_usec - start_tv_usec) / 1000;
2479 if (!_dbus_connection_get_is_connected_unlocked (connection))
2481 DBusMessage *error_msg;
2483 error_msg = generate_local_error_message (client_serial,
2484 DBUS_ERROR_DISCONNECTED,
2485 "Connection was disconnected before a reply was received");
2487 /* on OOM error_msg is set to NULL */
2488 complete_pending_call_and_unlock (connection, pending, error_msg);
2489 dbus_pending_call_unref (pending);
2492 else if (connection->disconnect_message_link == NULL)
2493 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2494 else if (timeout == NULL)
2496 if (status == DBUS_DISPATCH_NEED_MEMORY)
2498 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2499 * we may already have a reply in the buffer and just can't process
2502 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2504 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2508 /* block again, we don't have the reply buffered yet. */
2509 _dbus_connection_do_iteration_unlocked (connection,
2511 DBUS_ITERATION_DO_READING |
2512 DBUS_ITERATION_BLOCK,
2513 timeout_milliseconds - elapsed_milliseconds);
2516 goto recheck_status;
2518 else if (tv_sec < start_tv_sec)
2519 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2520 else if (elapsed_milliseconds < timeout_milliseconds)
2522 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds - elapsed_milliseconds);
2524 if (status == DBUS_DISPATCH_NEED_MEMORY)
2526 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2527 * we may already have a reply in the buffer and just can't process
2530 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2532 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2536 /* block again, we don't have the reply buffered yet. */
2537 _dbus_connection_do_iteration_unlocked (connection,
2539 DBUS_ITERATION_DO_READING |
2540 DBUS_ITERATION_BLOCK,
2541 timeout_milliseconds - elapsed_milliseconds);
2544 goto recheck_status;
2547 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %d milliseconds and got no reply\n",
2548 elapsed_milliseconds);
2550 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2552 /* unlock and call user code */
2553 complete_pending_call_and_unlock (connection, pending, NULL);
2555 /* update user code on dispatch status */
2556 CONNECTION_LOCK (connection);
2557 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2558 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2559 dbus_pending_call_unref (pending);
2565 * @addtogroup DBusConnection
2571 * Gets a connection to a remote address. If a connection to the given
2572 * address already exists, returns the existing connection with its
2573 * reference count incremented. Otherwise, returns a new connection
2574 * and saves the new connection for possible re-use if a future call
2575 * to dbus_connection_open() asks to connect to the same server.
2577 * Use dbus_connection_open_private() to get a dedicated connection
2578 * not shared with other callers of dbus_connection_open().
2580 * If the open fails, the function returns #NULL, and provides a
2581 * reason for the failure in the error parameter. Pass #NULL for the
2582 * error parameter if you aren't interested in the reason for
2585 * Because this connection is shared, no user of the connection
2586 * may call dbus_connection_close(). However, when you are done with the
2587 * connection you should call dbus_connection_unref().
2589 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2590 * unless you have good reason; connections are expensive enough
2591 * that it's wasteful to create lots of connections to the same
2594 * @param address the address.
2595 * @param error address where an error can be returned.
2596 * @returns new connection, or #NULL on failure.
2599 dbus_connection_open (const char *address,
2602 DBusConnection *connection;
2604 _dbus_return_val_if_fail (address != NULL, NULL);
2605 _dbus_return_val_if_error_is_set (error, NULL);
2607 connection = _dbus_connection_open_internal (address,
2615 * Opens a new, dedicated connection to a remote address. Unlike
2616 * dbus_connection_open(), always creates a new connection.
2617 * This connection will not be saved or recycled by libdbus.
2619 * If the open fails, the function returns #NULL, and provides a
2620 * reason for the failure in the error parameter. Pass #NULL for the
2621 * error parameter if you aren't interested in the reason for
2624 * When you are done with this connection, you must
2625 * dbus_connection_close() to disconnect it,
2626 * and dbus_connection_unref() to free the connection object.
2628 * (The dbus_connection_close() can be skipped if the
2629 * connection is already known to be disconnected, for example
2630 * if you are inside a handler for the Disconnected signal.)
2632 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2633 * unless you have good reason; connections are expensive enough
2634 * that it's wasteful to create lots of connections to the same
2637 * @param address the address.
2638 * @param error address where an error can be returned.
2639 * @returns new connection, or #NULL on failure.
2642 dbus_connection_open_private (const char *address,
2645 DBusConnection *connection;
2647 _dbus_return_val_if_fail (address != NULL, NULL);
2648 _dbus_return_val_if_error_is_set (error, NULL);
2650 connection = _dbus_connection_open_internal (address,
2658 * Increments the reference count of a DBusConnection.
2660 * @param connection the connection.
2661 * @returns the connection.
2664 dbus_connection_ref (DBusConnection *connection)
2666 _dbus_return_val_if_fail (connection != NULL, NULL);
2667 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2669 _dbus_atomic_inc (&connection->refcount);
2675 free_outgoing_message (void *element,
2678 DBusMessage *message = element;
2679 DBusConnection *connection = data;
2681 _dbus_message_remove_counter (message,
2682 connection->outgoing_counter,
2684 dbus_message_unref (message);
2687 /* This is run without the mutex held, but after the last reference
2688 * to the connection has been dropped we should have no thread-related
2692 _dbus_connection_last_unref (DBusConnection *connection)
2696 _dbus_verbose ("Finalizing connection %p\n", connection);
2698 _dbus_assert (_dbus_atomic_get (&connection->refcount) == 0);
2700 /* You have to disconnect the connection before unref:ing it. Otherwise
2701 * you won't get the disconnected message.
2703 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2704 _dbus_assert (connection->server_guid == NULL);
2706 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2707 _dbus_object_tree_free_all_unlocked (connection->objects);
2709 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2710 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2711 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2713 _dbus_watch_list_free (connection->watches);
2714 connection->watches = NULL;
2716 _dbus_timeout_list_free (connection->timeouts);
2717 connection->timeouts = NULL;
2719 _dbus_data_slot_list_free (&connection->slot_list);
2721 link = _dbus_list_get_first_link (&connection->filter_list);
2722 while (link != NULL)
2724 DBusMessageFilter *filter = link->data;
2725 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2727 filter->function = NULL;
2728 _dbus_message_filter_unref (filter); /* calls app callback */
2733 _dbus_list_clear (&connection->filter_list);
2735 /* ---- Done with stuff that invokes application callbacks */
2737 _dbus_object_tree_unref (connection->objects);
2739 _dbus_hash_table_unref (connection->pending_replies);
2740 connection->pending_replies = NULL;
2742 _dbus_list_clear (&connection->filter_list);
2744 _dbus_list_foreach (&connection->outgoing_messages,
2745 free_outgoing_message,
2747 _dbus_list_clear (&connection->outgoing_messages);
2749 _dbus_list_foreach (&connection->incoming_messages,
2750 (DBusForeachFunction) dbus_message_unref,
2752 _dbus_list_clear (&connection->incoming_messages);
2754 _dbus_counter_unref (connection->outgoing_counter);
2756 _dbus_transport_unref (connection->transport);
2758 if (connection->disconnect_message_link)
2760 DBusMessage *message = connection->disconnect_message_link->data;
2761 dbus_message_unref (message);
2762 _dbus_list_free_link (connection->disconnect_message_link);
2765 _dbus_list_clear (&connection->link_cache);
2767 _dbus_condvar_free_at_location (&connection->dispatch_cond);
2768 _dbus_condvar_free_at_location (&connection->io_path_cond);
2770 _dbus_mutex_free_at_location (&connection->io_path_mutex);
2771 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
2773 _dbus_mutex_free_at_location (&connection->slot_mutex);
2775 _dbus_mutex_free_at_location (&connection->mutex);
2777 dbus_free (connection);
2781 * Decrements the reference count of a DBusConnection, and finalizes
2782 * it if the count reaches zero.
2784 * Note: it is a bug to drop the last reference to a connection that
2785 * is still connected.
2787 * For shared connections, libdbus will own a reference
2788 * as long as the connection is connected, so you can know that either
2789 * you don't have the last reference, or it's OK to drop the last reference.
2790 * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2791 * return shared connections.
2793 * For private connections, the creator of the connection must arrange for
2794 * dbus_connection_close() to be called prior to dropping the last reference.
2795 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2797 * @param connection the connection.
2800 dbus_connection_unref (DBusConnection *connection)
2802 dbus_bool_t last_unref;
2804 _dbus_return_if_fail (connection != NULL);
2805 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2807 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
2811 #ifndef DBUS_DISABLE_CHECKS
2812 if (_dbus_transport_get_is_connected (connection->transport))
2814 _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",
2815 connection->shareable ?
2816 "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2817 "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2821 _dbus_connection_last_unref (connection);
2826 * Note that the transport can disconnect itself (other end drops us)
2827 * and in that case this function never runs. So this function must
2828 * not do anything more than disconnect the transport and update the
2831 * If the transport self-disconnects, then we assume someone will
2832 * dispatch the connection to cause the dispatch status update.
2835 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2837 DBusDispatchStatus status;
2839 HAVE_LOCK_CHECK (connection);
2841 _dbus_verbose ("Disconnecting %p\n", connection);
2843 /* We need to ref because update_dispatch_status_and_unlock will unref
2844 * the connection if it was shared and libdbus was the only remaining
2847 _dbus_connection_ref_unlocked (connection);
2849 _dbus_transport_disconnect (connection->transport);
2851 /* This has the side effect of queuing the disconnect message link
2852 * (unless we don't have enough memory, possibly, so don't assert it).
2853 * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2854 * should never again return the newly-disconnected connection.
2856 * However, we only unref the shared connection and exit_on_disconnect when
2857 * the disconnect message reaches the head of the message queue,
2858 * NOT when it's first queued.
2860 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2862 /* This calls out to user code */
2863 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2865 /* Could also call out to user code */
2866 dbus_connection_unref (connection);
2870 * Closes a private connection, so no further data can be sent or received.
2871 * This disconnects the transport (such as a socket) underlying the
2874 * Attempts to send messages after closing a connection are safe, but will result in
2875 * error replies generated locally in libdbus.
2877 * This function does not affect the connection's reference count. It's
2878 * safe to close a connection more than once; all calls after the
2879 * first do nothing. It's impossible to "reopen" a connection, a
2880 * new connection must be created. This function may result in a call
2881 * to the DBusDispatchStatusFunction set with
2882 * dbus_connection_set_dispatch_status_function(), as the disconnect
2883 * message it generates needs to be dispatched.
2885 * If a connection is dropped by the remote application, it will
2888 * You must close a connection prior to releasing the last reference to
2889 * the connection. If you dbus_connection_unref() for the last time
2890 * without closing the connection, the results are undefined; it
2891 * is a bug in your program and libdbus will try to print a warning.
2893 * You may not close a shared connection. Connections created with
2894 * dbus_connection_open() or dbus_bus_get() are shared.
2895 * These connections are owned by libdbus, and applications should
2896 * only unref them, never close them. Applications can know it is
2897 * safe to unref these connections because libdbus will be holding a
2898 * reference as long as the connection is open. Thus, either the
2899 * connection is closed and it is OK to drop the last reference,
2900 * or the connection is open and the app knows it does not have the
2903 * Connections created with dbus_connection_open_private() or
2904 * dbus_bus_get_private() are not kept track of or referenced by
2905 * libdbus. The creator of these connections is responsible for
2906 * calling dbus_connection_close() prior to releasing the last
2907 * reference, if the connection is not already disconnected.
2909 * @param connection the private (unshared) connection to close
2912 dbus_connection_close (DBusConnection *connection)
2914 _dbus_return_if_fail (connection != NULL);
2915 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2917 CONNECTION_LOCK (connection);
2919 #ifndef DBUS_DISABLE_CHECKS
2920 if (connection->shareable)
2922 CONNECTION_UNLOCK (connection);
2924 _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2929 _dbus_connection_close_possibly_shared_and_unlock (connection);
2933 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2935 HAVE_LOCK_CHECK (connection);
2936 return _dbus_transport_get_is_connected (connection->transport);
2940 * Gets whether the connection is currently open. A connection may
2941 * become disconnected when the remote application closes its end, or
2942 * exits; a connection may also be disconnected with
2943 * dbus_connection_close().
2945 * There are not separate states for "closed" and "disconnected," the two
2946 * terms are synonymous. This function should really be called
2947 * get_is_open() but for historical reasons is not.
2949 * @param connection the connection.
2950 * @returns #TRUE if the connection is still alive.
2953 dbus_connection_get_is_connected (DBusConnection *connection)
2957 _dbus_return_val_if_fail (connection != NULL, FALSE);
2959 CONNECTION_LOCK (connection);
2960 res = _dbus_connection_get_is_connected_unlocked (connection);
2961 CONNECTION_UNLOCK (connection);
2967 * Gets whether the connection was authenticated. (Note that
2968 * if the connection was authenticated then disconnected,
2969 * this function still returns #TRUE)
2971 * @param connection the connection
2972 * @returns #TRUE if the connection was ever authenticated
2975 dbus_connection_get_is_authenticated (DBusConnection *connection)
2979 _dbus_return_val_if_fail (connection != NULL, FALSE);
2981 CONNECTION_LOCK (connection);
2982 res = _dbus_transport_get_is_authenticated (connection->transport);
2983 CONNECTION_UNLOCK (connection);
2989 * Gets whether the connection is not authenticated as a specific
2990 * user. If the connection is not authenticated, this function
2991 * returns #TRUE, and if it is authenticated but as an anonymous user,
2992 * it returns #TRUE. If it is authenticated as a specific user, then
2993 * this returns #FALSE. (Note that if the connection was authenticated
2994 * as anonymous then disconnected, this function still returns #TRUE.)
2996 * If the connection is not anonymous, you can use
2997 * dbus_connection_get_unix_user() and
2998 * dbus_connection_get_windows_user() to see who it's authorized as.
3000 * If you want to prevent non-anonymous authorization, use
3001 * dbus_server_set_auth_mechanisms() to remove the mechanisms that
3002 * allow proving user identity (i.e. only allow the ANONYMOUS
3005 * @param connection the connection
3006 * @returns #TRUE if not authenticated or authenticated as anonymous
3009 dbus_connection_get_is_anonymous (DBusConnection *connection)
3013 _dbus_return_val_if_fail (connection != NULL, FALSE);
3015 CONNECTION_LOCK (connection);
3016 res = _dbus_transport_get_is_anonymous (connection->transport);
3017 CONNECTION_UNLOCK (connection);
3023 * Gets the ID of the server address we are authenticated to, if this
3024 * connection is on the client side. If the connection is on the
3025 * server side, this will always return #NULL - use dbus_server_get_id()
3026 * to get the ID of your own server, if you are the server side.
3028 * If a client-side connection is not authenticated yet, the ID may be
3029 * available if it was included in the server address, but may not be
3030 * available. The only way to be sure the server ID is available
3031 * is to wait for authentication to complete.
3033 * In general, each mode of connecting to a given server will have
3034 * its own ID. So for example, if the session bus daemon is listening
3035 * on UNIX domain sockets and on TCP, then each of those modalities
3036 * will have its own server ID.
3038 * If you want an ID that identifies an entire session bus, look at
3039 * dbus_bus_get_id() instead (which is just a convenience wrapper
3040 * around the org.freedesktop.DBus.GetId method invoked on the bus).
3042 * You can also get a machine ID; see dbus_get_local_machine_id() to
3043 * get the machine you are on. There isn't a convenience wrapper, but
3044 * you can invoke org.freedesktop.DBus.Peer.GetMachineId on any peer
3045 * to get the machine ID on the other end.
3047 * The D-Bus specification describes the server ID and other IDs in a
3050 * @param connection the connection
3051 * @returns the server ID or #NULL if no memory or the connection is server-side
3054 dbus_connection_get_server_id (DBusConnection *connection)
3058 _dbus_return_val_if_fail (connection != NULL, NULL);
3060 CONNECTION_LOCK (connection);
3061 id = _dbus_strdup (_dbus_transport_get_server_id (connection->transport));
3062 CONNECTION_UNLOCK (connection);
3068 * Tests whether a certain type can be send via the connection. This
3069 * will always return TRUE for all types, with the exception of
3070 * DBUS_TYPE_UNIX_FD. The function will return TRUE for
3071 * DBUS_TYPE_UNIX_FD only on systems that know Unix file descriptors
3072 * and can send them via the chosen transport and when the remote side
3075 * This function can be used to do runtime checking for types that
3076 * might be unknown to the specific D-Bus client implementation
3077 * version, i.e. it will return FALSE for all types this
3078 * implementation does not know, including invalid or reserved types.
3080 * @param connection the connection
3081 * @param type the type to check
3082 * @returns TRUE if the type may be send via the connection
3085 dbus_connection_can_send_type(DBusConnection *connection,
3088 _dbus_return_val_if_fail (connection != NULL, FALSE);
3090 if (!dbus_type_is_valid (type))
3093 if (type != DBUS_TYPE_UNIX_FD)
3096 #ifdef HAVE_UNIX_FD_PASSING
3100 CONNECTION_LOCK(connection);
3101 b = _dbus_transport_can_pass_unix_fd(connection->transport);
3102 CONNECTION_UNLOCK(connection);
3112 * Set whether _exit() should be called when the connection receives a
3113 * disconnect signal. The call to _exit() comes after any handlers for
3114 * the disconnect signal run; handlers can cancel the exit by calling
3117 * By default, exit_on_disconnect is #FALSE; but for message bus
3118 * connections returned from dbus_bus_get() it will be toggled on
3121 * @param connection the connection
3122 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
3125 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
3126 dbus_bool_t exit_on_disconnect)
3128 _dbus_return_if_fail (connection != NULL);
3130 CONNECTION_LOCK (connection);
3131 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
3132 CONNECTION_UNLOCK (connection);
3136 * Preallocates resources needed to send a message, allowing the message
3137 * to be sent without the possibility of memory allocation failure.
3138 * Allows apps to create a future guarantee that they can send
3139 * a message regardless of memory shortages.
3141 * @param connection the connection we're preallocating for.
3142 * @returns the preallocated resources, or #NULL
3144 DBusPreallocatedSend*
3145 dbus_connection_preallocate_send (DBusConnection *connection)
3147 DBusPreallocatedSend *preallocated;
3149 _dbus_return_val_if_fail (connection != NULL, NULL);
3151 CONNECTION_LOCK (connection);
3154 _dbus_connection_preallocate_send_unlocked (connection);
3156 CONNECTION_UNLOCK (connection);
3158 return preallocated;
3162 * Frees preallocated message-sending resources from
3163 * dbus_connection_preallocate_send(). Should only
3164 * be called if the preallocated resources are not used
3165 * to send a message.
3167 * @param connection the connection
3168 * @param preallocated the resources
3171 dbus_connection_free_preallocated_send (DBusConnection *connection,
3172 DBusPreallocatedSend *preallocated)
3174 _dbus_return_if_fail (connection != NULL);
3175 _dbus_return_if_fail (preallocated != NULL);
3176 _dbus_return_if_fail (connection == preallocated->connection);
3178 _dbus_list_free_link (preallocated->queue_link);
3179 _dbus_counter_unref (preallocated->counter_link->data);
3180 _dbus_list_free_link (preallocated->counter_link);
3181 dbus_free (preallocated);
3185 * Sends a message using preallocated resources. This function cannot fail.
3186 * It works identically to dbus_connection_send() in other respects.
3187 * Preallocated resources comes from dbus_connection_preallocate_send().
3188 * This function "consumes" the preallocated resources, they need not
3189 * be freed separately.
3191 * @param connection the connection
3192 * @param preallocated the preallocated resources
3193 * @param message the message to send
3194 * @param client_serial return location for client serial assigned to the message
3197 dbus_connection_send_preallocated (DBusConnection *connection,
3198 DBusPreallocatedSend *preallocated,
3199 DBusMessage *message,
3200 dbus_uint32_t *client_serial)
3202 _dbus_return_if_fail (connection != NULL);
3203 _dbus_return_if_fail (preallocated != NULL);
3204 _dbus_return_if_fail (message != NULL);
3205 _dbus_return_if_fail (preallocated->connection == connection);
3206 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3207 dbus_message_get_member (message) != NULL);
3208 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
3209 (dbus_message_get_interface (message) != NULL &&
3210 dbus_message_get_member (message) != NULL));
3212 CONNECTION_LOCK (connection);
3214 #ifdef HAVE_UNIX_FD_PASSING
3216 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3217 message->n_unix_fds > 0)
3219 /* Refuse to send fds on a connection that cannot handle
3220 them. Unfortunately we cannot return a proper error here, so
3221 the best we can is just return. */
3222 CONNECTION_UNLOCK (connection);
3228 _dbus_connection_send_preallocated_and_unlock (connection,
3230 message, client_serial);
3234 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
3235 DBusMessage *message,
3236 dbus_uint32_t *client_serial)
3238 DBusPreallocatedSend *preallocated;
3240 _dbus_assert (connection != NULL);
3241 _dbus_assert (message != NULL);
3243 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
3244 if (preallocated == NULL)
3247 _dbus_connection_send_preallocated_unlocked_no_update (connection,
3255 * Adds a message to the outgoing message queue. Does not block to
3256 * write the message to the network; that happens asynchronously. To
3257 * force the message to be written, call dbus_connection_flush() however
3258 * it is not necessary to call dbus_connection_flush() by hand; the
3259 * message will be sent the next time the main loop is run.
3260 * dbus_connection_flush() should only be used, for example, if
3261 * the application was expected to exit before running the main loop.
3263 * Because this only queues the message, the only reason it can
3264 * fail is lack of memory. Even if the connection is disconnected,
3265 * no error will be returned. If the function fails due to lack of memory,
3266 * it returns #FALSE. The function will never fail for other reasons; even
3267 * if the connection is disconnected, you can queue an outgoing message,
3268 * though obviously it won't be sent.
3270 * The message serial is used by the remote application to send a
3271 * reply; see dbus_message_get_serial() or the D-Bus specification.
3273 * dbus_message_unref() can be called as soon as this method returns
3274 * as the message queue will hold its own ref until the message is sent.
3276 * @param connection the connection.
3277 * @param message the message to write.
3278 * @param serial return location for message serial, or #NULL if you don't care
3279 * @returns #TRUE on success.
3282 dbus_connection_send (DBusConnection *connection,
3283 DBusMessage *message,
3284 dbus_uint32_t *serial)
3286 _dbus_return_val_if_fail (connection != NULL, FALSE);
3287 _dbus_return_val_if_fail (message != NULL, FALSE);
3289 CONNECTION_LOCK (connection);
3291 #ifdef HAVE_UNIX_FD_PASSING
3293 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3294 message->n_unix_fds > 0)
3296 /* Refuse to send fds on a connection that cannot handle
3297 them. Unfortunately we cannot return a proper error here, so
3298 the best we can is just return. */
3299 CONNECTION_UNLOCK (connection);
3305 return _dbus_connection_send_and_unlock (connection,
3311 reply_handler_timeout (void *data)
3313 DBusConnection *connection;
3314 DBusDispatchStatus status;
3315 DBusPendingCall *pending = data;
3317 connection = _dbus_pending_call_get_connection_and_lock (pending);
3318 _dbus_connection_ref_unlocked (connection);
3320 _dbus_pending_call_queue_timeout_error_unlocked (pending,
3322 _dbus_connection_remove_timeout_unlocked (connection,
3323 _dbus_pending_call_get_timeout_unlocked (pending));
3324 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
3326 _dbus_verbose ("middle\n");
3327 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3329 /* Unlocks, and calls out to user code */
3330 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3331 dbus_connection_unref (connection);
3337 * Queues a message to send, as with dbus_connection_send(),
3338 * but also returns a #DBusPendingCall used to receive a reply to the
3339 * message. If no reply is received in the given timeout_milliseconds,
3340 * this function expires the pending reply and generates a synthetic
3341 * error reply (generated in-process, not by the remote application)
3342 * indicating that a timeout occurred.
3344 * A #DBusPendingCall will see a reply message before any filters or
3345 * registered object path handlers. See dbus_connection_dispatch() for
3346 * details on when handlers are run.
3348 * A #DBusPendingCall will always see exactly one reply message,
3349 * unless it's cancelled with dbus_pending_call_cancel().
3351 * If #NULL is passed for the pending_return, the #DBusPendingCall
3352 * will still be generated internally, and used to track
3353 * the message reply timeout. This means a timeout error will
3354 * occur if no reply arrives, unlike with dbus_connection_send().
3356 * If -1 is passed for the timeout, a sane default timeout is used. -1
3357 * is typically the best value for the timeout for this reason, unless
3358 * you want a very short or very long timeout. If #DBUS_TIMEOUT_INFINITE is
3359 * passed for the timeout, no timeout will be set and the call will block
3362 * @warning if the connection is disconnected or you try to send Unix
3363 * file descriptors on a connection that does not support them, the
3364 * #DBusPendingCall will be set to #NULL, so be careful with this.
3366 * @param connection the connection
3367 * @param message the message to send
3368 * @param pending_return return location for a #DBusPendingCall
3369 * object, or #NULL if connection is disconnected or when you try to
3370 * send Unix file descriptors on a connection that does not support
3372 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3373 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3375 * @returns #FALSE if no memory, #TRUE otherwise.
3379 dbus_connection_send_with_reply (DBusConnection *connection,
3380 DBusMessage *message,
3381 DBusPendingCall **pending_return,
3382 int timeout_milliseconds)
3384 DBusPendingCall *pending;
3385 dbus_int32_t serial = -1;
3386 DBusDispatchStatus status;
3388 _dbus_return_val_if_fail (connection != NULL, FALSE);
3389 _dbus_return_val_if_fail (message != NULL, FALSE);
3390 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3393 *pending_return = NULL;
3395 CONNECTION_LOCK (connection);
3397 #ifdef HAVE_UNIX_FD_PASSING
3399 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3400 message->n_unix_fds > 0)
3402 /* Refuse to send fds on a connection that cannot handle
3403 them. Unfortunately we cannot return a proper error here, so
3404 the best we can do is return TRUE but leave *pending_return
3406 CONNECTION_UNLOCK (connection);
3412 if (!_dbus_connection_get_is_connected_unlocked (connection))
3414 CONNECTION_UNLOCK (connection);
3419 pending = _dbus_pending_call_new_unlocked (connection,
3420 timeout_milliseconds,
3421 reply_handler_timeout);
3423 if (pending == NULL)
3425 CONNECTION_UNLOCK (connection);
3429 /* Assign a serial to the message */
3430 serial = dbus_message_get_serial (message);
3433 serial = _dbus_connection_get_next_client_serial (connection);
3434 dbus_message_set_serial (message, serial);
3437 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3440 /* Insert the serial in the pending replies hash;
3441 * hash takes a refcount on DBusPendingCall.
3442 * Also, add the timeout.
3444 if (!_dbus_connection_attach_pending_call_unlocked (connection,
3448 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3450 _dbus_connection_detach_pending_call_and_unlock (connection,
3452 goto error_unlocked;
3456 *pending_return = pending; /* hand off refcount */
3459 _dbus_connection_detach_pending_call_unlocked (connection, pending);
3460 /* we still have a ref to the pending call in this case, we unref
3461 * after unlocking, below
3465 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3467 /* this calls out to user code */
3468 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3470 if (pending_return == NULL)
3471 dbus_pending_call_unref (pending);
3476 CONNECTION_UNLOCK (connection);
3478 dbus_pending_call_unref (pending);
3483 * Sends a message and blocks a certain time period while waiting for
3484 * a reply. This function does not reenter the main loop,
3485 * i.e. messages other than the reply are queued up but not
3486 * processed. This function is used to invoke method calls on a
3489 * If a normal reply is received, it is returned, and removed from the
3490 * incoming message queue. If it is not received, #NULL is returned
3491 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3492 * received, it is converted to a #DBusError and returned as an error,
3493 * then the reply message is deleted and #NULL is returned. If
3494 * something else goes wrong, result is set to whatever is
3495 * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3496 * #DBUS_ERROR_DISCONNECTED.
3498 * @warning While this function blocks the calling thread will not be
3499 * processing the incoming message queue. This means you can end up
3500 * deadlocked if the application you're talking to needs you to reply
3501 * to a method. To solve this, either avoid the situation, block in a
3502 * separate thread from the main connection-dispatching thread, or use
3503 * dbus_pending_call_set_notify() to avoid blocking.
3505 * @param connection the connection
3506 * @param message the message to send
3507 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3508 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3510 * @param error return location for error message
3511 * @returns the message that is the reply or #NULL with an error code if the
3515 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3516 DBusMessage *message,
3517 int timeout_milliseconds,
3521 DBusPendingCall *pending;
3523 _dbus_return_val_if_fail (connection != NULL, NULL);
3524 _dbus_return_val_if_fail (message != NULL, NULL);
3525 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3526 _dbus_return_val_if_error_is_set (error, NULL);
3528 #ifdef HAVE_UNIX_FD_PASSING
3530 CONNECTION_LOCK (connection);
3531 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3532 message->n_unix_fds > 0)
3534 CONNECTION_UNLOCK (connection);
3535 dbus_set_error(error, DBUS_ERROR_FAILED, "Cannot send file descriptors on this connection.");
3538 CONNECTION_UNLOCK (connection);
3542 if (!dbus_connection_send_with_reply (connection, message,
3543 &pending, timeout_milliseconds))
3545 _DBUS_SET_OOM (error);
3549 if (pending == NULL)
3551 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3555 dbus_pending_call_block (pending);
3557 reply = dbus_pending_call_steal_reply (pending);
3558 dbus_pending_call_unref (pending);
3560 /* call_complete_and_unlock() called from pending_call_block() should
3561 * always fill this in.
3563 _dbus_assert (reply != NULL);
3565 if (dbus_set_error_from_message (error, reply))
3567 dbus_message_unref (reply);
3575 * Blocks until the outgoing message queue is empty.
3576 * Assumes connection lock already held.
3578 * If you call this, you MUST call update_dispatch_status afterword...
3580 * @param connection the connection.
3582 static DBusDispatchStatus
3583 _dbus_connection_flush_unlocked (DBusConnection *connection)
3585 /* We have to specify DBUS_ITERATION_DO_READING here because
3586 * otherwise we could have two apps deadlock if they are both doing
3587 * a flush(), and the kernel buffers fill up. This could change the
3590 DBusDispatchStatus status;
3592 HAVE_LOCK_CHECK (connection);
3594 while (connection->n_outgoing > 0 &&
3595 _dbus_connection_get_is_connected_unlocked (connection))
3597 _dbus_verbose ("doing iteration in\n");
3598 HAVE_LOCK_CHECK (connection);
3599 _dbus_connection_do_iteration_unlocked (connection,
3601 DBUS_ITERATION_DO_READING |
3602 DBUS_ITERATION_DO_WRITING |
3603 DBUS_ITERATION_BLOCK,
3607 HAVE_LOCK_CHECK (connection);
3608 _dbus_verbose ("middle\n");
3609 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3611 HAVE_LOCK_CHECK (connection);
3616 * Blocks until the outgoing message queue is empty.
3618 * @param connection the connection.
3621 dbus_connection_flush (DBusConnection *connection)
3623 /* We have to specify DBUS_ITERATION_DO_READING here because
3624 * otherwise we could have two apps deadlock if they are both doing
3625 * a flush(), and the kernel buffers fill up. This could change the
3628 DBusDispatchStatus status;
3630 _dbus_return_if_fail (connection != NULL);
3632 CONNECTION_LOCK (connection);
3634 status = _dbus_connection_flush_unlocked (connection);
3636 HAVE_LOCK_CHECK (connection);
3637 /* Unlocks and calls out to user code */
3638 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3640 _dbus_verbose ("end\n");
3644 * This function implements dbus_connection_read_write_dispatch() and
3645 * dbus_connection_read_write() (they pass a different value for the
3646 * dispatch parameter).
3648 * @param connection the connection
3649 * @param timeout_milliseconds max time to block or -1 for infinite
3650 * @param dispatch dispatch new messages or leave them on the incoming queue
3651 * @returns #TRUE if the disconnect message has not been processed
3654 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3655 int timeout_milliseconds,
3656 dbus_bool_t dispatch)
3658 DBusDispatchStatus dstatus;
3659 dbus_bool_t progress_possible;
3661 /* Need to grab a ref here in case we're a private connection and
3662 * the user drops the last ref in a handler we call; see bug
3663 * https://bugs.freedesktop.org/show_bug.cgi?id=15635
3665 dbus_connection_ref (connection);
3666 dstatus = dbus_connection_get_dispatch_status (connection);
3668 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3670 _dbus_verbose ("doing dispatch\n");
3671 dbus_connection_dispatch (connection);
3672 CONNECTION_LOCK (connection);
3674 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3676 _dbus_verbose ("pausing for memory\n");
3677 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3678 CONNECTION_LOCK (connection);
3682 CONNECTION_LOCK (connection);
3683 if (_dbus_connection_get_is_connected_unlocked (connection))
3685 _dbus_verbose ("doing iteration\n");
3686 _dbus_connection_do_iteration_unlocked (connection,
3688 DBUS_ITERATION_DO_READING |
3689 DBUS_ITERATION_DO_WRITING |
3690 DBUS_ITERATION_BLOCK,
3691 timeout_milliseconds);
3695 HAVE_LOCK_CHECK (connection);
3696 /* If we can dispatch, we can make progress until the Disconnected message
3697 * has been processed; if we can only read/write, we can make progress
3698 * as long as the transport is open.
3701 progress_possible = connection->n_incoming != 0 ||
3702 connection->disconnect_message_link != NULL;
3704 progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3706 CONNECTION_UNLOCK (connection);
3708 dbus_connection_unref (connection);
3710 return progress_possible; /* TRUE if we can make more progress */
3715 * This function is intended for use with applications that don't want
3716 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3717 * example usage would be:
3720 * while (dbus_connection_read_write_dispatch (connection, -1))
3721 * ; // empty loop body
3724 * In this usage you would normally have set up a filter function to look
3725 * at each message as it is dispatched. The loop terminates when the last
3726 * message from the connection (the disconnected signal) is processed.
3728 * If there are messages to dispatch, this function will
3729 * dbus_connection_dispatch() once, and return. If there are no
3730 * messages to dispatch, this function will block until it can read or
3731 * write, then read or write, then return.
3733 * The way to think of this function is that it either makes some sort
3734 * of progress, or it blocks. Note that, while it is blocked on I/O, it
3735 * cannot be interrupted (even by other threads), which makes this function
3736 * unsuitable for applications that do more than just react to received
3739 * The return value indicates whether the disconnect message has been
3740 * processed, NOT whether the connection is connected. This is
3741 * important because even after disconnecting, you want to process any
3742 * messages you received prior to the disconnect.
3744 * @param connection the connection
3745 * @param timeout_milliseconds max time to block or -1 for infinite
3746 * @returns #TRUE if the disconnect message has not been processed
3749 dbus_connection_read_write_dispatch (DBusConnection *connection,
3750 int timeout_milliseconds)
3752 _dbus_return_val_if_fail (connection != NULL, FALSE);
3753 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3754 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3758 * This function is intended for use with applications that don't want to
3759 * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3760 * dbus_connection_read_write_dispatch().
3762 * As long as the connection is open, this function will block until it can
3763 * read or write, then read or write, then return #TRUE.
3765 * If the connection is closed, the function returns #FALSE.
3767 * The return value indicates whether reading or writing is still
3768 * possible, i.e. whether the connection is connected.
3770 * Note that even after disconnection, messages may remain in the
3771 * incoming queue that need to be
3772 * processed. dbus_connection_read_write_dispatch() dispatches
3773 * incoming messages for you; with dbus_connection_read_write() you
3774 * have to arrange to drain the incoming queue yourself.
3776 * @param connection the connection
3777 * @param timeout_milliseconds max time to block or -1 for infinite
3778 * @returns #TRUE if still connected
3781 dbus_connection_read_write (DBusConnection *connection,
3782 int timeout_milliseconds)
3784 _dbus_return_val_if_fail (connection != NULL, FALSE);
3785 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3786 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3789 /* We need to call this anytime we pop the head of the queue, and then
3790 * update_dispatch_status_and_unlock needs to be called afterward
3791 * which will "process" the disconnected message and set
3792 * disconnected_message_processed.
3795 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3796 DBusMessage *head_of_queue)
3798 HAVE_LOCK_CHECK (connection);
3800 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3801 if (connection->disconnect_message_link == NULL &&
3802 dbus_message_is_signal (head_of_queue,
3803 DBUS_INTERFACE_LOCAL,
3806 connection->disconnected_message_arrived = TRUE;
3811 * Returns the first-received message from the incoming message queue,
3812 * leaving it in the queue. If the queue is empty, returns #NULL.
3814 * The caller does not own a reference to the returned message, and
3815 * must either return it using dbus_connection_return_message() or
3816 * keep it after calling dbus_connection_steal_borrowed_message(). No
3817 * one can get at the message while its borrowed, so return it as
3818 * quickly as possible and don't keep a reference to it after
3819 * returning it. If you need to keep the message, make a copy of it.
3821 * dbus_connection_dispatch() will block if called while a borrowed
3822 * message is outstanding; only one piece of code can be playing with
3823 * the incoming queue at a time. This function will block if called
3824 * during a dbus_connection_dispatch().
3826 * @param connection the connection.
3827 * @returns next message in the incoming queue.
3830 dbus_connection_borrow_message (DBusConnection *connection)
3832 DBusDispatchStatus status;
3833 DBusMessage *message;
3835 _dbus_return_val_if_fail (connection != NULL, NULL);
3837 _dbus_verbose ("start\n");
3839 /* this is called for the side effect that it queues
3840 * up any messages from the transport
3842 status = dbus_connection_get_dispatch_status (connection);
3843 if (status != DBUS_DISPATCH_DATA_REMAINS)
3846 CONNECTION_LOCK (connection);
3848 _dbus_connection_acquire_dispatch (connection);
3850 /* While a message is outstanding, the dispatch lock is held */
3851 _dbus_assert (connection->message_borrowed == NULL);
3853 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3855 message = connection->message_borrowed;
3857 check_disconnected_message_arrived_unlocked (connection, message);
3859 /* Note that we KEEP the dispatch lock until the message is returned */
3860 if (message == NULL)
3861 _dbus_connection_release_dispatch (connection);
3863 CONNECTION_UNLOCK (connection);
3865 /* We don't update dispatch status until it's returned or stolen */
3871 * Used to return a message after peeking at it using
3872 * dbus_connection_borrow_message(). Only called if
3873 * message from dbus_connection_borrow_message() was non-#NULL.
3875 * @param connection the connection
3876 * @param message the message from dbus_connection_borrow_message()
3879 dbus_connection_return_message (DBusConnection *connection,
3880 DBusMessage *message)
3882 DBusDispatchStatus status;
3884 _dbus_return_if_fail (connection != NULL);
3885 _dbus_return_if_fail (message != NULL);
3886 _dbus_return_if_fail (message == connection->message_borrowed);
3887 _dbus_return_if_fail (connection->dispatch_acquired);
3889 CONNECTION_LOCK (connection);
3891 _dbus_assert (message == connection->message_borrowed);
3893 connection->message_borrowed = NULL;
3895 _dbus_connection_release_dispatch (connection);
3897 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3898 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3902 * Used to keep a message after peeking at it using
3903 * dbus_connection_borrow_message(). Before using this function, see
3904 * the caveats/warnings in the documentation for
3905 * dbus_connection_pop_message().
3907 * @param connection the connection
3908 * @param message the message from dbus_connection_borrow_message()
3911 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3912 DBusMessage *message)
3914 DBusMessage *pop_message;
3915 DBusDispatchStatus status;
3917 _dbus_return_if_fail (connection != NULL);
3918 _dbus_return_if_fail (message != NULL);
3919 _dbus_return_if_fail (message == connection->message_borrowed);
3920 _dbus_return_if_fail (connection->dispatch_acquired);
3922 CONNECTION_LOCK (connection);
3924 _dbus_assert (message == connection->message_borrowed);
3926 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3927 _dbus_assert (message == pop_message);
3929 connection->n_incoming -= 1;
3931 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3932 message, connection->n_incoming);
3934 connection->message_borrowed = NULL;
3936 _dbus_connection_release_dispatch (connection);
3938 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3939 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
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 '%s') 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 connection, connection->n_incoming);
3974 check_disconnected_message_arrived_unlocked (connection, link->data);
3982 /* See dbus_connection_pop_message, but requires the caller to own
3983 * the lock before calling. May drop the lock while running.
3986 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3990 HAVE_LOCK_CHECK (connection);
3992 link = _dbus_connection_pop_message_link_unlocked (connection);
3996 DBusMessage *message;
3998 message = link->data;
4000 _dbus_list_free_link (link);
4009 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
4010 DBusList *message_link)
4012 HAVE_LOCK_CHECK (connection);
4014 _dbus_assert (message_link != NULL);
4015 /* You can't borrow a message while a link is outstanding */
4016 _dbus_assert (connection->message_borrowed == NULL);
4017 /* We had to have the dispatch lock across the pop/putback */
4018 _dbus_assert (connection->dispatch_acquired);
4020 _dbus_list_prepend_link (&connection->incoming_messages,
4022 connection->n_incoming += 1;
4024 _dbus_verbose ("Message %p (%s %s %s '%s') put back into queue %p, %d incoming\n",
4026 dbus_message_type_to_string (dbus_message_get_type (message_link->data)),
4027 dbus_message_get_interface (message_link->data) ?
4028 dbus_message_get_interface (message_link->data) :
4030 dbus_message_get_member (message_link->data) ?
4031 dbus_message_get_member (message_link->data) :
4033 dbus_message_get_signature (message_link->data),
4034 connection, connection->n_incoming);
4038 * Returns the first-received message from the incoming message queue,
4039 * removing it from the queue. The caller owns a reference to the
4040 * returned message. If the queue is empty, returns #NULL.
4042 * This function bypasses any message handlers that are registered,
4043 * and so using it is usually wrong. Instead, let the main loop invoke
4044 * dbus_connection_dispatch(). Popping messages manually is only
4045 * useful in very simple programs that don't share a #DBusConnection
4046 * with any libraries or other modules.
4048 * There is a lock that covers all ways of accessing the incoming message
4049 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
4050 * dbus_connection_borrow_message(), etc. will all block while one of the others
4051 * in the group is running.
4053 * @param connection the connection.
4054 * @returns next message in the incoming queue.
4057 dbus_connection_pop_message (DBusConnection *connection)
4059 DBusMessage *message;
4060 DBusDispatchStatus status;
4062 _dbus_verbose ("start\n");
4064 /* this is called for the side effect that it queues
4065 * up any messages from the transport
4067 status = dbus_connection_get_dispatch_status (connection);
4068 if (status != DBUS_DISPATCH_DATA_REMAINS)
4071 CONNECTION_LOCK (connection);
4072 _dbus_connection_acquire_dispatch (connection);
4073 HAVE_LOCK_CHECK (connection);
4075 message = _dbus_connection_pop_message_unlocked (connection);
4077 _dbus_verbose ("Returning popped message %p\n", message);
4079 _dbus_connection_release_dispatch (connection);
4081 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4082 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4088 * Acquire the dispatcher. This is a separate lock so the main
4089 * connection lock can be dropped to call out to application dispatch
4092 * @param connection the connection.
4095 _dbus_connection_acquire_dispatch (DBusConnection *connection)
4097 HAVE_LOCK_CHECK (connection);
4099 _dbus_connection_ref_unlocked (connection);
4100 CONNECTION_UNLOCK (connection);
4102 _dbus_verbose ("locking dispatch_mutex\n");
4103 _dbus_mutex_lock (connection->dispatch_mutex);
4105 while (connection->dispatch_acquired)
4107 _dbus_verbose ("waiting for dispatch to be acquirable\n");
4108 _dbus_condvar_wait (connection->dispatch_cond,
4109 connection->dispatch_mutex);
4112 _dbus_assert (!connection->dispatch_acquired);
4114 connection->dispatch_acquired = TRUE;
4116 _dbus_verbose ("unlocking dispatch_mutex\n");
4117 _dbus_mutex_unlock (connection->dispatch_mutex);
4119 CONNECTION_LOCK (connection);
4120 _dbus_connection_unref_unlocked (connection);
4124 * Release the dispatcher when you're done with it. Only call
4125 * after you've acquired the dispatcher. Wakes up at most one
4126 * thread currently waiting to acquire the dispatcher.
4128 * @param connection the connection.
4131 _dbus_connection_release_dispatch (DBusConnection *connection)
4133 HAVE_LOCK_CHECK (connection);
4135 _dbus_verbose ("locking dispatch_mutex\n");
4136 _dbus_mutex_lock (connection->dispatch_mutex);
4138 _dbus_assert (connection->dispatch_acquired);
4140 connection->dispatch_acquired = FALSE;
4141 _dbus_condvar_wake_one (connection->dispatch_cond);
4143 _dbus_verbose ("unlocking dispatch_mutex\n");
4144 _dbus_mutex_unlock (connection->dispatch_mutex);
4148 _dbus_connection_failed_pop (DBusConnection *connection,
4149 DBusList *message_link)
4151 _dbus_list_prepend_link (&connection->incoming_messages,
4153 connection->n_incoming += 1;
4156 /* Note this may be called multiple times since we don't track whether we already did it */
4158 notify_disconnected_unlocked (DBusConnection *connection)
4160 HAVE_LOCK_CHECK (connection);
4162 /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
4163 * connection from dbus_bus_get(). We make the same guarantee for
4164 * dbus_connection_open() but in a different way since we don't want to
4165 * unref right here; we instead check for connectedness before returning
4166 * the connection from the hash.
4168 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
4170 /* Dump the outgoing queue, we aren't going to be able to
4171 * send it now, and we'd like accessors like
4172 * dbus_connection_get_outgoing_size() to be accurate.
4174 if (connection->n_outgoing > 0)
4178 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
4179 connection->n_outgoing);
4181 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
4183 _dbus_connection_message_sent_unlocked (connection, link->data);
4188 /* Note this may be called multiple times since we don't track whether we already did it */
4189 static DBusDispatchStatus
4190 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
4192 HAVE_LOCK_CHECK (connection);
4194 if (connection->disconnect_message_link != NULL)
4196 _dbus_verbose ("Sending disconnect message\n");
4198 /* If we have pending calls, queue their timeouts - we want the Disconnected
4199 * to be the last message, after these timeouts.
4201 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
4203 /* We haven't sent the disconnect message already,
4204 * and all real messages have been queued up.
4206 _dbus_connection_queue_synthesized_message_link (connection,
4207 connection->disconnect_message_link);
4208 connection->disconnect_message_link = NULL;
4210 return DBUS_DISPATCH_DATA_REMAINS;
4213 return DBUS_DISPATCH_COMPLETE;
4216 static DBusDispatchStatus
4217 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
4219 HAVE_LOCK_CHECK (connection);
4221 if (connection->n_incoming > 0)
4222 return DBUS_DISPATCH_DATA_REMAINS;
4223 else if (!_dbus_transport_queue_messages (connection->transport))
4224 return DBUS_DISPATCH_NEED_MEMORY;
4227 DBusDispatchStatus status;
4228 dbus_bool_t is_connected;
4230 status = _dbus_transport_get_dispatch_status (connection->transport);
4231 is_connected = _dbus_transport_get_is_connected (connection->transport);
4233 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
4234 DISPATCH_STATUS_NAME (status), is_connected);
4238 /* It's possible this would be better done by having an explicit
4239 * notification from _dbus_transport_disconnect() that would
4240 * synchronously do this, instead of waiting for the next dispatch
4241 * status check. However, probably not good to change until it causes
4244 notify_disconnected_unlocked (connection);
4246 /* I'm not sure this is needed; the idea is that we want to
4247 * queue the Disconnected only after we've read all the
4248 * messages, but if we're disconnected maybe we are guaranteed
4249 * to have read them all ?
4251 if (status == DBUS_DISPATCH_COMPLETE)
4252 status = notify_disconnected_and_dispatch_complete_unlocked (connection);
4255 if (status != DBUS_DISPATCH_COMPLETE)
4257 else if (connection->n_incoming > 0)
4258 return DBUS_DISPATCH_DATA_REMAINS;
4260 return DBUS_DISPATCH_COMPLETE;
4265 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
4266 DBusDispatchStatus new_status)
4268 dbus_bool_t changed;
4269 DBusDispatchStatusFunction function;
4272 HAVE_LOCK_CHECK (connection);
4274 _dbus_connection_ref_unlocked (connection);
4276 changed = new_status != connection->last_dispatch_status;
4278 connection->last_dispatch_status = new_status;
4280 function = connection->dispatch_status_function;
4281 data = connection->dispatch_status_data;
4283 if (connection->disconnected_message_arrived &&
4284 !connection->disconnected_message_processed)
4286 connection->disconnected_message_processed = TRUE;
4288 /* this does an unref, but we have a ref
4289 * so we should not run the finalizer here
4292 connection_forget_shared_unlocked (connection);
4294 if (connection->exit_on_disconnect)
4296 CONNECTION_UNLOCK (connection);
4298 _dbus_verbose ("Exiting on Disconnected signal\n");
4300 _dbus_assert_not_reached ("Call to exit() returned");
4304 /* We drop the lock */
4305 CONNECTION_UNLOCK (connection);
4307 if (changed && function)
4309 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
4310 connection, new_status,
4311 DISPATCH_STATUS_NAME (new_status));
4312 (* function) (connection, new_status, data);
4315 dbus_connection_unref (connection);
4319 * Gets the current state of the incoming message queue.
4320 * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
4321 * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
4322 * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
4323 * there could be data, but we can't know for sure without more
4326 * To process the incoming message queue, use dbus_connection_dispatch()
4327 * or (in rare cases) dbus_connection_pop_message().
4329 * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
4330 * have messages in the queue, or we have raw bytes buffered up
4331 * that need to be parsed. When these bytes are parsed, they
4332 * may not add up to an entire message. Thus, it's possible
4333 * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
4334 * have a message yet.
4336 * In particular this happens on initial connection, because all sorts
4337 * of authentication protocol stuff has to be parsed before the
4338 * first message arrives.
4340 * @param connection the connection.
4341 * @returns current dispatch status
4344 dbus_connection_get_dispatch_status (DBusConnection *connection)
4346 DBusDispatchStatus status;
4348 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4350 _dbus_verbose ("start\n");
4352 CONNECTION_LOCK (connection);
4354 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4356 CONNECTION_UNLOCK (connection);
4362 * Filter funtion for handling the Peer standard interface.
4364 static DBusHandlerResult
4365 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
4366 DBusMessage *message)
4368 dbus_bool_t sent = FALSE;
4369 DBusMessage *ret = NULL;
4370 DBusList *expire_link;
4372 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
4374 /* This means we're letting the bus route this message */
4375 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4378 if (!dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4380 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4383 /* Preallocate a linked-list link, so that if we need to dispose of a
4384 * message, we can attach it to the expired list */
4385 expire_link = _dbus_list_alloc_link (NULL);
4388 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4390 if (dbus_message_is_method_call (message,
4391 DBUS_INTERFACE_PEER,
4394 ret = dbus_message_new_method_return (message);
4398 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4400 else if (dbus_message_is_method_call (message,
4401 DBUS_INTERFACE_PEER,
4406 ret = dbus_message_new_method_return (message);
4410 _dbus_string_init (&uuid);
4411 if (_dbus_get_local_machine_uuid_encoded (&uuid))
4413 const char *v_STRING = _dbus_string_get_const_data (&uuid);
4414 if (dbus_message_append_args (ret,
4415 DBUS_TYPE_STRING, &v_STRING,
4418 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4421 _dbus_string_free (&uuid);
4425 /* We need to bounce anything else with this interface, otherwise apps
4426 * could start extending the interface and when we added extensions
4427 * here to DBusConnection we'd break those apps.
4429 ret = dbus_message_new_error (message,
4430 DBUS_ERROR_UNKNOWN_METHOD,
4431 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4435 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4441 _dbus_list_free_link (expire_link);
4445 /* It'll be safe to unref the reply when we unlock */
4446 expire_link->data = ret;
4447 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4451 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4453 return DBUS_HANDLER_RESULT_HANDLED;
4457 * Processes all builtin filter functions
4459 * If the spec specifies a standard interface
4460 * they should be processed from this method
4462 static DBusHandlerResult
4463 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4464 DBusMessage *message)
4466 /* We just run one filter for now but have the option to run more
4467 if the spec calls for it in the future */
4469 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4473 * Processes any incoming data.
4475 * If there's incoming raw data that has not yet been parsed, it is
4476 * parsed, which may or may not result in adding messages to the
4479 * The incoming data buffer is filled when the connection reads from
4480 * its underlying transport (such as a socket). Reading usually
4481 * happens in dbus_watch_handle() or dbus_connection_read_write().
4483 * If there are complete messages in the incoming queue,
4484 * dbus_connection_dispatch() removes one message from the queue and
4485 * processes it. Processing has three steps.
4487 * First, any method replies are passed to #DBusPendingCall or
4488 * dbus_connection_send_with_reply_and_block() in order to
4489 * complete the pending method call.
4491 * Second, any filters registered with dbus_connection_add_filter()
4492 * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4493 * then processing stops after that filter.
4495 * Third, if the message is a method call it is forwarded to
4496 * any registered object path handlers added with
4497 * dbus_connection_register_object_path() or
4498 * dbus_connection_register_fallback().
4500 * A single call to dbus_connection_dispatch() will process at most
4501 * one message; it will not clear the entire message queue.
4503 * Be careful about calling dbus_connection_dispatch() from inside a
4504 * message handler, i.e. calling dbus_connection_dispatch()
4505 * recursively. If threads have been initialized with a recursive
4506 * mutex function, then this will not deadlock; however, it can
4507 * certainly confuse your application.
4509 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4511 * @param connection the connection
4512 * @returns dispatch status, see dbus_connection_get_dispatch_status()
4515 dbus_connection_dispatch (DBusConnection *connection)
4517 DBusMessage *message;
4518 DBusList *link, *filter_list_copy, *message_link;
4519 DBusHandlerResult result;
4520 DBusPendingCall *pending;
4521 dbus_int32_t reply_serial;
4522 DBusDispatchStatus status;
4523 dbus_bool_t found_object;
4525 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4527 _dbus_verbose ("\n");
4529 CONNECTION_LOCK (connection);
4530 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4531 if (status != DBUS_DISPATCH_DATA_REMAINS)
4533 /* unlocks and calls out to user code */
4534 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4538 /* We need to ref the connection since the callback could potentially
4539 * drop the last ref to it
4541 _dbus_connection_ref_unlocked (connection);
4543 _dbus_connection_acquire_dispatch (connection);
4544 HAVE_LOCK_CHECK (connection);
4546 message_link = _dbus_connection_pop_message_link_unlocked (connection);
4547 if (message_link == NULL)
4549 /* another thread dispatched our stuff */
4551 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4553 _dbus_connection_release_dispatch (connection);
4555 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4557 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4559 dbus_connection_unref (connection);
4564 message = message_link->data;
4566 _dbus_verbose (" dispatching message %p (%s %s %s '%s')\n",
4568 dbus_message_type_to_string (dbus_message_get_type (message)),
4569 dbus_message_get_interface (message) ?
4570 dbus_message_get_interface (message) :
4572 dbus_message_get_member (message) ?
4573 dbus_message_get_member (message) :
4575 dbus_message_get_signature (message));
4577 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4579 /* Pending call handling must be first, because if you do
4580 * dbus_connection_send_with_reply_and_block() or
4581 * dbus_pending_call_block() then no handlers/filters will be run on
4582 * the reply. We want consistent semantics in the case where we
4583 * dbus_connection_dispatch() the reply.
4586 reply_serial = dbus_message_get_reply_serial (message);
4587 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4591 _dbus_verbose ("Dispatching a pending reply\n");
4592 complete_pending_call_and_unlock (connection, pending, message);
4593 pending = NULL; /* it's probably unref'd */
4595 CONNECTION_LOCK (connection);
4596 _dbus_verbose ("pending call completed in dispatch\n");
4597 result = DBUS_HANDLER_RESULT_HANDLED;
4601 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4602 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4605 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4607 _dbus_connection_release_dispatch (connection);
4608 HAVE_LOCK_CHECK (connection);
4610 _dbus_connection_failed_pop (connection, message_link);
4612 /* unlocks and calls user code */
4613 _dbus_connection_update_dispatch_status_and_unlock (connection,
4614 DBUS_DISPATCH_NEED_MEMORY);
4615 dbus_connection_unref (connection);
4617 return DBUS_DISPATCH_NEED_MEMORY;
4620 _dbus_list_foreach (&filter_list_copy,
4621 (DBusForeachFunction)_dbus_message_filter_ref,
4624 /* We're still protected from dispatch() reentrancy here
4625 * since we acquired the dispatcher
4627 CONNECTION_UNLOCK (connection);
4629 link = _dbus_list_get_first_link (&filter_list_copy);
4630 while (link != NULL)
4632 DBusMessageFilter *filter = link->data;
4633 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4635 if (filter->function == NULL)
4637 _dbus_verbose (" filter was removed in a callback function\n");
4642 _dbus_verbose (" running filter on message %p\n", message);
4643 result = (* filter->function) (connection, message, filter->user_data);
4645 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4651 _dbus_list_foreach (&filter_list_copy,
4652 (DBusForeachFunction)_dbus_message_filter_unref,
4654 _dbus_list_clear (&filter_list_copy);
4656 CONNECTION_LOCK (connection);
4658 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4660 _dbus_verbose ("No memory\n");
4663 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4665 _dbus_verbose ("filter handled message in dispatch\n");
4669 /* We're still protected from dispatch() reentrancy here
4670 * since we acquired the dispatcher
4672 _dbus_verbose (" running object path dispatch on message %p (%s %s %s '%s')\n",
4674 dbus_message_type_to_string (dbus_message_get_type (message)),
4675 dbus_message_get_interface (message) ?
4676 dbus_message_get_interface (message) :
4678 dbus_message_get_member (message) ?
4679 dbus_message_get_member (message) :
4681 dbus_message_get_signature (message));
4683 HAVE_LOCK_CHECK (connection);
4684 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4688 CONNECTION_LOCK (connection);
4690 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4692 _dbus_verbose ("object tree handled message in dispatch\n");
4696 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4700 DBusPreallocatedSend *preallocated;
4702 _dbus_verbose (" sending error %s\n",
4703 DBUS_ERROR_UNKNOWN_METHOD);
4705 if (!_dbus_string_init (&str))
4707 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4708 _dbus_verbose ("no memory for error string in dispatch\n");
4712 if (!_dbus_string_append_printf (&str,
4713 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4714 dbus_message_get_member (message),
4715 dbus_message_get_signature (message),
4716 dbus_message_get_interface (message)))
4718 _dbus_string_free (&str);
4719 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4720 _dbus_verbose ("no memory for error string in dispatch\n");
4724 reply = dbus_message_new_error (message,
4725 found_object ? DBUS_ERROR_UNKNOWN_METHOD : DBUS_ERROR_UNKNOWN_OBJECT,
4726 _dbus_string_get_const_data (&str));
4727 _dbus_string_free (&str);
4731 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4732 _dbus_verbose ("no memory for error reply in dispatch\n");
4736 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4738 if (preallocated == NULL)
4740 /* It's OK that this is finalized, because it hasn't been seen by
4741 * anything that could attach user callbacks */
4742 dbus_message_unref (reply);
4743 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4744 _dbus_verbose ("no memory for error send in dispatch\n");
4748 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4751 dbus_message_unref (reply);
4753 result = DBUS_HANDLER_RESULT_HANDLED;
4756 _dbus_verbose (" done dispatching %p (%s %s %s '%s') on connection %p\n", message,
4757 dbus_message_type_to_string (dbus_message_get_type (message)),
4758 dbus_message_get_interface (message) ?
4759 dbus_message_get_interface (message) :
4761 dbus_message_get_member (message) ?
4762 dbus_message_get_member (message) :
4764 dbus_message_get_signature (message),
4768 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4770 _dbus_verbose ("out of memory\n");
4772 /* Put message back, and we'll start over.
4773 * Yes this means handlers must be idempotent if they
4774 * don't return HANDLED; c'est la vie.
4776 _dbus_connection_putback_message_link_unlocked (connection,
4778 /* now we don't want to free them */
4779 message_link = NULL;
4784 _dbus_verbose (" ... done dispatching\n");
4787 _dbus_connection_release_dispatch (connection);
4788 HAVE_LOCK_CHECK (connection);
4790 if (message != NULL)
4792 /* We don't want this message to count in maximum message limits when
4793 * computing the dispatch status, below. We have to drop the lock
4794 * temporarily, because finalizing a message can trigger callbacks.
4796 * We have a reference to the connection, and we don't use any cached
4797 * pointers to the connection's internals below this point, so it should
4798 * be safe to drop the lock and take it back. */
4799 CONNECTION_UNLOCK (connection);
4800 dbus_message_unref (message);
4801 CONNECTION_LOCK (connection);
4804 if (message_link != NULL)
4805 _dbus_list_free_link (message_link);
4807 _dbus_verbose ("before final status update\n");
4808 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4810 /* unlocks and calls user code */
4811 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4813 dbus_connection_unref (connection);
4819 * Sets the watch functions for the connection. These functions are
4820 * responsible for making the application's main loop aware of file
4821 * descriptors that need to be monitored for events, using select() or
4822 * poll(). When using Qt, typically the DBusAddWatchFunction would
4823 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4824 * could call g_io_add_watch(), or could be used as part of a more
4825 * elaborate GSource. Note that when a watch is added, it may
4828 * The DBusWatchToggledFunction notifies the application that the
4829 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4830 * to check this. A disabled watch should have no effect, and enabled
4831 * watch should be added to the main loop. This feature is used
4832 * instead of simply adding/removing the watch because
4833 * enabling/disabling can be done without memory allocation. The
4834 * toggled function may be NULL if a main loop re-queries
4835 * dbus_watch_get_enabled() every time anyway.
4837 * The DBusWatch can be queried for the file descriptor to watch using
4838 * dbus_watch_get_unix_fd() or dbus_watch_get_socket(), and for the
4839 * events to watch for using dbus_watch_get_flags(). The flags
4840 * returned by dbus_watch_get_flags() will only contain
4841 * DBUS_WATCH_READABLE and DBUS_WATCH_WRITABLE, never
4842 * DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR; all watches implicitly
4843 * include a watch for hangups, errors, and other exceptional
4846 * Once a file descriptor becomes readable or writable, or an exception
4847 * occurs, dbus_watch_handle() should be called to
4848 * notify the connection of the file descriptor's condition.
4850 * dbus_watch_handle() cannot be called during the
4851 * DBusAddWatchFunction, as the connection will not be ready to handle
4854 * It is not allowed to reference a DBusWatch after it has been passed
4855 * to remove_function.
4857 * If #FALSE is returned due to lack of memory, the failure may be due
4858 * to a #FALSE return from the new add_function. If so, the
4859 * add_function may have been called successfully one or more times,
4860 * but the remove_function will also have been called to remove any
4861 * successful adds. i.e. if #FALSE is returned the net result
4862 * should be that dbus_connection_set_watch_functions() has no effect,
4863 * but the add_function and remove_function may have been called.
4865 * @note The thread lock on DBusConnection is held while
4866 * watch functions are invoked, so inside these functions you
4867 * may not invoke any methods on DBusConnection or it will deadlock.
4868 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/tread.html#8144
4869 * if you encounter this issue and want to attempt writing a patch.
4871 * @param connection the connection.
4872 * @param add_function function to begin monitoring a new descriptor.
4873 * @param remove_function function to stop monitoring a descriptor.
4874 * @param toggled_function function to notify of enable/disable
4875 * @param data data to pass to add_function and remove_function.
4876 * @param free_data_function function to be called to free the data.
4877 * @returns #FALSE on failure (no memory)
4880 dbus_connection_set_watch_functions (DBusConnection *connection,
4881 DBusAddWatchFunction add_function,
4882 DBusRemoveWatchFunction remove_function,
4883 DBusWatchToggledFunction toggled_function,
4885 DBusFreeFunction free_data_function)
4889 _dbus_return_val_if_fail (connection != NULL, FALSE);
4891 CONNECTION_LOCK (connection);
4893 retval = _dbus_watch_list_set_functions (connection->watches,
4894 add_function, remove_function,
4896 data, free_data_function);
4898 CONNECTION_UNLOCK (connection);
4904 * Sets the timeout functions for the connection. These functions are
4905 * responsible for making the application's main loop aware of timeouts.
4906 * When using Qt, typically the DBusAddTimeoutFunction would create a
4907 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4910 * The DBusTimeoutToggledFunction notifies the application that the
4911 * timeout has been enabled or disabled. Call
4912 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4913 * have no effect, and enabled timeout should be added to the main
4914 * loop. This feature is used instead of simply adding/removing the
4915 * timeout because enabling/disabling can be done without memory
4916 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4917 * to enable and disable. The toggled function may be NULL if a main
4918 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4919 * Whenever a timeout is toggled, its interval may change.
4921 * The DBusTimeout can be queried for the timer interval using
4922 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4923 * repeatedly, each time the interval elapses, starting after it has
4924 * elapsed once. The timeout stops firing when it is removed with the
4925 * given remove_function. The timer interval may change whenever the
4926 * timeout is added, removed, or toggled.
4928 * @note The thread lock on DBusConnection is held while
4929 * timeout functions are invoked, so inside these functions you
4930 * may not invoke any methods on DBusConnection or it will deadlock.
4931 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
4932 * if you encounter this issue and want to attempt writing a patch.
4934 * @param connection the connection.
4935 * @param add_function function to add a timeout.
4936 * @param remove_function function to remove a timeout.
4937 * @param toggled_function function to notify of enable/disable
4938 * @param data data to pass to add_function and remove_function.
4939 * @param free_data_function function to be called to free the data.
4940 * @returns #FALSE on failure (no memory)
4943 dbus_connection_set_timeout_functions (DBusConnection *connection,
4944 DBusAddTimeoutFunction add_function,
4945 DBusRemoveTimeoutFunction remove_function,
4946 DBusTimeoutToggledFunction toggled_function,
4948 DBusFreeFunction free_data_function)
4952 _dbus_return_val_if_fail (connection != NULL, FALSE);
4954 CONNECTION_LOCK (connection);
4956 retval = _dbus_timeout_list_set_functions (connection->timeouts,
4957 add_function, remove_function,
4959 data, free_data_function);
4961 CONNECTION_UNLOCK (connection);
4967 * Sets the mainloop wakeup function for the connection. This function
4968 * is responsible for waking up the main loop (if its sleeping in
4969 * another thread) when some some change has happened to the
4970 * connection that the mainloop needs to reconsider (e.g. a message
4971 * has been queued for writing). When using Qt, this typically
4972 * results in a call to QEventLoop::wakeUp(). When using GLib, it
4973 * would call g_main_context_wakeup().
4975 * @param connection the connection.
4976 * @param wakeup_main_function function to wake up the mainloop
4977 * @param data data to pass wakeup_main_function
4978 * @param free_data_function function to be called to free the data.
4981 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
4982 DBusWakeupMainFunction wakeup_main_function,
4984 DBusFreeFunction free_data_function)
4987 DBusFreeFunction old_free_data;
4989 _dbus_return_if_fail (connection != NULL);
4991 CONNECTION_LOCK (connection);
4992 old_data = connection->wakeup_main_data;
4993 old_free_data = connection->free_wakeup_main_data;
4995 connection->wakeup_main_function = wakeup_main_function;
4996 connection->wakeup_main_data = data;
4997 connection->free_wakeup_main_data = free_data_function;
4999 CONNECTION_UNLOCK (connection);
5001 /* Callback outside the lock */
5003 (*old_free_data) (old_data);
5007 * Set a function to be invoked when the dispatch status changes.
5008 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
5009 * dbus_connection_dispatch() needs to be called to process incoming
5010 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
5011 * from inside the DBusDispatchStatusFunction. Indeed, almost
5012 * any reentrancy in this function is a bad idea. Instead,
5013 * the DBusDispatchStatusFunction should simply save an indication
5014 * that messages should be dispatched later, when the main loop
5017 * If you don't set a dispatch status function, you have to be sure to
5018 * dispatch on every iteration of your main loop, especially if
5019 * dbus_watch_handle() or dbus_timeout_handle() were called.
5021 * @param connection the connection
5022 * @param function function to call on dispatch status changes
5023 * @param data data for function
5024 * @param free_data_function free the function data
5027 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
5028 DBusDispatchStatusFunction function,
5030 DBusFreeFunction free_data_function)
5033 DBusFreeFunction old_free_data;
5035 _dbus_return_if_fail (connection != NULL);
5037 CONNECTION_LOCK (connection);
5038 old_data = connection->dispatch_status_data;
5039 old_free_data = connection->free_dispatch_status_data;
5041 connection->dispatch_status_function = function;
5042 connection->dispatch_status_data = data;
5043 connection->free_dispatch_status_data = free_data_function;
5045 CONNECTION_UNLOCK (connection);
5047 /* Callback outside the lock */
5049 (*old_free_data) (old_data);
5053 * Get the UNIX file descriptor of the connection, if any. This can
5054 * be used for SELinux access control checks with getpeercon() for
5055 * example. DO NOT read or write to the file descriptor, or try to
5056 * select() on it; use DBusWatch for main loop integration. Not all
5057 * connections will have a file descriptor. So for adding descriptors
5058 * to the main loop, use dbus_watch_get_unix_fd() and so forth.
5060 * If the connection is socket-based, you can also use
5061 * dbus_connection_get_socket(), which will work on Windows too.
5062 * This function always fails on Windows.
5064 * Right now the returned descriptor is always a socket, but
5065 * that is not guaranteed.
5067 * @param connection the connection
5068 * @param fd return location for the file descriptor.
5069 * @returns #TRUE if fd is successfully obtained.
5072 dbus_connection_get_unix_fd (DBusConnection *connection,
5075 _dbus_return_val_if_fail (connection != NULL, FALSE);
5076 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5079 /* FIXME do this on a lower level */
5083 return dbus_connection_get_socket(connection, fd);
5087 * Gets the underlying Windows or UNIX socket file descriptor
5088 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
5089 * select() on it; use DBusWatch for main loop integration. Not all
5090 * connections will have a socket. So for adding descriptors
5091 * to the main loop, use dbus_watch_get_socket() and so forth.
5093 * If the connection is not socket-based, this function will return FALSE,
5094 * even if the connection does have a file descriptor of some kind.
5095 * i.e. this function always returns specifically a socket file descriptor.
5097 * @param connection the connection
5098 * @param fd return location for the file descriptor.
5099 * @returns #TRUE if fd is successfully obtained.
5102 dbus_connection_get_socket(DBusConnection *connection,
5107 _dbus_return_val_if_fail (connection != NULL, FALSE);
5108 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5110 CONNECTION_LOCK (connection);
5112 retval = _dbus_transport_get_socket_fd (connection->transport,
5115 CONNECTION_UNLOCK (connection);
5122 * Gets the UNIX user ID of the connection if known. Returns #TRUE if
5123 * the uid is filled in. Always returns #FALSE on non-UNIX platforms
5124 * for now, though in theory someone could hook Windows to NIS or
5125 * something. Always returns #FALSE prior to authenticating the
5128 * The UID is only read by servers from clients; clients can't usually
5129 * get the UID of servers, because servers do not authenticate to
5130 * clients. The returned UID is the UID the connection authenticated
5133 * The message bus is a server and the apps connecting to the bus
5136 * You can ask the bus to tell you the UID of another connection though
5137 * if you like; this is done with dbus_bus_get_unix_user().
5139 * @param connection the connection
5140 * @param uid return location for the user ID
5141 * @returns #TRUE if uid is filled in with a valid user ID
5144 dbus_connection_get_unix_user (DBusConnection *connection,
5149 _dbus_return_val_if_fail (connection != NULL, FALSE);
5150 _dbus_return_val_if_fail (uid != NULL, FALSE);
5152 CONNECTION_LOCK (connection);
5154 if (!_dbus_transport_get_is_authenticated (connection->transport))
5157 result = _dbus_transport_get_unix_user (connection->transport,
5161 _dbus_assert (!result);
5164 CONNECTION_UNLOCK (connection);
5170 * Gets the process ID of the connection if any.
5171 * Returns #TRUE if the pid is filled in.
5172 * Always returns #FALSE prior to authenticating the
5175 * @param connection the connection
5176 * @param pid return location for the process ID
5177 * @returns #TRUE if uid is filled in with a valid process ID
5180 dbus_connection_get_unix_process_id (DBusConnection *connection,
5185 _dbus_return_val_if_fail (connection != NULL, FALSE);
5186 _dbus_return_val_if_fail (pid != NULL, FALSE);
5188 CONNECTION_LOCK (connection);
5190 if (!_dbus_transport_get_is_authenticated (connection->transport))
5193 result = _dbus_transport_get_unix_process_id (connection->transport,
5196 CONNECTION_UNLOCK (connection);
5202 * Gets the ADT audit data of the connection if any.
5203 * Returns #TRUE if the structure pointer is returned.
5204 * Always returns #FALSE prior to authenticating the
5207 * @param connection the connection
5208 * @param data return location for audit data
5209 * @returns #TRUE if audit data is filled in with a valid ucred pointer
5212 dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
5214 dbus_int32_t *data_size)
5218 _dbus_return_val_if_fail (connection != NULL, FALSE);
5219 _dbus_return_val_if_fail (data != NULL, FALSE);
5220 _dbus_return_val_if_fail (data_size != NULL, FALSE);
5222 CONNECTION_LOCK (connection);
5224 if (!_dbus_transport_get_is_authenticated (connection->transport))
5227 result = _dbus_transport_get_adt_audit_session_data (connection->transport,
5230 CONNECTION_UNLOCK (connection);
5236 * Sets a predicate function used to determine whether a given user ID
5237 * is allowed to connect. When an incoming connection has
5238 * authenticated with a particular user ID, this function is called;
5239 * if it returns #TRUE, the connection is allowed to proceed,
5240 * otherwise the connection is disconnected.
5242 * If the function is set to #NULL (as it is by default), then
5243 * only the same UID as the server process will be allowed to
5244 * connect. Also, root is always allowed to connect.
5246 * On Windows, the function will be set and its free_data_function will
5247 * be invoked when the connection is freed or a new function is set.
5248 * However, the function will never be called, because there are
5249 * no UNIX user ids to pass to it, or at least none of the existing
5250 * auth protocols would allow authenticating as a UNIX user on Windows.
5252 * @param connection the connection
5253 * @param function the predicate
5254 * @param data data to pass to the predicate
5255 * @param free_data_function function to free the data
5258 dbus_connection_set_unix_user_function (DBusConnection *connection,
5259 DBusAllowUnixUserFunction function,
5261 DBusFreeFunction free_data_function)
5263 void *old_data = NULL;
5264 DBusFreeFunction old_free_function = NULL;
5266 _dbus_return_if_fail (connection != NULL);
5268 CONNECTION_LOCK (connection);
5269 _dbus_transport_set_unix_user_function (connection->transport,
5270 function, data, free_data_function,
5271 &old_data, &old_free_function);
5272 CONNECTION_UNLOCK (connection);
5274 if (old_free_function != NULL)
5275 (* old_free_function) (old_data);
5279 * Gets the Windows user SID of the connection if known. Returns
5280 * #TRUE if the ID is filled in. Always returns #FALSE on non-Windows
5281 * platforms for now, though in theory someone could hook UNIX to
5282 * Active Directory or something. Always returns #FALSE prior to
5283 * authenticating the connection.
5285 * The user is only read by servers from clients; clients can't usually
5286 * get the user of servers, because servers do not authenticate to
5287 * clients. The returned user is the user the connection authenticated
5290 * The message bus is a server and the apps connecting to the bus
5293 * The returned user string has to be freed with dbus_free().
5295 * The return value indicates whether the user SID is available;
5296 * if it's available but we don't have the memory to copy it,
5297 * then the return value is #TRUE and #NULL is given as the SID.
5299 * @todo We would like to be able to say "You can ask the bus to tell
5300 * you the user of another connection though if you like; this is done
5301 * with dbus_bus_get_windows_user()." But this has to be implemented
5302 * in bus/driver.c and dbus/dbus-bus.c, and is pointless anyway
5303 * since on Windows we only use the session bus for now.
5305 * @param connection the connection
5306 * @param windows_sid_p return location for an allocated copy of the user ID, or #NULL if no memory
5307 * @returns #TRUE if user is available (returned value may be #NULL anyway if no memory)
5310 dbus_connection_get_windows_user (DBusConnection *connection,
5311 char **windows_sid_p)
5315 _dbus_return_val_if_fail (connection != NULL, FALSE);
5316 _dbus_return_val_if_fail (windows_sid_p != NULL, FALSE);
5318 CONNECTION_LOCK (connection);
5320 if (!_dbus_transport_get_is_authenticated (connection->transport))
5323 result = _dbus_transport_get_windows_user (connection->transport,
5327 _dbus_assert (!result);
5330 CONNECTION_UNLOCK (connection);
5336 * Sets a predicate function used to determine whether a given user ID
5337 * is allowed to connect. When an incoming connection has
5338 * authenticated with a particular user ID, this function is called;
5339 * if it returns #TRUE, the connection is allowed to proceed,
5340 * otherwise the connection is disconnected.
5342 * If the function is set to #NULL (as it is by default), then
5343 * only the same user owning the server process will be allowed to
5346 * On UNIX, the function will be set and its free_data_function will
5347 * be invoked when the connection is freed or a new function is set.
5348 * However, the function will never be called, because there is no
5349 * way right now to authenticate as a Windows user on UNIX.
5351 * @param connection the connection
5352 * @param function the predicate
5353 * @param data data to pass to the predicate
5354 * @param free_data_function function to free the data
5357 dbus_connection_set_windows_user_function (DBusConnection *connection,
5358 DBusAllowWindowsUserFunction function,
5360 DBusFreeFunction free_data_function)
5362 void *old_data = NULL;
5363 DBusFreeFunction old_free_function = NULL;
5365 _dbus_return_if_fail (connection != NULL);
5367 CONNECTION_LOCK (connection);
5368 _dbus_transport_set_windows_user_function (connection->transport,
5369 function, data, free_data_function,
5370 &old_data, &old_free_function);
5371 CONNECTION_UNLOCK (connection);
5373 if (old_free_function != NULL)
5374 (* old_free_function) (old_data);
5378 * This function must be called on the server side of a connection when the
5379 * connection is first seen in the #DBusNewConnectionFunction. If set to
5380 * #TRUE (the default is #FALSE), then the connection can proceed even if
5381 * the client does not authenticate as some user identity, i.e. clients
5382 * can connect anonymously.
5384 * This setting interacts with the available authorization mechanisms
5385 * (see dbus_server_set_auth_mechanisms()). Namely, an auth mechanism
5386 * such as ANONYMOUS that supports anonymous auth must be included in
5387 * the list of available mechanisms for anonymous login to work.
5389 * This setting also changes the default rule for connections
5390 * authorized as a user; normally, if a connection authorizes as
5391 * a user identity, it is permitted if the user identity is
5392 * root or the user identity matches the user identity of the server
5393 * process. If anonymous connections are allowed, however,
5394 * then any user identity is allowed.
5396 * You can override the rules for connections authorized as a
5397 * user identity with dbus_connection_set_unix_user_function()
5398 * and dbus_connection_set_windows_user_function().
5400 * @param connection the connection
5401 * @param value whether to allow authentication as an anonymous user
5404 dbus_connection_set_allow_anonymous (DBusConnection *connection,
5407 _dbus_return_if_fail (connection != NULL);
5409 CONNECTION_LOCK (connection);
5410 _dbus_transport_set_allow_anonymous (connection->transport, value);
5411 CONNECTION_UNLOCK (connection);
5416 * Normally #DBusConnection automatically handles all messages to the
5417 * org.freedesktop.DBus.Peer interface. However, the message bus wants
5418 * to be able to route methods on that interface through the bus and
5419 * to other applications. If routing peer messages is enabled, then
5420 * messages with the org.freedesktop.DBus.Peer interface that also
5421 * have a bus destination name set will not be automatically
5422 * handled by the #DBusConnection and instead will be dispatched
5423 * normally to the application.
5425 * If a normal application sets this flag, it can break things badly.
5426 * So don't set this unless you are the message bus.
5428 * @param connection the connection
5429 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
5432 dbus_connection_set_route_peer_messages (DBusConnection *connection,
5435 _dbus_return_if_fail (connection != NULL);
5437 CONNECTION_LOCK (connection);
5438 connection->route_peer_messages = TRUE;
5439 CONNECTION_UNLOCK (connection);
5443 * Adds a message filter. Filters are handlers that are run on all
5444 * incoming messages, prior to the objects registered with
5445 * dbus_connection_register_object_path(). Filters are run in the
5446 * order that they were added. The same handler can be added as a
5447 * filter more than once, in which case it will be run more than once.
5448 * Filters added during a filter callback won't be run on the message
5451 * @todo we don't run filters on messages while blocking without
5452 * entering the main loop, since filters are run as part of
5453 * dbus_connection_dispatch(). This is probably a feature, as filters
5454 * could create arbitrary reentrancy. But kind of sucks if you're
5455 * trying to filter METHOD_RETURN for some reason.
5457 * @param connection the connection
5458 * @param function function to handle messages
5459 * @param user_data user data to pass to the function
5460 * @param free_data_function function to use for freeing user data
5461 * @returns #TRUE on success, #FALSE if not enough memory.
5464 dbus_connection_add_filter (DBusConnection *connection,
5465 DBusHandleMessageFunction function,
5467 DBusFreeFunction free_data_function)
5469 DBusMessageFilter *filter;
5471 _dbus_return_val_if_fail (connection != NULL, FALSE);
5472 _dbus_return_val_if_fail (function != NULL, FALSE);
5474 filter = dbus_new0 (DBusMessageFilter, 1);
5478 _dbus_atomic_inc (&filter->refcount);
5480 CONNECTION_LOCK (connection);
5482 if (!_dbus_list_append (&connection->filter_list,
5485 _dbus_message_filter_unref (filter);
5486 CONNECTION_UNLOCK (connection);
5490 /* Fill in filter after all memory allocated,
5491 * so we don't run the free_user_data_function
5492 * if the add_filter() fails
5495 filter->function = function;
5496 filter->user_data = user_data;
5497 filter->free_user_data_function = free_data_function;
5499 CONNECTION_UNLOCK (connection);
5504 * Removes a previously-added message filter. It is a programming
5505 * error to call this function for a handler that has not been added
5506 * as a filter. If the given handler was added more than once, only
5507 * one instance of it will be removed (the most recently-added
5510 * @param connection the connection
5511 * @param function the handler to remove
5512 * @param user_data user data for the handler to remove
5516 dbus_connection_remove_filter (DBusConnection *connection,
5517 DBusHandleMessageFunction function,
5521 DBusMessageFilter *filter;
5523 _dbus_return_if_fail (connection != NULL);
5524 _dbus_return_if_fail (function != NULL);
5526 CONNECTION_LOCK (connection);
5530 link = _dbus_list_get_last_link (&connection->filter_list);
5531 while (link != NULL)
5533 filter = link->data;
5535 if (filter->function == function &&
5536 filter->user_data == user_data)
5538 _dbus_list_remove_link (&connection->filter_list, link);
5539 filter->function = NULL;
5544 link = _dbus_list_get_prev_link (&connection->filter_list, link);
5548 CONNECTION_UNLOCK (connection);
5550 #ifndef DBUS_DISABLE_CHECKS
5553 _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5554 function, user_data);
5559 /* Call application code */
5560 if (filter->free_user_data_function)
5561 (* filter->free_user_data_function) (filter->user_data);
5563 filter->free_user_data_function = NULL;
5564 filter->user_data = NULL;
5566 _dbus_message_filter_unref (filter);
5570 * Registers a handler for a given path or subsection in the object
5571 * hierarchy. The given vtable handles messages sent to exactly the
5572 * given path or also for paths bellow that, depending on fallback
5575 * @param connection the connection
5576 * @param fallback whether to handle messages also for "subdirectory"
5577 * @param path a '/' delimited string of path elements
5578 * @param vtable the virtual table
5579 * @param user_data data to pass to functions in the vtable
5580 * @param error address where an error can be returned
5581 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5582 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5585 _dbus_connection_register_object_path (DBusConnection *connection,
5586 dbus_bool_t fallback,
5588 const DBusObjectPathVTable *vtable,
5592 char **decomposed_path;
5595 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5598 CONNECTION_LOCK (connection);
5600 retval = _dbus_object_tree_register (connection->objects,
5602 (const char **) decomposed_path, vtable,
5605 CONNECTION_UNLOCK (connection);
5607 dbus_free_string_array (decomposed_path);
5613 * Registers a handler for a given path in the object hierarchy.
5614 * The given vtable handles messages sent to exactly the given path.
5616 * @param connection the connection
5617 * @param path a '/' delimited string of path elements
5618 * @param vtable the virtual table
5619 * @param user_data data to pass to functions in the vtable
5620 * @param error address where an error can be returned
5621 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5622 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5625 dbus_connection_try_register_object_path (DBusConnection *connection,
5627 const DBusObjectPathVTable *vtable,
5631 _dbus_return_val_if_fail (connection != NULL, FALSE);
5632 _dbus_return_val_if_fail (path != NULL, FALSE);
5633 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5634 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5636 return _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, error);
5640 * Registers a handler for a given path in the object hierarchy.
5641 * The given vtable handles messages sent to exactly the given path.
5643 * It is a bug to call this function for object paths which already
5644 * have a handler. Use dbus_connection_try_register_object_path() if this
5645 * might be the case.
5647 * @param connection the connection
5648 * @param path a '/' delimited string of path elements
5649 * @param vtable the virtual table
5650 * @param user_data data to pass to functions in the vtable
5651 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5652 * #DBUS_ERROR_OBJECT_PATH_IN_USE) ocurred
5655 dbus_connection_register_object_path (DBusConnection *connection,
5657 const DBusObjectPathVTable *vtable,
5661 DBusError error = DBUS_ERROR_INIT;
5663 _dbus_return_val_if_fail (connection != NULL, FALSE);
5664 _dbus_return_val_if_fail (path != NULL, FALSE);
5665 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5666 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5668 retval = _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, &error);
5670 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5672 _dbus_warn ("%s\n", error.message);
5673 dbus_error_free (&error);
5681 * Registers a fallback handler for a given subsection of the object
5682 * hierarchy. The given vtable handles messages at or below the given
5683 * path. You can use this to establish a default message handling
5684 * policy for a whole "subdirectory."
5686 * @param connection the connection
5687 * @param path a '/' delimited string of path elements
5688 * @param vtable the virtual table
5689 * @param user_data data to pass to functions in the vtable
5690 * @param error address where an error can be returned
5691 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5692 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5695 dbus_connection_try_register_fallback (DBusConnection *connection,
5697 const DBusObjectPathVTable *vtable,
5701 _dbus_return_val_if_fail (connection != NULL, FALSE);
5702 _dbus_return_val_if_fail (path != NULL, FALSE);
5703 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5704 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5706 return _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, error);
5710 * Registers a fallback handler for a given subsection of the object
5711 * hierarchy. The given vtable handles messages at or below the given
5712 * path. You can use this to establish a default message handling
5713 * policy for a whole "subdirectory."
5715 * It is a bug to call this function for object paths which already
5716 * have a handler. Use dbus_connection_try_register_fallback() if this
5717 * might be the case.
5719 * @param connection the connection
5720 * @param path a '/' delimited string of path elements
5721 * @param vtable the virtual table
5722 * @param user_data data to pass to functions in the vtable
5723 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5724 * #DBUS_ERROR_OBJECT_PATH_IN_USE) occured
5727 dbus_connection_register_fallback (DBusConnection *connection,
5729 const DBusObjectPathVTable *vtable,
5733 DBusError error = DBUS_ERROR_INIT;
5735 _dbus_return_val_if_fail (connection != NULL, FALSE);
5736 _dbus_return_val_if_fail (path != NULL, FALSE);
5737 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5738 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5740 retval = _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, &error);
5742 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5744 _dbus_warn ("%s\n", error.message);
5745 dbus_error_free (&error);
5753 * Unregisters the handler registered with exactly the given path.
5754 * It's a bug to call this function for a path that isn't registered.
5755 * Can unregister both fallback paths and object paths.
5757 * @param connection the connection
5758 * @param path a '/' delimited string of path elements
5759 * @returns #FALSE if not enough memory
5762 dbus_connection_unregister_object_path (DBusConnection *connection,
5765 char **decomposed_path;
5767 _dbus_return_val_if_fail (connection != NULL, FALSE);
5768 _dbus_return_val_if_fail (path != NULL, FALSE);
5769 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5771 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5774 CONNECTION_LOCK (connection);
5776 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5778 dbus_free_string_array (decomposed_path);
5784 * Gets the user data passed to dbus_connection_register_object_path()
5785 * or dbus_connection_register_fallback(). If nothing was registered
5786 * at this path, the data is filled in with #NULL.
5788 * @param connection the connection
5789 * @param path the path you registered with
5790 * @param data_p location to store the user data, or #NULL
5791 * @returns #FALSE if not enough memory
5794 dbus_connection_get_object_path_data (DBusConnection *connection,
5798 char **decomposed_path;
5800 _dbus_return_val_if_fail (connection != NULL, FALSE);
5801 _dbus_return_val_if_fail (path != NULL, FALSE);
5802 _dbus_return_val_if_fail (data_p != NULL, FALSE);
5806 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5809 CONNECTION_LOCK (connection);
5811 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5813 CONNECTION_UNLOCK (connection);
5815 dbus_free_string_array (decomposed_path);
5821 * Lists the registered fallback handlers and object path handlers at
5822 * the given parent_path. The returned array should be freed with
5823 * dbus_free_string_array().
5825 * @param connection the connection
5826 * @param parent_path the path to list the child handlers of
5827 * @param child_entries returns #NULL-terminated array of children
5828 * @returns #FALSE if no memory to allocate the child entries
5831 dbus_connection_list_registered (DBusConnection *connection,
5832 const char *parent_path,
5833 char ***child_entries)
5835 char **decomposed_path;
5837 _dbus_return_val_if_fail (connection != NULL, FALSE);
5838 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5839 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5840 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5842 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5845 CONNECTION_LOCK (connection);
5847 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5848 (const char **) decomposed_path,
5850 dbus_free_string_array (decomposed_path);
5855 static DBusDataSlotAllocator slot_allocator;
5856 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
5859 * Allocates an integer ID to be used for storing application-specific
5860 * data on any DBusConnection. The allocated ID may then be used
5861 * with dbus_connection_set_data() and dbus_connection_get_data().
5862 * The passed-in slot must be initialized to -1, and is filled in
5863 * with the slot ID. If the passed-in slot is not -1, it's assumed
5864 * to be already allocated, and its refcount is incremented.
5866 * The allocated slot is global, i.e. all DBusConnection objects will
5867 * have a slot with the given integer ID reserved.
5869 * @param slot_p address of a global variable storing the slot
5870 * @returns #FALSE on failure (no memory)
5873 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5875 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5876 &_DBUS_LOCK_NAME (connection_slots),
5881 * Deallocates a global ID for connection data slots.
5882 * dbus_connection_get_data() and dbus_connection_set_data() may no
5883 * longer be used with this slot. Existing data stored on existing
5884 * DBusConnection objects will be freed when the connection is
5885 * finalized, but may not be retrieved (and may only be replaced if
5886 * someone else reallocates the slot). When the refcount on the
5887 * passed-in slot reaches 0, it is set to -1.
5889 * @param slot_p address storing the slot to deallocate
5892 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5894 _dbus_return_if_fail (*slot_p >= 0);
5896 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5900 * Stores a pointer on a DBusConnection, along
5901 * with an optional function to be used for freeing
5902 * the data when the data is set again, or when
5903 * the connection is finalized. The slot number
5904 * must have been allocated with dbus_connection_allocate_data_slot().
5906 * @note This function does not take the
5907 * main thread lock on DBusConnection, which allows it to be
5908 * used from inside watch and timeout functions. (See the
5909 * note in docs for dbus_connection_set_watch_functions().)
5910 * A side effect of this is that you need to know there's
5911 * a reference held on the connection while invoking
5912 * dbus_connection_set_data(), or the connection could be
5913 * finalized during dbus_connection_set_data().
5915 * @param connection the connection
5916 * @param slot the slot number
5917 * @param data the data to store
5918 * @param free_data_func finalizer function for the data
5919 * @returns #TRUE if there was enough memory to store the data
5922 dbus_connection_set_data (DBusConnection *connection,
5925 DBusFreeFunction free_data_func)
5927 DBusFreeFunction old_free_func;
5931 _dbus_return_val_if_fail (connection != NULL, FALSE);
5932 _dbus_return_val_if_fail (slot >= 0, FALSE);
5934 SLOTS_LOCK (connection);
5936 retval = _dbus_data_slot_list_set (&slot_allocator,
5937 &connection->slot_list,
5938 slot, data, free_data_func,
5939 &old_free_func, &old_data);
5941 SLOTS_UNLOCK (connection);
5945 /* Do the actual free outside the connection lock */
5947 (* old_free_func) (old_data);
5954 * Retrieves data previously set with dbus_connection_set_data().
5955 * The slot must still be allocated (must not have been freed).
5957 * @note This function does not take the
5958 * main thread lock on DBusConnection, which allows it to be
5959 * used from inside watch and timeout functions. (See the
5960 * note in docs for dbus_connection_set_watch_functions().)
5961 * A side effect of this is that you need to know there's
5962 * a reference held on the connection while invoking
5963 * dbus_connection_get_data(), or the connection could be
5964 * finalized during dbus_connection_get_data().
5966 * @param connection the connection
5967 * @param slot the slot to get data from
5968 * @returns the data, or #NULL if not found
5971 dbus_connection_get_data (DBusConnection *connection,
5976 _dbus_return_val_if_fail (connection != NULL, NULL);
5978 SLOTS_LOCK (connection);
5980 res = _dbus_data_slot_list_get (&slot_allocator,
5981 &connection->slot_list,
5984 SLOTS_UNLOCK (connection);
5990 * This function sets a global flag for whether dbus_connection_new()
5991 * will set SIGPIPE behavior to SIG_IGN.
5993 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
5996 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
5998 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
6002 * Specifies the maximum size message this connection is allowed to
6003 * receive. Larger messages will result in disconnecting the
6006 * @param connection a #DBusConnection
6007 * @param size maximum message size the connection can receive, in bytes
6010 dbus_connection_set_max_message_size (DBusConnection *connection,
6013 _dbus_return_if_fail (connection != NULL);
6015 CONNECTION_LOCK (connection);
6016 _dbus_transport_set_max_message_size (connection->transport,
6018 CONNECTION_UNLOCK (connection);
6022 * Gets the value set by dbus_connection_set_max_message_size().
6024 * @param connection the connection
6025 * @returns the max size of a single message
6028 dbus_connection_get_max_message_size (DBusConnection *connection)
6032 _dbus_return_val_if_fail (connection != NULL, 0);
6034 CONNECTION_LOCK (connection);
6035 res = _dbus_transport_get_max_message_size (connection->transport);
6036 CONNECTION_UNLOCK (connection);
6041 * Specifies the maximum number of unix fds a message on this
6042 * connection is allowed to receive. Messages with more unix fds will
6043 * result in disconnecting the connection.
6045 * @param connection a #DBusConnection
6046 * @param size maximum message unix fds the connection can receive
6049 dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
6052 _dbus_return_if_fail (connection != NULL);
6054 CONNECTION_LOCK (connection);
6055 _dbus_transport_set_max_message_unix_fds (connection->transport,
6057 CONNECTION_UNLOCK (connection);
6061 * Gets the value set by dbus_connection_set_max_message_unix_fds().
6063 * @param connection the connection
6064 * @returns the max numer of unix fds of a single message
6067 dbus_connection_get_max_message_unix_fds (DBusConnection *connection)
6071 _dbus_return_val_if_fail (connection != NULL, 0);
6073 CONNECTION_LOCK (connection);
6074 res = _dbus_transport_get_max_message_unix_fds (connection->transport);
6075 CONNECTION_UNLOCK (connection);
6080 * Sets the maximum total number of bytes that can be used for all messages
6081 * received on this connection. Messages count toward the maximum until
6082 * they are finalized. When the maximum is reached, the connection will
6083 * not read more data until some messages are finalized.
6085 * The semantics of the maximum are: if outstanding messages are
6086 * already above the maximum, additional messages will not be read.
6087 * The semantics are not: if the next message would cause us to exceed
6088 * the maximum, we don't read it. The reason is that we don't know the
6089 * size of a message until after we read it.
6091 * Thus, the max live messages size can actually be exceeded
6092 * by up to the maximum size of a single message.
6094 * Also, if we read say 1024 bytes off the wire in a single read(),
6095 * and that contains a half-dozen small messages, we may exceed the
6096 * size max by that amount. But this should be inconsequential.
6098 * This does imply that we can't call read() with a buffer larger
6099 * than we're willing to exceed this limit by.
6101 * @param connection the connection
6102 * @param size the maximum size in bytes of all outstanding messages
6105 dbus_connection_set_max_received_size (DBusConnection *connection,
6108 _dbus_return_if_fail (connection != NULL);
6110 CONNECTION_LOCK (connection);
6111 _dbus_transport_set_max_received_size (connection->transport,
6113 CONNECTION_UNLOCK (connection);
6117 * Gets the value set by dbus_connection_set_max_received_size().
6119 * @param connection the connection
6120 * @returns the max size of all live messages
6123 dbus_connection_get_max_received_size (DBusConnection *connection)
6127 _dbus_return_val_if_fail (connection != NULL, 0);
6129 CONNECTION_LOCK (connection);
6130 res = _dbus_transport_get_max_received_size (connection->transport);
6131 CONNECTION_UNLOCK (connection);
6136 * Sets the maximum total number of unix fds that can be used for all messages
6137 * received on this connection. Messages count toward the maximum until
6138 * they are finalized. When the maximum is reached, the connection will
6139 * not read more data until some messages are finalized.
6141 * The semantics are analogous to those of dbus_connection_set_max_received_size().
6143 * @param connection the connection
6144 * @param size the maximum size in bytes of all outstanding messages
6147 dbus_connection_set_max_received_unix_fds (DBusConnection *connection,
6150 _dbus_return_if_fail (connection != NULL);
6152 CONNECTION_LOCK (connection);
6153 _dbus_transport_set_max_received_unix_fds (connection->transport,
6155 CONNECTION_UNLOCK (connection);
6159 * Gets the value set by dbus_connection_set_max_received_unix_fds().
6161 * @param connection the connection
6162 * @returns the max unix fds of all live messages
6165 dbus_connection_get_max_received_unix_fds (DBusConnection *connection)
6169 _dbus_return_val_if_fail (connection != NULL, 0);
6171 CONNECTION_LOCK (connection);
6172 res = _dbus_transport_get_max_received_unix_fds (connection->transport);
6173 CONNECTION_UNLOCK (connection);
6178 * Gets the approximate size in bytes of all messages in the outgoing
6179 * message queue. The size is approximate in that you shouldn't use
6180 * it to decide how many bytes to read off the network or anything
6181 * of that nature, as optimizations may choose to tell small white lies
6182 * to avoid performance overhead.
6184 * @param connection the connection
6185 * @returns the number of bytes that have been queued up but not sent
6188 dbus_connection_get_outgoing_size (DBusConnection *connection)
6192 _dbus_return_val_if_fail (connection != NULL, 0);
6194 CONNECTION_LOCK (connection);
6195 res = _dbus_counter_get_size_value (connection->outgoing_counter);
6196 CONNECTION_UNLOCK (connection);
6200 #ifdef DBUS_ENABLE_STATS
6202 _dbus_connection_get_stats (DBusConnection *connection,
6203 dbus_uint32_t *in_messages,
6204 dbus_uint32_t *in_bytes,
6205 dbus_uint32_t *in_fds,
6206 dbus_uint32_t *in_peak_bytes,
6207 dbus_uint32_t *in_peak_fds,
6208 dbus_uint32_t *out_messages,
6209 dbus_uint32_t *out_bytes,
6210 dbus_uint32_t *out_fds,
6211 dbus_uint32_t *out_peak_bytes,
6212 dbus_uint32_t *out_peak_fds,
6213 dbus_uint32_t *link_cache_size)
6215 CONNECTION_LOCK (connection);
6217 if (in_messages != NULL)
6218 *in_messages = connection->n_incoming;
6220 _dbus_transport_get_stats (connection->transport,
6221 in_bytes, in_fds, in_peak_bytes, in_peak_fds);
6223 if (out_messages != NULL)
6224 *out_messages = connection->n_outgoing;
6226 if (out_bytes != NULL)
6227 *out_bytes = _dbus_counter_get_size_value (connection->outgoing_counter);
6229 if (out_fds != NULL)
6230 *out_fds = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6232 if (out_peak_bytes != NULL)
6233 *out_peak_bytes = _dbus_counter_get_peak_size_value (connection->outgoing_counter);
6235 if (out_peak_fds != NULL)
6236 *out_peak_fds = _dbus_counter_get_peak_unix_fd_value (connection->outgoing_counter);
6238 if (link_cache_size != NULL)
6240 *link_cache_size = _dbus_list_get_length (&connection->link_cache) * sizeof (DBusList);
6243 CONNECTION_UNLOCK (connection);
6245 #endif /* DBUS_ENABLE_STATS */
6248 * Gets the approximate number of uni fds of all messages in the
6249 * outgoing message queue.
6251 * @param connection the connection
6252 * @returns the number of unix fds that have been queued up but not sent
6255 dbus_connection_get_outgoing_unix_fds (DBusConnection *connection)
6259 _dbus_return_val_if_fail (connection != NULL, 0);
6261 CONNECTION_LOCK (connection);
6262 res = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6263 CONNECTION_UNLOCK (connection);