1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-connection.c DBusConnection object
4 * Copyright (C) 2002-2006 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-shared.h"
26 #include "dbus-connection.h"
27 #include "dbus-list.h"
28 #include "dbus-timeout.h"
29 #include "dbus-transport.h"
30 #include "dbus-watch.h"
31 #include "dbus-connection-internal.h"
32 #include "dbus-pending-call-internal.h"
33 #include "dbus-list.h"
34 #include "dbus-hash.h"
35 #include "dbus-message-internal.h"
36 #include "dbus-message-private.h"
37 #include "dbus-threads.h"
38 #include "dbus-protocol.h"
39 #include "dbus-dataslot.h"
40 #include "dbus-string.h"
41 #include "dbus-signature.h"
42 #include "dbus-pending-call.h"
43 #include "dbus-object-tree.h"
44 #include "dbus-threads-internal.h"
46 #include "dbus-marshal-basic.h"
47 #include "dbus-transport-kdbus.h"
49 #ifdef DBUS_DISABLE_CHECKS
50 #define TOOK_LOCK_CHECK(connection)
51 #define RELEASING_LOCK_CHECK(connection)
52 #define HAVE_LOCK_CHECK(connection)
54 #define TOOK_LOCK_CHECK(connection) do { \
55 _dbus_assert (!(connection)->have_connection_lock); \
56 (connection)->have_connection_lock = TRUE; \
58 #define RELEASING_LOCK_CHECK(connection) do { \
59 _dbus_assert ((connection)->have_connection_lock); \
60 (connection)->have_connection_lock = FALSE; \
62 #define HAVE_LOCK_CHECK(connection) _dbus_assert ((connection)->have_connection_lock)
63 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
68 #define CONNECTION_LOCK(connection) do { \
69 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
70 _dbus_rmutex_lock ((connection)->mutex); \
71 TOOK_LOCK_CHECK (connection); \
74 #define CONNECTION_UNLOCK(connection) _dbus_connection_unlock (connection)
76 #define SLOTS_LOCK(connection) do { \
77 _dbus_rmutex_lock ((connection)->slot_mutex); \
80 #define SLOTS_UNLOCK(connection) do { \
81 _dbus_rmutex_unlock ((connection)->slot_mutex); \
84 #define DISPATCH_STATUS_NAME(s) \
85 ((s) == DBUS_DISPATCH_COMPLETE ? "complete" : \
86 (s) == DBUS_DISPATCH_DATA_REMAINS ? "data remains" : \
87 (s) == DBUS_DISPATCH_NEED_MEMORY ? "need memory" : \
91 * @defgroup DBusConnection DBusConnection
93 * @brief Connection to another application
95 * A DBusConnection represents a connection to another
96 * application. Messages can be sent and received via this connection.
97 * The other application may be a message bus; for convenience, the
98 * function dbus_bus_get() is provided to automatically open a
99 * connection to the well-known message buses.
101 * In brief a DBusConnection is a message queue associated with some
102 * message transport mechanism such as a socket. The connection
103 * maintains a queue of incoming messages and a queue of outgoing
106 * Several functions use the following terms:
108 * <li><b>read</b> means to fill the incoming message queue by reading from the socket</li>
109 * <li><b>write</b> means to drain the outgoing queue by writing to the socket</li>
110 * <li><b>dispatch</b> means to drain the incoming queue by invoking application-provided message handlers</li>
113 * The function dbus_connection_read_write_dispatch() for example does all
114 * three of these things, offering a simple alternative to a main loop.
116 * In an application with a main loop, the read/write/dispatch
117 * operations are usually separate.
119 * The connection provides #DBusWatch and #DBusTimeout objects to
120 * the main loop. These are used to know when reading, writing, or
121 * dispatching should be performed.
123 * Incoming messages are processed
124 * by calling dbus_connection_dispatch(). dbus_connection_dispatch()
125 * runs any handlers registered for the topmost message in the message
126 * queue, then discards the message, then returns.
128 * dbus_connection_get_dispatch_status() indicates whether
129 * messages are currently in the queue that need dispatching.
130 * dbus_connection_set_dispatch_status_function() allows
131 * you to set a function to be used to monitor the dispatch status.
133 * If you're using GLib or Qt add-on libraries for D-Bus, there are
134 * special convenience APIs in those libraries that hide
135 * all the details of dispatch and watch/timeout monitoring.
136 * For example, dbus_connection_setup_with_g_main().
138 * If you aren't using these add-on libraries, but want to process
139 * messages asynchronously, you must manually call
140 * dbus_connection_set_dispatch_status_function(),
141 * dbus_connection_set_watch_functions(),
142 * dbus_connection_set_timeout_functions() providing appropriate
143 * functions to integrate the connection with your application's main
144 * loop. This can be tricky to get right; main loops are not simple.
146 * If you don't need to be asynchronous, you can ignore #DBusWatch,
147 * #DBusTimeout, and dbus_connection_dispatch(). Instead,
148 * dbus_connection_read_write_dispatch() can be used.
150 * Or, in <em>very</em> simple applications,
151 * dbus_connection_pop_message() may be all you need, allowing you to
152 * avoid setting up any handler functions (see
153 * dbus_connection_add_filter(),
154 * dbus_connection_register_object_path() for more on handlers).
156 * When you use dbus_connection_send() or one of its variants to send
157 * a message, the message is added to the outgoing queue. It's
158 * actually written to the network later; either in
159 * dbus_watch_handle() invoked by your main loop, or in
160 * dbus_connection_flush() which blocks until it can write out the
161 * entire outgoing queue. The GLib/Qt add-on libraries again
162 * handle the details here for you by setting up watch functions.
164 * When a connection is disconnected, you are guaranteed to get a
165 * signal "Disconnected" from the interface
166 * #DBUS_INTERFACE_LOCAL, path
169 * You may not drop the last reference to a #DBusConnection
170 * until that connection has been disconnected.
172 * You may dispatch the unprocessed incoming message queue even if the
173 * connection is disconnected. However, "Disconnected" will always be
174 * the last message in the queue (obviously no messages are received
175 * after disconnection).
177 * After calling dbus_threads_init(), #DBusConnection has thread
178 * locks and drops them when invoking user callbacks, so in general is
179 * transparently threadsafe. However, #DBusMessage does NOT have
180 * thread locks; you must not send the same message to multiple
181 * #DBusConnection if those connections will be used from different threads,
184 * Also, if you dispatch or pop messages from multiple threads, it
185 * may work in the sense that it won't crash, but it's tough to imagine
186 * sane results; it will be completely unpredictable which messages
187 * go to which threads.
189 * It's recommended to dispatch from a single thread.
191 * The most useful function to call from multiple threads at once
192 * is dbus_connection_send_with_reply_and_block(). That is,
193 * multiple threads can make method calls at the same time.
195 * If you aren't using threads, you can use a main loop and
196 * dbus_pending_call_set_notify() to achieve a similar result.
200 * @defgroup DBusConnectionInternals DBusConnection implementation details
201 * @ingroup DBusInternals
202 * @brief Implementation details of DBusConnection
207 #ifdef DBUS_ENABLE_VERBOSE_MODE
209 _dbus_connection_trace_ref (DBusConnection *connection,
214 static int enabled = -1;
216 _dbus_trace_ref ("DBusConnection", connection, old_refcount, new_refcount,
217 why, "DBUS_CONNECTION_TRACE", &enabled);
220 #define _dbus_connection_trace_ref(c,o,n,w) \
229 * Internal struct representing a message filter function
231 typedef struct DBusMessageFilter DBusMessageFilter;
234 * Internal struct representing a message filter function
236 struct DBusMessageFilter
238 DBusAtomic refcount; /**< Reference count */
239 DBusHandleMessageFunction function; /**< Function to call to filter */
240 void *user_data; /**< User data for the function */
241 DBusFreeFunction free_user_data_function; /**< Function to free the user data */
246 * Internals of DBusPreallocatedSend
248 struct DBusPreallocatedSend
250 DBusConnection *connection; /**< Connection we'd send the message to */
251 DBusList *queue_link; /**< Preallocated link in the queue */
252 DBusList *counter_link; /**< Preallocated link in the resource counter */
255 #if HAVE_DECL_MSG_NOSIGNAL
256 static dbus_bool_t _dbus_modify_sigpipe = FALSE;
258 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
262 * Implementation details of DBusConnection. All fields are private.
264 struct DBusConnection
266 DBusAtomic refcount; /**< Reference count. */
268 DBusRMutex *mutex; /**< Lock on the entire DBusConnection */
270 DBusCMutex *dispatch_mutex; /**< Protects dispatch_acquired */
271 DBusCondVar *dispatch_cond; /**< Notify when dispatch_acquired is available */
272 DBusCMutex *io_path_mutex; /**< Protects io_path_acquired */
273 DBusCondVar *io_path_cond; /**< Notify when io_path_acquired is available */
275 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
276 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
277 DBusList *expired_messages; /**< Messages that will be released when we next unlock. */
279 DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
280 * dispatch_acquired will be set by the borrower
283 int n_outgoing; /**< Length of outgoing queue. */
284 int n_incoming; /**< Length of incoming queue. */
286 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
288 DBusTransport *transport; /**< Object that sends/receives messages over network. */
289 DBusWatchList *watches; /**< Stores active watches. */
290 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
292 DBusList *filter_list; /**< List of filters. */
294 DBusRMutex *slot_mutex; /**< Lock on slot_list so overall connection lock need not be taken */
295 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
297 DBusHashTable *pending_replies; /**< Hash of message serials to #DBusPendingCall. */
299 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
300 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
302 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
303 void *wakeup_main_data; /**< Application data for wakeup_main_function */
304 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
306 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
307 void *dispatch_status_data; /**< Application data for dispatch_status_function */
308 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
310 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
312 DBusObjectTree *objects; /**< Object path handlers registered with this connection */
314 char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
316 /* These two MUST be bools and not bitfields, because they are protected by a separate lock
317 * from connection->mutex and all bitfields in a word have to be read/written together.
318 * So you can't have a different lock for different bitfields in the same word.
320 dbus_bool_t dispatch_acquired; /**< Someone has dispatch path (can drain incoming queue) */
321 dbus_bool_t io_path_acquired; /**< Someone has transport io path (can use the transport to read/write messages) */
323 unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
325 unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
327 unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
329 unsigned int disconnected_message_arrived : 1; /**< We popped or are dispatching the disconnected message.
330 * if the disconnect_message_link is NULL then we queued it, but
331 * this flag is whether it got to the head of the queue.
333 unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
334 * such as closing the connection.
337 #ifndef DBUS_DISABLE_CHECKS
338 unsigned int have_connection_lock : 1; /**< Used to check locking */
341 #ifndef DBUS_DISABLE_CHECKS
342 int generation; /**< _dbus_current_generation that should correspond to this connection */
346 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
347 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
348 DBusDispatchStatus new_status);
349 static void _dbus_connection_last_unref (DBusConnection *connection);
350 static void _dbus_connection_acquire_dispatch (DBusConnection *connection);
351 static void _dbus_connection_release_dispatch (DBusConnection *connection);
352 static DBusDispatchStatus _dbus_connection_flush_unlocked (DBusConnection *connection);
353 static void _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection);
354 static dbus_bool_t _dbus_connection_get_is_connected_unlocked (DBusConnection *connection);
355 static dbus_bool_t _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
356 dbus_uint32_t client_serial);
358 static DBusMessageFilter *
359 _dbus_message_filter_ref (DBusMessageFilter *filter)
361 #ifdef DBUS_DISABLE_ASSERT
362 _dbus_atomic_inc (&filter->refcount);
364 dbus_int32_t old_value;
366 old_value = _dbus_atomic_inc (&filter->refcount);
367 _dbus_assert (old_value > 0);
374 _dbus_message_filter_unref (DBusMessageFilter *filter)
376 dbus_int32_t old_value;
378 old_value = _dbus_atomic_dec (&filter->refcount);
379 _dbus_assert (old_value > 0);
383 if (filter->free_user_data_function)
384 (* filter->free_user_data_function) (filter->user_data);
391 * Acquires the connection lock.
393 * @param connection the connection.
396 _dbus_connection_lock (DBusConnection *connection)
398 CONNECTION_LOCK (connection);
402 * Releases the connection lock.
404 * @param connection the connection.
407 _dbus_connection_unlock (DBusConnection *connection)
409 DBusList *expired_messages;
414 _dbus_verbose ("UNLOCK\n");
417 /* If we had messages that expired (fell off the incoming or outgoing
418 * queues) while we were locked, actually release them now */
419 expired_messages = connection->expired_messages;
420 connection->expired_messages = NULL;
422 RELEASING_LOCK_CHECK (connection);
423 _dbus_rmutex_unlock (connection->mutex);
425 for (iter = _dbus_list_pop_first_link (&expired_messages);
427 iter = _dbus_list_pop_first_link (&expired_messages))
429 DBusMessage *message = iter->data;
431 dbus_message_unref (message);
432 _dbus_list_free_link (iter);
437 * Wakes up the main loop if it is sleeping
438 * Needed if we're e.g. queueing outgoing messages
439 * on a thread while the mainloop sleeps.
441 * @param connection the connection.
444 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
446 if (connection->wakeup_main_function)
447 (*connection->wakeup_main_function) (connection->wakeup_main_data);
450 #ifdef DBUS_BUILD_TESTS
452 * Gets the locks so we can examine them
454 * @param connection the connection.
455 * @param mutex_loc return for the location of the main mutex pointer
456 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
457 * @param io_path_mutex_loc return location of the io_path mutex pointer
458 * @param dispatch_cond_loc return location of the dispatch conditional
460 * @param io_path_cond_loc return location of the io_path conditional
464 _dbus_connection_test_get_locks (DBusConnection *connection,
465 DBusMutex **mutex_loc,
466 DBusMutex **dispatch_mutex_loc,
467 DBusMutex **io_path_mutex_loc,
468 DBusCondVar **dispatch_cond_loc,
469 DBusCondVar **io_path_cond_loc)
471 *mutex_loc = (DBusMutex *) connection->mutex;
472 *dispatch_mutex_loc = (DBusMutex *) connection->dispatch_mutex;
473 *io_path_mutex_loc = (DBusMutex *) connection->io_path_mutex;
474 *dispatch_cond_loc = connection->dispatch_cond;
475 *io_path_cond_loc = connection->io_path_cond;
480 * Adds a message-containing list link to the incoming message queue,
481 * taking ownership of the link and the message's current refcount.
482 * Cannot fail due to lack of memory.
484 * @param connection the connection.
485 * @param link the message link to queue.
488 _dbus_connection_queue_received_message_link (DBusConnection *connection,
491 DBusPendingCall *pending;
492 dbus_uint32_t reply_serial;
493 DBusMessage *message;
495 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
497 _dbus_list_append_link (&connection->incoming_messages,
499 message = link->data;
501 /* If this is a reply we're waiting on, remove timeout for it */
502 reply_serial = dbus_message_get_reply_serial (message);
503 if (reply_serial != 0)
505 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
509 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
510 _dbus_connection_remove_timeout_unlocked (connection,
511 _dbus_pending_call_get_timeout_unlocked (pending));
513 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
519 connection->n_incoming += 1;
521 _dbus_connection_wakeup_mainloop (connection);
523 _dbus_verbose ("Message %p (%s %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
525 dbus_message_type_to_string (dbus_message_get_type (message)),
526 dbus_message_get_path (message) ?
527 dbus_message_get_path (message) :
529 dbus_message_get_interface (message) ?
530 dbus_message_get_interface (message) :
532 dbus_message_get_member (message) ?
533 dbus_message_get_member (message) :
535 dbus_message_get_signature (message),
536 dbus_message_get_reply_serial (message),
538 connection->n_incoming);
540 _dbus_message_trace_ref (message, -1, -1,
541 "_dbus_conection_queue_received_message_link");
545 * Adds a link + message to the incoming message queue.
546 * Can't fail. Takes ownership of both link and message.
548 * @param connection the connection.
549 * @param link the list node and message to queue.
553 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
556 HAVE_LOCK_CHECK (connection);
558 _dbus_list_append_link (&connection->incoming_messages, link);
560 connection->n_incoming += 1;
562 _dbus_connection_wakeup_mainloop (connection);
564 _dbus_message_trace_ref (link->data, -1, -1,
565 "_dbus_connection_queue_synthesized_message_link");
567 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
568 link->data, connection, connection->n_incoming);
573 * Checks whether there are messages in the outgoing message queue.
574 * Called with connection lock held.
576 * @param connection the connection.
577 * @returns #TRUE if the outgoing queue is non-empty.
580 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
582 HAVE_LOCK_CHECK (connection);
583 return connection->outgoing_messages != NULL;
587 * Checks whether there are messages in the outgoing message queue.
588 * Use dbus_connection_flush() to block until all outgoing
589 * messages have been written to the underlying transport
590 * (such as a socket).
592 * @param connection the connection.
593 * @returns #TRUE if the outgoing queue is non-empty.
596 dbus_connection_has_messages_to_send (DBusConnection *connection)
600 _dbus_return_val_if_fail (connection != NULL, FALSE);
602 CONNECTION_LOCK (connection);
603 v = _dbus_connection_has_messages_to_send_unlocked (connection);
604 CONNECTION_UNLOCK (connection);
610 * Gets the next outgoing message. The message remains in the
611 * queue, and the caller does not own a reference to it.
613 * @param connection the connection.
614 * @returns the message to be sent.
617 _dbus_connection_get_message_to_send (DBusConnection *connection)
619 HAVE_LOCK_CHECK (connection);
621 return _dbus_list_get_last (&connection->outgoing_messages);
625 * Notifies the connection that a message has been sent, so the
626 * message can be removed from the outgoing queue.
627 * Called with the connection lock held.
629 * @param connection the connection.
630 * @param message the message that was sent.
633 _dbus_connection_message_sent_unlocked (DBusConnection *connection,
634 DBusMessage *message)
638 HAVE_LOCK_CHECK (connection);
640 /* This can be called before we even complete authentication, since
641 * it's called on disconnect to clean up the outgoing queue.
642 * It's also called as we successfully send each message.
645 link = _dbus_list_get_last_link (&connection->outgoing_messages);
646 _dbus_assert (link != NULL);
647 _dbus_assert (link->data == message);
649 _dbus_list_unlink (&connection->outgoing_messages,
651 _dbus_list_prepend_link (&connection->expired_messages, link);
653 connection->n_outgoing -= 1;
655 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
657 dbus_message_type_to_string (dbus_message_get_type (message)),
658 dbus_message_get_path (message) ?
659 dbus_message_get_path (message) :
661 dbus_message_get_interface (message) ?
662 dbus_message_get_interface (message) :
664 dbus_message_get_member (message) ?
665 dbus_message_get_member (message) :
667 dbus_message_get_signature (message),
668 connection, connection->n_outgoing);
670 /* It's OK that in principle we call the notify function, because for the
671 * outgoing limit, there isn't one */
672 _dbus_message_remove_counter (message, connection->outgoing_counter);
674 /* The message will actually be unreffed when we unlock */
677 /** Function to be called in protected_change_watch() with refcount held */
678 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
680 /** Function to be called in protected_change_watch() with refcount held */
681 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
683 /** Function to be called in protected_change_watch() with refcount held */
684 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
686 dbus_bool_t enabled);
689 protected_change_watch (DBusConnection *connection,
691 DBusWatchAddFunction add_function,
692 DBusWatchRemoveFunction remove_function,
693 DBusWatchToggleFunction toggle_function,
698 HAVE_LOCK_CHECK (connection);
700 /* The original purpose of protected_change_watch() was to hold a
701 * ref on the connection while dropping the connection lock, then
702 * calling out to the app. This was a broken hack that did not
703 * work, since the connection was in a hosed state (no WatchList
704 * field) while calling out.
706 * So for now we'll just keep the lock while calling out. This means
707 * apps are not allowed to call DBusConnection methods inside a
708 * watch function or they will deadlock.
710 * The "real fix" is to use the _and_unlock() pattern found
711 * elsewhere in the code, to defer calling out to the app until
712 * we're about to drop locks and return flow of control to the app
715 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
718 if (connection->watches)
721 retval = (* add_function) (connection->watches, watch);
722 else if (remove_function)
725 (* remove_function) (connection->watches, watch);
730 (* toggle_function) (connection->watches, watch, enabled);
740 * Adds a watch using the connection's DBusAddWatchFunction if
741 * available. Otherwise records the watch to be added when said
742 * function is available. Also re-adds the watch if the
743 * DBusAddWatchFunction changes. May fail due to lack of memory.
744 * Connection lock should be held when calling this.
746 * @param connection the connection.
747 * @param watch the watch to add.
748 * @returns #TRUE on success.
751 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
754 return protected_change_watch (connection, watch,
755 _dbus_watch_list_add_watch,
760 * Removes a watch using the connection's DBusRemoveWatchFunction
761 * if available. It's an error to call this function on a watch
762 * that was not previously added.
763 * Connection lock should be held when calling this.
765 * @param connection the connection.
766 * @param watch the watch to remove.
769 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
772 protected_change_watch (connection, watch,
774 _dbus_watch_list_remove_watch,
779 * Toggles a watch and notifies app via connection's
780 * DBusWatchToggledFunction if available. It's an error to call this
781 * function on a watch that was not previously added.
782 * Connection lock should be held when calling this.
784 * @param connection the connection.
785 * @param watch the watch to toggle.
786 * @param enabled whether to enable or disable
789 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
793 _dbus_assert (watch != NULL);
795 protected_change_watch (connection, watch,
797 _dbus_watch_list_toggle_watch,
801 /** Function to be called in protected_change_timeout() with refcount held */
802 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
803 DBusTimeout *timeout);
804 /** Function to be called in protected_change_timeout() with refcount held */
805 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
806 DBusTimeout *timeout);
807 /** Function to be called in protected_change_timeout() with refcount held */
808 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
809 DBusTimeout *timeout,
810 dbus_bool_t enabled);
813 protected_change_timeout (DBusConnection *connection,
814 DBusTimeout *timeout,
815 DBusTimeoutAddFunction add_function,
816 DBusTimeoutRemoveFunction remove_function,
817 DBusTimeoutToggleFunction toggle_function,
822 HAVE_LOCK_CHECK (connection);
824 /* The original purpose of protected_change_timeout() was to hold a
825 * ref on the connection while dropping the connection lock, then
826 * calling out to the app. This was a broken hack that did not
827 * work, since the connection was in a hosed state (no TimeoutList
828 * field) while calling out.
830 * So for now we'll just keep the lock while calling out. This means
831 * apps are not allowed to call DBusConnection methods inside a
832 * timeout function or they will deadlock.
834 * The "real fix" is to use the _and_unlock() pattern found
835 * elsewhere in the code, to defer calling out to the app until
836 * we're about to drop locks and return flow of control to the app
839 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
842 if (connection->timeouts)
845 retval = (* add_function) (connection->timeouts, timeout);
846 else if (remove_function)
849 (* remove_function) (connection->timeouts, timeout);
854 (* toggle_function) (connection->timeouts, timeout, enabled);
863 * Adds a timeout using the connection's DBusAddTimeoutFunction if
864 * available. Otherwise records the timeout to be added when said
865 * function is available. Also re-adds the timeout if the
866 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
867 * The timeout will fire repeatedly until removed.
868 * Connection lock should be held when calling this.
870 * @param connection the connection.
871 * @param timeout the timeout to add.
872 * @returns #TRUE on success.
875 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
876 DBusTimeout *timeout)
878 return protected_change_timeout (connection, timeout,
879 _dbus_timeout_list_add_timeout,
884 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
885 * if available. It's an error to call this function on a timeout
886 * that was not previously added.
887 * Connection lock should be held when calling this.
889 * @param connection the connection.
890 * @param timeout the timeout to remove.
893 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
894 DBusTimeout *timeout)
896 protected_change_timeout (connection, timeout,
898 _dbus_timeout_list_remove_timeout,
903 * Toggles a timeout and notifies app via connection's
904 * DBusTimeoutToggledFunction if available. It's an error to call this
905 * function on a timeout that was not previously added.
906 * Connection lock should be held when calling this.
908 * @param connection the connection.
909 * @param timeout the timeout to toggle.
910 * @param enabled whether to enable or disable
913 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
914 DBusTimeout *timeout,
917 protected_change_timeout (connection, timeout,
919 _dbus_timeout_list_toggle_timeout,
924 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
925 DBusPendingCall *pending)
927 dbus_uint32_t reply_serial;
928 DBusTimeout *timeout;
930 HAVE_LOCK_CHECK (connection);
932 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
934 _dbus_assert (reply_serial != 0);
936 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
940 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
943 if (!_dbus_hash_table_insert_int (connection->pending_replies,
947 _dbus_connection_remove_timeout_unlocked (connection, timeout);
949 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
950 HAVE_LOCK_CHECK (connection);
954 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
958 if (!_dbus_hash_table_insert_int (connection->pending_replies,
962 HAVE_LOCK_CHECK (connection);
967 _dbus_pending_call_ref_unlocked (pending);
969 HAVE_LOCK_CHECK (connection);
975 free_pending_call_on_hash_removal (void *data)
977 DBusPendingCall *pending;
978 DBusConnection *connection;
985 connection = _dbus_pending_call_get_connection_unlocked (pending);
987 HAVE_LOCK_CHECK (connection);
989 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
991 _dbus_connection_remove_timeout_unlocked (connection,
992 _dbus_pending_call_get_timeout_unlocked (pending));
994 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
997 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
998 * here, but the pending call finalizer could in principle call out to
999 * application code so we pretty much have to... some larger code reorg
1002 _dbus_connection_ref_unlocked (connection);
1003 _dbus_pending_call_unref_and_unlock (pending);
1004 CONNECTION_LOCK (connection);
1005 _dbus_connection_unref_unlocked (connection);
1009 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
1010 DBusPendingCall *pending)
1012 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
1015 _dbus_hash_table_remove_int (connection->pending_replies,
1016 _dbus_pending_call_get_reply_serial_unlocked (pending));
1020 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
1021 DBusPendingCall *pending)
1023 /* The idea here is to avoid finalizing the pending call
1024 * with the lock held, since there's a destroy notifier
1025 * in pending call that goes out to application code.
1027 * There's an extra unlock inside the hash table
1028 * "free pending call" function FIXME...
1030 _dbus_pending_call_ref_unlocked (pending);
1031 _dbus_hash_table_remove_int (connection->pending_replies,
1032 _dbus_pending_call_get_reply_serial_unlocked (pending));
1034 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
1035 _dbus_connection_remove_timeout_unlocked (connection,
1036 _dbus_pending_call_get_timeout_unlocked (pending));
1038 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
1040 _dbus_pending_call_unref_and_unlock (pending);
1044 * Removes a pending call from the connection, such that
1045 * the pending reply will be ignored. May drop the last
1046 * reference to the pending call.
1048 * @param connection the connection
1049 * @param pending the pending call
1052 _dbus_connection_remove_pending_call (DBusConnection *connection,
1053 DBusPendingCall *pending)
1055 CONNECTION_LOCK (connection);
1056 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
1060 * Acquire the transporter I/O path. This must be done before
1061 * doing any I/O in the transporter. May sleep and drop the
1062 * IO path mutex while waiting for the I/O path.
1064 * @param connection the connection.
1065 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1066 * @returns TRUE if the I/O path was acquired.
1069 _dbus_connection_acquire_io_path (DBusConnection *connection,
1070 int timeout_milliseconds)
1072 dbus_bool_t we_acquired;
1074 HAVE_LOCK_CHECK (connection);
1076 /* We don't want the connection to vanish */
1077 _dbus_connection_ref_unlocked (connection);
1079 /* We will only touch io_path_acquired which is protected by our mutex */
1080 CONNECTION_UNLOCK (connection);
1082 _dbus_verbose ("locking io_path_mutex\n");
1083 _dbus_cmutex_lock (connection->io_path_mutex);
1085 _dbus_verbose ("start connection->io_path_acquired = %d timeout = %d\n",
1086 connection->io_path_acquired, timeout_milliseconds);
1088 we_acquired = FALSE;
1090 if (connection->io_path_acquired)
1092 if (timeout_milliseconds != -1)
1094 _dbus_verbose ("waiting %d for IO path to be acquirable\n",
1095 timeout_milliseconds);
1097 if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1098 connection->io_path_mutex,
1099 timeout_milliseconds))
1101 /* We timed out before anyone signaled. */
1102 /* (writing the loop to handle the !timedout case by
1103 * waiting longer if needed is a pain since dbus
1104 * wraps pthread_cond_timedwait to take a relative
1105 * time instead of absolute, something kind of stupid
1106 * on our part. for now it doesn't matter, we will just
1107 * end up back here eventually.)
1113 while (connection->io_path_acquired)
1115 _dbus_verbose ("waiting for IO path to be acquirable\n");
1116 _dbus_condvar_wait (connection->io_path_cond,
1117 connection->io_path_mutex);
1122 if (!connection->io_path_acquired)
1125 connection->io_path_acquired = TRUE;
1128 _dbus_verbose ("end connection->io_path_acquired = %d we_acquired = %d\n",
1129 connection->io_path_acquired, we_acquired);
1131 _dbus_verbose ("unlocking io_path_mutex\n");
1132 _dbus_cmutex_unlock (connection->io_path_mutex);
1134 CONNECTION_LOCK (connection);
1136 HAVE_LOCK_CHECK (connection);
1138 _dbus_connection_unref_unlocked (connection);
1144 * Release the I/O path when you're done with it. Only call
1145 * after you've acquired the I/O. Wakes up at most one thread
1146 * currently waiting to acquire the I/O path.
1148 * @param connection the connection.
1151 _dbus_connection_release_io_path (DBusConnection *connection)
1153 HAVE_LOCK_CHECK (connection);
1155 _dbus_verbose ("locking io_path_mutex\n");
1156 _dbus_cmutex_lock (connection->io_path_mutex);
1158 _dbus_assert (connection->io_path_acquired);
1160 _dbus_verbose ("start connection->io_path_acquired = %d\n",
1161 connection->io_path_acquired);
1163 connection->io_path_acquired = FALSE;
1164 _dbus_condvar_wake_one (connection->io_path_cond);
1166 _dbus_verbose ("unlocking io_path_mutex\n");
1167 _dbus_cmutex_unlock (connection->io_path_mutex);
1171 * Queues incoming messages and sends outgoing messages for this
1172 * connection, optionally blocking in the process. Each call to
1173 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1174 * time and then read or write data if possible.
1176 * The purpose of this function is to be able to flush outgoing
1177 * messages or queue up incoming messages without returning
1178 * control to the application and causing reentrancy weirdness.
1180 * The flags parameter allows you to specify whether to
1181 * read incoming messages, write outgoing messages, or both,
1182 * and whether to block if no immediate action is possible.
1184 * The timeout_milliseconds parameter does nothing unless the
1185 * iteration is blocking.
1187 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1188 * wasn't specified, then it's impossible to block, even if
1189 * you specify DBUS_ITERATION_BLOCK; in that case the function
1190 * returns immediately.
1192 * If pending is not NULL then a check is made if the pending call
1193 * is completed after the io path has been required. If the call
1194 * has been completed nothing is done. This must be done since
1195 * the _dbus_connection_acquire_io_path releases the connection
1198 * Called with connection lock held.
1200 * @param connection the connection.
1201 * @param pending the pending call that should be checked or NULL
1202 * @param flags iteration flags.
1203 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1206 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1207 DBusPendingCall *pending,
1209 int timeout_milliseconds)
1211 _dbus_verbose ("start\n");
1213 HAVE_LOCK_CHECK (connection);
1215 if (connection->n_outgoing == 0)
1216 flags &= ~DBUS_ITERATION_DO_WRITING;
1218 if (_dbus_connection_acquire_io_path (connection,
1219 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1221 HAVE_LOCK_CHECK (connection);
1223 if ( (pending != NULL) && _dbus_pending_call_get_completed_unlocked(pending))
1225 _dbus_verbose ("pending call completed while acquiring I/O path");
1227 else if ( (pending != NULL) &&
1228 _dbus_connection_peek_for_reply_unlocked (connection,
1229 _dbus_pending_call_get_reply_serial_unlocked (pending)))
1231 _dbus_verbose ("pending call completed while acquiring I/O path (reply found in queue)");
1235 _dbus_transport_do_iteration (connection->transport,
1236 flags, timeout_milliseconds);
1239 _dbus_connection_release_io_path (connection);
1242 HAVE_LOCK_CHECK (connection);
1244 _dbus_verbose ("end\n");
1248 * Creates a new connection for the given transport. A transport
1249 * represents a message stream that uses some concrete mechanism, such
1250 * as UNIX domain sockets. May return #NULL if insufficient
1251 * memory exists to create the connection.
1253 * @param transport the transport.
1254 * @returns the new connection, or #NULL on failure.
1257 _dbus_connection_new_for_transport (DBusTransport *transport)
1259 DBusConnection *connection;
1260 DBusWatchList *watch_list;
1261 DBusTimeoutList *timeout_list;
1262 DBusHashTable *pending_replies;
1263 DBusList *disconnect_link;
1264 DBusMessage *disconnect_message;
1265 DBusCounter *outgoing_counter;
1266 DBusObjectTree *objects;
1270 pending_replies = NULL;
1271 timeout_list = NULL;
1272 disconnect_link = NULL;
1273 disconnect_message = NULL;
1274 outgoing_counter = NULL;
1277 watch_list = _dbus_watch_list_new ();
1278 if (watch_list == NULL)
1281 timeout_list = _dbus_timeout_list_new ();
1282 if (timeout_list == NULL)
1286 _dbus_hash_table_new (DBUS_HASH_INT,
1288 (DBusFreeFunction)free_pending_call_on_hash_removal);
1289 if (pending_replies == NULL)
1292 connection = dbus_new0 (DBusConnection, 1);
1293 if (connection == NULL)
1296 _dbus_rmutex_new_at_location (&connection->mutex);
1297 if (connection->mutex == NULL)
1300 _dbus_cmutex_new_at_location (&connection->io_path_mutex);
1301 if (connection->io_path_mutex == NULL)
1304 _dbus_cmutex_new_at_location (&connection->dispatch_mutex);
1305 if (connection->dispatch_mutex == NULL)
1308 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1309 if (connection->dispatch_cond == NULL)
1312 _dbus_condvar_new_at_location (&connection->io_path_cond);
1313 if (connection->io_path_cond == NULL)
1316 _dbus_rmutex_new_at_location (&connection->slot_mutex);
1317 if (connection->slot_mutex == NULL)
1320 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1321 DBUS_INTERFACE_LOCAL,
1324 if (disconnect_message == NULL)
1327 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1328 if (disconnect_link == NULL)
1331 outgoing_counter = _dbus_counter_new ();
1332 if (outgoing_counter == NULL)
1335 objects = _dbus_object_tree_new (connection);
1336 if (objects == NULL)
1339 if (_dbus_modify_sigpipe)
1340 _dbus_disable_sigpipe ();
1342 /* initialized to 0: use atomic op to avoid mixing atomic and non-atomic */
1343 _dbus_atomic_inc (&connection->refcount);
1344 connection->transport = transport;
1345 connection->watches = watch_list;
1346 connection->timeouts = timeout_list;
1347 connection->pending_replies = pending_replies;
1348 connection->outgoing_counter = outgoing_counter;
1349 connection->filter_list = NULL;
1350 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1351 connection->objects = objects;
1352 connection->exit_on_disconnect = FALSE;
1353 connection->shareable = FALSE;
1354 connection->route_peer_messages = FALSE;
1355 connection->disconnected_message_arrived = FALSE;
1356 connection->disconnected_message_processed = FALSE;
1358 #ifndef DBUS_DISABLE_CHECKS
1359 connection->generation = _dbus_current_generation;
1362 _dbus_data_slot_list_init (&connection->slot_list);
1364 connection->client_serial = 1;
1366 connection->disconnect_message_link = disconnect_link;
1368 CONNECTION_LOCK (connection);
1370 if (!_dbus_transport_set_connection (transport, connection))
1372 CONNECTION_UNLOCK (connection);
1377 _dbus_transport_ref (transport);
1379 CONNECTION_UNLOCK (connection);
1381 _dbus_connection_trace_ref (connection, 0, 1, "new_for_transport");
1385 if (disconnect_message != NULL)
1386 dbus_message_unref (disconnect_message);
1388 if (disconnect_link != NULL)
1389 _dbus_list_free_link (disconnect_link);
1391 if (connection != NULL)
1393 _dbus_condvar_free_at_location (&connection->io_path_cond);
1394 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1395 _dbus_rmutex_free_at_location (&connection->mutex);
1396 _dbus_cmutex_free_at_location (&connection->io_path_mutex);
1397 _dbus_cmutex_free_at_location (&connection->dispatch_mutex);
1398 _dbus_rmutex_free_at_location (&connection->slot_mutex);
1399 dbus_free (connection);
1401 if (pending_replies)
1402 _dbus_hash_table_unref (pending_replies);
1405 _dbus_watch_list_free (watch_list);
1408 _dbus_timeout_list_free (timeout_list);
1410 if (outgoing_counter)
1411 _dbus_counter_unref (outgoing_counter);
1414 _dbus_object_tree_unref (objects);
1420 * Increments the reference count of a DBusConnection.
1421 * Requires that the caller already holds the connection lock.
1423 * @param connection the connection.
1424 * @returns the connection.
1427 _dbus_connection_ref_unlocked (DBusConnection *connection)
1429 dbus_int32_t old_refcount;
1431 _dbus_assert (connection != NULL);
1432 _dbus_assert (connection->generation == _dbus_current_generation);
1434 HAVE_LOCK_CHECK (connection);
1436 old_refcount = _dbus_atomic_inc (&connection->refcount);
1437 _dbus_connection_trace_ref (connection, old_refcount, old_refcount + 1,
1444 * Decrements the reference count of a DBusConnection.
1445 * Requires that the caller already holds the connection lock.
1447 * @param connection the connection.
1450 _dbus_connection_unref_unlocked (DBusConnection *connection)
1452 dbus_int32_t old_refcount;
1454 HAVE_LOCK_CHECK (connection);
1456 _dbus_assert (connection != NULL);
1458 old_refcount = _dbus_atomic_dec (&connection->refcount);
1460 _dbus_connection_trace_ref (connection, old_refcount, old_refcount - 1,
1463 if (old_refcount == 1)
1464 _dbus_connection_last_unref (connection);
1467 static dbus_uint32_t
1468 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1470 dbus_uint32_t serial;
1472 serial = connection->client_serial++;
1474 if (connection->client_serial == 0)
1475 connection->client_serial = 1;
1481 * A callback for use with dbus_watch_new() to create a DBusWatch.
1483 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1484 * and the virtual handle_watch in DBusTransport if we got rid of it.
1485 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1488 * @param watch the watch.
1489 * @param condition the current condition of the file descriptors being watched.
1490 * @param data must be a pointer to a #DBusConnection
1491 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1494 _dbus_connection_handle_watch (DBusWatch *watch,
1495 unsigned int condition,
1498 DBusConnection *connection;
1500 DBusDispatchStatus status;
1504 _dbus_verbose ("start\n");
1506 CONNECTION_LOCK (connection);
1508 if (!_dbus_connection_acquire_io_path (connection, 1))
1510 /* another thread is handling the message */
1511 CONNECTION_UNLOCK (connection);
1515 HAVE_LOCK_CHECK (connection);
1516 retval = _dbus_transport_handle_watch (connection->transport,
1519 _dbus_connection_release_io_path (connection);
1521 HAVE_LOCK_CHECK (connection);
1523 _dbus_verbose ("middle\n");
1525 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1527 /* this calls out to user code */
1528 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1530 _dbus_verbose ("end\n");
1535 /* Protected by _DBUS_LOCK (shared_connections) */
1536 static DBusHashTable *shared_connections = NULL;
1537 static DBusList *shared_connections_no_guid = NULL;
1540 close_connection_on_shutdown (DBusConnection *connection)
1542 DBusMessage *message;
1544 dbus_connection_ref (connection);
1545 _dbus_connection_close_possibly_shared (connection);
1547 /* Churn through to the Disconnected message */
1548 while ((message = dbus_connection_pop_message (connection)))
1550 dbus_message_unref (message);
1552 dbus_connection_unref (connection);
1556 shared_connections_shutdown (void *data)
1560 if (!_DBUS_LOCK (shared_connections))
1562 /* We'd have initialized locks before adding anything, so there
1563 * can't be anything there. */
1567 /* This is a little bit unpleasant... better ideas? */
1568 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1570 DBusConnection *connection;
1573 _dbus_hash_iter_init (shared_connections, &iter);
1574 _dbus_hash_iter_next (&iter);
1576 connection = _dbus_hash_iter_get_value (&iter);
1578 _DBUS_UNLOCK (shared_connections);
1579 close_connection_on_shutdown (connection);
1580 if (!_DBUS_LOCK (shared_connections))
1581 _dbus_assert_not_reached ("global locks were already initialized");
1583 /* The connection should now be dead and not in our hash ... */
1584 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1587 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1589 _dbus_hash_table_unref (shared_connections);
1590 shared_connections = NULL;
1592 if (shared_connections_no_guid != NULL)
1594 DBusConnection *connection;
1595 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1596 while (connection != NULL)
1598 _DBUS_UNLOCK (shared_connections);
1599 close_connection_on_shutdown (connection);
1600 if (!_DBUS_LOCK (shared_connections))
1601 _dbus_assert_not_reached ("global locks were already initialized");
1602 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1606 shared_connections_no_guid = NULL;
1608 _DBUS_UNLOCK (shared_connections);
1612 connection_lookup_shared (DBusAddressEntry *entry,
1613 DBusConnection **result)
1615 _dbus_verbose ("checking for existing connection\n");
1619 if (!_DBUS_LOCK (shared_connections))
1621 /* If it was shared, we'd have initialized global locks when we put
1622 * it in shared_connections. */
1626 if (shared_connections == NULL)
1628 _dbus_verbose ("creating shared_connections hash table\n");
1630 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1633 if (shared_connections == NULL)
1635 _DBUS_UNLOCK (shared_connections);
1639 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1641 _dbus_hash_table_unref (shared_connections);
1642 shared_connections = NULL;
1643 _DBUS_UNLOCK (shared_connections);
1647 _dbus_verbose (" successfully created shared_connections\n");
1649 _DBUS_UNLOCK (shared_connections);
1650 return TRUE; /* no point looking up in the hash we just made */
1656 guid = dbus_address_entry_get_value (entry, "guid");
1660 DBusConnection *connection;
1662 connection = _dbus_hash_table_lookup_string (shared_connections,
1667 /* The DBusConnection can't be finalized without taking
1668 * the shared_connections lock to remove it from the
1669 * hash. So it's safe to ref the connection here.
1670 * However, it may be disconnected if the Disconnected
1671 * message hasn't been processed yet, in which case we
1672 * want to pretend it isn't in the hash and avoid
1675 * The idea is to avoid ever returning a disconnected connection
1676 * from dbus_connection_open(). We could just synchronously
1677 * drop our shared ref to the connection on connection disconnect,
1678 * and then assert here that the connection is connected, but
1679 * that causes reentrancy headaches.
1681 CONNECTION_LOCK (connection);
1682 if (_dbus_connection_get_is_connected_unlocked (connection))
1684 _dbus_connection_ref_unlocked (connection);
1685 *result = connection;
1686 _dbus_verbose ("looked up existing connection to server guid %s\n",
1691 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1694 CONNECTION_UNLOCK (connection);
1698 _DBUS_UNLOCK (shared_connections);
1704 connection_record_shared_unlocked (DBusConnection *connection,
1708 char *guid_in_connection;
1710 HAVE_LOCK_CHECK (connection);
1711 _dbus_assert (connection->server_guid == NULL);
1712 _dbus_assert (connection->shareable);
1714 /* get a hard ref on this connection, even if
1715 * we won't in fact store it in the hash, we still
1716 * need to hold a ref on it until it's disconnected.
1718 _dbus_connection_ref_unlocked (connection);
1722 if (!_DBUS_LOCK (shared_connections))
1725 if (!_dbus_list_prepend (&shared_connections_no_guid, connection))
1727 _DBUS_UNLOCK (shared_connections);
1731 _DBUS_UNLOCK (shared_connections);
1732 return TRUE; /* don't store in the hash */
1735 /* A separate copy of the key is required in the hash table, because
1736 * we don't have a lock on the connection when we are doing a hash
1740 guid_key = _dbus_strdup (guid);
1741 if (guid_key == NULL)
1744 guid_in_connection = _dbus_strdup (guid);
1745 if (guid_in_connection == NULL)
1747 dbus_free (guid_key);
1751 if (!_DBUS_LOCK (shared_connections))
1753 dbus_free (guid_in_connection);
1754 dbus_free (guid_key);
1758 _dbus_assert (shared_connections != NULL);
1760 if (!_dbus_hash_table_insert_string (shared_connections,
1761 guid_key, connection))
1763 dbus_free (guid_key);
1764 dbus_free (guid_in_connection);
1765 _DBUS_UNLOCK (shared_connections);
1769 connection->server_guid = guid_in_connection;
1771 _dbus_verbose ("stored connection to %s to be shared\n",
1772 connection->server_guid);
1774 _DBUS_UNLOCK (shared_connections);
1776 _dbus_assert (connection->server_guid != NULL);
1782 connection_forget_shared_unlocked (DBusConnection *connection)
1784 HAVE_LOCK_CHECK (connection);
1786 if (!connection->shareable)
1789 if (!_DBUS_LOCK (shared_connections))
1791 /* If it was shared, we'd have initialized global locks when we put
1792 * it in the table; so it can't be there. */
1796 if (connection->server_guid != NULL)
1798 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1799 connection->server_guid);
1801 if (!_dbus_hash_table_remove_string (shared_connections,
1802 connection->server_guid))
1803 _dbus_assert_not_reached ("connection was not in the shared table");
1805 dbus_free (connection->server_guid);
1806 connection->server_guid = NULL;
1810 _dbus_list_remove (&shared_connections_no_guid, connection);
1813 _DBUS_UNLOCK (shared_connections);
1815 /* remove our reference held on all shareable connections */
1816 _dbus_connection_unref_unlocked (connection);
1819 static DBusConnection*
1820 connection_try_from_address_entry (DBusAddressEntry *entry,
1823 DBusTransport *transport;
1824 DBusConnection *connection;
1826 transport = _dbus_transport_open (entry, error);
1828 if (transport == NULL)
1830 _DBUS_ASSERT_ERROR_IS_SET (error);
1834 connection = _dbus_connection_new_for_transport (transport);
1836 _dbus_transport_unref (transport);
1838 if (connection == NULL)
1840 _DBUS_SET_OOM (error);
1844 #ifndef DBUS_DISABLE_CHECKS
1845 _dbus_assert (!connection->have_connection_lock);
1848 /* kdbus add-on [RP] - bus register for kdbus
1849 * Function checks if the method is kdbus. If yes - it registers on the bus, if no - does nothing and returns TRUE
1850 * Must be invoked before dbus_bus_register because in kdbus it's realized in different manner
1851 * and dbus_bus_register can not be used for that.
1852 * It does not collide with dbus_bus_register because dbus_bus_register at the beginning checks
1853 * whether unique_name has already been assigned and doesn't try to do it again.
1856 if(!dbus_bus_register_kdbus(entry, connection, error))
1858 _dbus_connection_close_possibly_shared (connection);
1859 dbus_connection_unref (connection);
1867 * If the shared parameter is true, then any existing connection will
1868 * be used (and if a new connection is created, it will be available
1869 * for use by others). If the shared parameter is false, a new
1870 * connection will always be created, and the new connection will
1871 * never be returned to other callers.
1873 * @param address the address
1874 * @param shared whether the connection is shared or private
1875 * @param error error return
1876 * @returns the connection or #NULL on error
1878 static DBusConnection*
1879 _dbus_connection_open_internal (const char *address,
1883 DBusConnection *connection;
1884 DBusAddressEntry **entries;
1885 DBusError tmp_error = DBUS_ERROR_INIT;
1886 DBusError first_error = DBUS_ERROR_INIT;
1889 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1891 _dbus_verbose ("opening %s connection to: %s\n",
1892 shared ? "shared" : "private", address);
1894 if (!dbus_parse_address (address, &entries, &len, error))
1897 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1901 for (i = 0; i < len; i++)
1905 if (!connection_lookup_shared (entries[i], &connection))
1906 _DBUS_SET_OOM (&tmp_error);
1909 if (connection == NULL)
1911 connection = connection_try_from_address_entry (entries[i],
1914 if (connection != NULL && shared)
1918 connection->shareable = TRUE;
1920 /* guid may be NULL */
1921 guid = dbus_address_entry_get_value (entries[i], "guid");
1923 CONNECTION_LOCK (connection);
1925 if (!connection_record_shared_unlocked (connection, guid))
1927 _DBUS_SET_OOM (&tmp_error);
1928 _dbus_connection_close_possibly_shared_and_unlock (connection);
1929 dbus_connection_unref (connection);
1933 CONNECTION_UNLOCK (connection);
1940 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1943 dbus_move_error (&tmp_error, &first_error);
1945 dbus_error_free (&tmp_error);
1948 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1949 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1951 if (connection == NULL)
1953 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1954 dbus_move_error (&first_error, error);
1957 dbus_error_free (&first_error);
1959 dbus_address_entries_free (entries);
1964 * Closes a shared OR private connection, while dbus_connection_close() can
1965 * only be used on private connections. Should only be called by the
1966 * dbus code that owns the connection - an owner must be known,
1967 * the open/close state is like malloc/free, not like ref/unref.
1969 * @param connection the connection
1972 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1974 _dbus_assert (connection != NULL);
1975 _dbus_assert (connection->generation == _dbus_current_generation);
1977 CONNECTION_LOCK (connection);
1978 _dbus_connection_close_possibly_shared_and_unlock (connection);
1981 static DBusPreallocatedSend*
1982 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1984 DBusPreallocatedSend *preallocated;
1986 HAVE_LOCK_CHECK (connection);
1988 _dbus_assert (connection != NULL);
1990 preallocated = dbus_new (DBusPreallocatedSend, 1);
1991 if (preallocated == NULL)
1994 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1995 if (preallocated->queue_link == NULL)
1998 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1999 if (preallocated->counter_link == NULL)
2002 _dbus_counter_ref (preallocated->counter_link->data);
2004 preallocated->connection = connection;
2006 return preallocated;
2009 _dbus_list_free_link (preallocated->queue_link);
2011 dbus_free (preallocated);
2016 /* Called with lock held, does not update dispatch status */
2018 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
2019 DBusPreallocatedSend *preallocated,
2020 DBusMessage *message,
2021 dbus_uint32_t *client_serial)
2023 dbus_uint32_t serial;
2025 preallocated->queue_link->data = message;
2026 _dbus_list_prepend_link (&connection->outgoing_messages,
2027 preallocated->queue_link);
2029 /* It's OK that we'll never call the notify function, because for the
2030 * outgoing limit, there isn't one */
2031 _dbus_message_add_counter_link (message,
2032 preallocated->counter_link);
2034 dbus_free (preallocated);
2035 preallocated = NULL;
2037 dbus_message_ref (message);
2039 connection->n_outgoing += 1;
2041 _dbus_verbose ("Message %p (%s %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
2043 dbus_message_type_to_string (dbus_message_get_type (message)),
2044 dbus_message_get_path (message) ?
2045 dbus_message_get_path (message) :
2047 dbus_message_get_interface (message) ?
2048 dbus_message_get_interface (message) :
2050 dbus_message_get_member (message) ?
2051 dbus_message_get_member (message) :
2053 dbus_message_get_signature (message),
2054 dbus_message_get_destination (message) ?
2055 dbus_message_get_destination (message) :
2058 connection->n_outgoing);
2060 if (dbus_message_get_serial (message) == 0)
2062 serial = _dbus_connection_get_next_client_serial (connection);
2063 dbus_message_set_serial (message, serial);
2065 *client_serial = serial;
2070 *client_serial = dbus_message_get_serial (message);
2073 _dbus_verbose ("Message %p serial is %u\n",
2074 message, dbus_message_get_serial (message));
2076 dbus_message_lock (message);
2078 /* Now we need to run an iteration to hopefully just write the messages
2079 * out immediately, and otherwise get them queued up
2081 _dbus_connection_do_iteration_unlocked (connection,
2083 DBUS_ITERATION_DO_WRITING,
2086 /* If stuff is still queued up, be sure we wake up the main loop */
2087 if (connection->n_outgoing > 0)
2088 _dbus_connection_wakeup_mainloop (connection);
2092 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2093 DBusPreallocatedSend *preallocated,
2094 DBusMessage *message,
2095 dbus_uint32_t *client_serial)
2097 DBusDispatchStatus status;
2099 HAVE_LOCK_CHECK (connection);
2101 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2103 message, client_serial);
2105 _dbus_verbose ("middle\n");
2106 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2108 /* this calls out to user code */
2109 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2113 * Like dbus_connection_send(), but assumes the connection
2114 * is already locked on function entry, and unlocks before returning.
2116 * @param connection the connection
2117 * @param message the message to send
2118 * @param client_serial return location for client serial of sent message
2119 * @returns #FALSE on out-of-memory
2122 _dbus_connection_send_and_unlock (DBusConnection *connection,
2123 DBusMessage *message,
2124 dbus_uint32_t *client_serial)
2126 DBusPreallocatedSend *preallocated;
2128 _dbus_assert (connection != NULL);
2129 _dbus_assert (message != NULL);
2131 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2132 if (preallocated == NULL)
2134 CONNECTION_UNLOCK (connection);
2138 _dbus_connection_send_preallocated_and_unlock (connection,
2146 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2147 * If the new connection function does not ref the connection, we want to close it.
2149 * A bit of a hack, probably the new connection function should have returned a value
2150 * for whether to close, or should have had to close the connection itself if it
2153 * But, this works OK as long as the new connection function doesn't do anything
2154 * crazy like keep the connection around without ref'ing it.
2156 * We have to lock the connection across refcount check and close in case
2157 * the new connection function spawns a thread that closes and unrefs.
2158 * In that case, if the app thread
2159 * closes and unrefs first, we'll harmlessly close again; if the app thread
2160 * still has the ref, we'll close and then the app will close harmlessly.
2161 * If the app unrefs without closing, the app is broken since if the
2162 * app refs from the new connection function it is supposed to also close.
2164 * If we didn't atomically check the refcount and close with the lock held
2165 * though, we could screw this up.
2167 * @param connection the connection
2170 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2172 dbus_int32_t refcount;
2174 CONNECTION_LOCK (connection);
2176 refcount = _dbus_atomic_get (&connection->refcount);
2177 /* The caller should have at least one ref */
2178 _dbus_assert (refcount >= 1);
2181 _dbus_connection_close_possibly_shared_and_unlock (connection);
2183 CONNECTION_UNLOCK (connection);
2188 * When a function that blocks has been called with a timeout, and we
2189 * run out of memory, the time to wait for memory is based on the
2190 * timeout. If the caller was willing to block a long time we wait a
2191 * relatively long time for memory, if they were only willing to block
2192 * briefly then we retry for memory at a rapid rate.
2194 * @timeout_milliseconds the timeout requested for blocking
2197 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2199 if (timeout_milliseconds == -1)
2200 _dbus_sleep_milliseconds (1000);
2201 else if (timeout_milliseconds < 100)
2202 ; /* just busy loop */
2203 else if (timeout_milliseconds <= 1000)
2204 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2206 _dbus_sleep_milliseconds (1000);
2209 static DBusMessage *
2210 generate_local_error_message (dbus_uint32_t serial,
2214 DBusMessage *message;
2215 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2219 if (!dbus_message_set_error_name (message, error_name))
2221 dbus_message_unref (message);
2226 dbus_message_set_no_reply (message, TRUE);
2228 if (!dbus_message_set_reply_serial (message,
2231 dbus_message_unref (message);
2236 if (error_msg != NULL)
2238 DBusMessageIter iter;
2240 dbus_message_iter_init_append (message, &iter);
2241 if (!dbus_message_iter_append_basic (&iter,
2245 dbus_message_unref (message);
2256 * Peek the incoming queue to see if we got reply for a specific serial
2259 _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
2260 dbus_uint32_t client_serial)
2263 HAVE_LOCK_CHECK (connection);
2265 link = _dbus_list_get_first_link (&connection->incoming_messages);
2267 while (link != NULL)
2269 DBusMessage *reply = link->data;
2271 if (dbus_message_get_reply_serial (reply) == client_serial)
2273 _dbus_verbose ("%s reply to %d found in queue\n", _DBUS_FUNCTION_NAME, client_serial);
2276 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2282 /* This is slightly strange since we can pop a message here without
2283 * the dispatch lock.
2286 check_for_reply_unlocked (DBusConnection *connection,
2287 dbus_uint32_t client_serial)
2291 HAVE_LOCK_CHECK (connection);
2293 link = _dbus_list_get_first_link (&connection->incoming_messages);
2295 while (link != NULL)
2297 DBusMessage *reply = link->data;
2299 if (dbus_message_get_reply_serial (reply) == client_serial)
2301 _dbus_list_remove_link (&connection->incoming_messages, link);
2302 connection->n_incoming -= 1;
2305 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2312 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2314 /* We can't iterate over the hash in the normal way since we'll be
2315 * dropping the lock for each item. So we restart the
2316 * iter each time as we drain the hash table.
2319 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2321 DBusPendingCall *pending;
2324 _dbus_hash_iter_init (connection->pending_replies, &iter);
2325 _dbus_hash_iter_next (&iter);
2327 pending = _dbus_hash_iter_get_value (&iter);
2328 _dbus_pending_call_ref_unlocked (pending);
2330 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2333 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
2334 _dbus_connection_remove_timeout_unlocked (connection,
2335 _dbus_pending_call_get_timeout_unlocked (pending));
2336 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2337 _dbus_hash_iter_remove_entry (&iter);
2339 _dbus_pending_call_unref_and_unlock (pending);
2340 CONNECTION_LOCK (connection);
2342 HAVE_LOCK_CHECK (connection);
2346 complete_pending_call_and_unlock (DBusConnection *connection,
2347 DBusPendingCall *pending,
2348 DBusMessage *message)
2350 _dbus_pending_call_set_reply_unlocked (pending, message);
2351 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2352 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2354 /* Must be called unlocked since it invokes app callback */
2355 _dbus_pending_call_complete (pending);
2356 dbus_pending_call_unref (pending);
2360 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2361 DBusPendingCall *pending)
2364 DBusDispatchStatus status;
2366 reply = check_for_reply_unlocked (connection,
2367 _dbus_pending_call_get_reply_serial_unlocked (pending));
2370 _dbus_verbose ("checked for reply\n");
2372 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2374 complete_pending_call_and_unlock (connection, pending, reply);
2375 dbus_message_unref (reply);
2377 CONNECTION_LOCK (connection);
2378 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2379 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2380 dbus_pending_call_unref (pending);
2389 * Blocks until a pending call times out or gets a reply.
2391 * Does not re-enter the main loop or run filter/path-registered
2392 * callbacks. The reply to the message will not be seen by
2395 * Returns immediately if pending call already got a reply.
2397 * @todo could use performance improvements (it keeps scanning
2398 * the whole message queue for example)
2400 * @param pending the pending call we block for a reply on
2403 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2405 long start_tv_sec, start_tv_usec;
2406 long tv_sec, tv_usec;
2407 DBusDispatchStatus status;
2408 DBusConnection *connection;
2409 dbus_uint32_t client_serial;
2410 DBusTimeout *timeout;
2411 int timeout_milliseconds, elapsed_milliseconds;
2413 _dbus_assert (pending != NULL);
2415 if (dbus_pending_call_get_completed (pending))
2418 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2420 connection = _dbus_pending_call_get_connection_and_lock (pending);
2422 /* Flush message queue - note, can affect dispatch status */
2423 _dbus_connection_flush_unlocked (connection);
2425 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2427 /* note that timeout_milliseconds is limited to a smallish value
2428 * in _dbus_pending_call_new() so overflows aren't possible
2431 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
2432 _dbus_get_monotonic_time (&start_tv_sec, &start_tv_usec);
2435 timeout_milliseconds = dbus_timeout_get_interval (timeout);
2437 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec\n",
2438 timeout_milliseconds,
2440 start_tv_sec, start_tv_usec);
2444 timeout_milliseconds = -1;
2446 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block for reply serial %u\n", client_serial);
2449 /* check to see if we already got the data off the socket */
2450 /* from another blocked pending call */
2451 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2454 /* Now we wait... */
2455 /* always block at least once as we know we don't have the reply yet */
2456 _dbus_connection_do_iteration_unlocked (connection,
2458 DBUS_ITERATION_DO_READING |
2459 DBUS_ITERATION_BLOCK,
2460 timeout_milliseconds);
2464 _dbus_verbose ("top of recheck\n");
2466 HAVE_LOCK_CHECK (connection);
2468 /* queue messages and get status */
2470 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2472 /* the get_completed() is in case a dispatch() while we were blocking
2473 * got the reply instead of us.
2475 if (_dbus_pending_call_get_completed_unlocked (pending))
2477 _dbus_verbose ("Pending call completed by dispatch\n");
2478 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2479 dbus_pending_call_unref (pending);
2483 if (status == DBUS_DISPATCH_DATA_REMAINS)
2485 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2489 _dbus_get_monotonic_time (&tv_sec, &tv_usec);
2490 elapsed_milliseconds = (tv_sec - start_tv_sec) * 1000 +
2491 (tv_usec - start_tv_usec) / 1000;
2493 if (!_dbus_connection_get_is_connected_unlocked (connection))
2495 DBusMessage *error_msg;
2497 error_msg = generate_local_error_message (client_serial,
2498 DBUS_ERROR_DISCONNECTED,
2499 "Connection was disconnected before a reply was received");
2501 /* on OOM error_msg is set to NULL */
2502 complete_pending_call_and_unlock (connection, pending, error_msg);
2503 dbus_pending_call_unref (pending);
2506 else if (connection->disconnect_message_link == NULL)
2507 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2508 else if (timeout == NULL)
2510 if (status == DBUS_DISPATCH_NEED_MEMORY)
2512 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2513 * we may already have a reply in the buffer and just can't process
2516 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2518 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2522 /* block again, we don't have the reply buffered yet. */
2523 _dbus_connection_do_iteration_unlocked (connection,
2525 DBUS_ITERATION_DO_READING |
2526 DBUS_ITERATION_BLOCK,
2527 timeout_milliseconds - elapsed_milliseconds);
2530 goto recheck_status;
2532 else if (tv_sec < start_tv_sec)
2533 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2534 else if (elapsed_milliseconds < timeout_milliseconds)
2536 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds - elapsed_milliseconds);
2538 if (status == DBUS_DISPATCH_NEED_MEMORY)
2540 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2541 * we may already have a reply in the buffer and just can't process
2544 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2546 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2550 /* block again, we don't have the reply buffered yet. */
2551 _dbus_connection_do_iteration_unlocked (connection,
2553 DBUS_ITERATION_DO_READING |
2554 DBUS_ITERATION_BLOCK,
2555 timeout_milliseconds - elapsed_milliseconds);
2558 goto recheck_status;
2561 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %d milliseconds and got no reply\n",
2562 elapsed_milliseconds);
2564 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2566 /* unlock and call user code */
2567 complete_pending_call_and_unlock (connection, pending, NULL);
2569 /* update user code on dispatch status */
2570 CONNECTION_LOCK (connection);
2571 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2572 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2573 dbus_pending_call_unref (pending);
2579 * @addtogroup DBusConnection
2585 * Gets a connection to a remote address. If a connection to the given
2586 * address already exists, returns the existing connection with its
2587 * reference count incremented. Otherwise, returns a new connection
2588 * and saves the new connection for possible re-use if a future call
2589 * to dbus_connection_open() asks to connect to the same server.
2591 * Use dbus_connection_open_private() to get a dedicated connection
2592 * not shared with other callers of dbus_connection_open().
2594 * If the open fails, the function returns #NULL, and provides a
2595 * reason for the failure in the error parameter. Pass #NULL for the
2596 * error parameter if you aren't interested in the reason for
2599 * Because this connection is shared, no user of the connection
2600 * may call dbus_connection_close(). However, when you are done with the
2601 * connection you should call dbus_connection_unref().
2603 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2604 * unless you have good reason; connections are expensive enough
2605 * that it's wasteful to create lots of connections to the same
2608 * @param address the address.
2609 * @param error address where an error can be returned.
2610 * @returns new connection, or #NULL on failure.
2613 dbus_connection_open (const char *address,
2616 DBusConnection *connection;
2618 _dbus_return_val_if_fail (address != NULL, NULL);
2619 _dbus_return_val_if_error_is_set (error, NULL);
2621 connection = _dbus_connection_open_internal (address,
2629 * Opens a new, dedicated connection to a remote address. Unlike
2630 * dbus_connection_open(), always creates a new connection.
2631 * This connection will not be saved or recycled by libdbus.
2633 * If the open fails, the function returns #NULL, and provides a
2634 * reason for the failure in the error parameter. Pass #NULL for the
2635 * error parameter if you aren't interested in the reason for
2638 * When you are done with this connection, you must
2639 * dbus_connection_close() to disconnect it,
2640 * and dbus_connection_unref() to free the connection object.
2642 * (The dbus_connection_close() can be skipped if the
2643 * connection is already known to be disconnected, for example
2644 * if you are inside a handler for the Disconnected signal.)
2646 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2647 * unless you have good reason; connections are expensive enough
2648 * that it's wasteful to create lots of connections to the same
2651 * @param address the address.
2652 * @param error address where an error can be returned.
2653 * @returns new connection, or #NULL on failure.
2656 dbus_connection_open_private (const char *address,
2659 DBusConnection *connection;
2661 _dbus_return_val_if_fail (address != NULL, NULL);
2662 _dbus_return_val_if_error_is_set (error, NULL);
2664 connection = _dbus_connection_open_internal (address,
2672 * Increments the reference count of a DBusConnection.
2674 * @param connection the connection.
2675 * @returns the connection.
2678 dbus_connection_ref (DBusConnection *connection)
2680 dbus_int32_t old_refcount;
2682 _dbus_return_val_if_fail (connection != NULL, NULL);
2683 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2684 old_refcount = _dbus_atomic_inc (&connection->refcount);
2685 _dbus_connection_trace_ref (connection, old_refcount, old_refcount + 1,
2692 free_outgoing_message (void *element,
2695 DBusMessage *message = element;
2696 DBusConnection *connection = data;
2698 _dbus_message_remove_counter (message, connection->outgoing_counter);
2699 dbus_message_unref (message);
2702 /* This is run without the mutex held, but after the last reference
2703 * to the connection has been dropped we should have no thread-related
2707 _dbus_connection_last_unref (DBusConnection *connection)
2711 _dbus_verbose ("Finalizing connection %p\n", connection);
2713 _dbus_assert (_dbus_atomic_get (&connection->refcount) == 0);
2715 /* You have to disconnect the connection before unref:ing it. Otherwise
2716 * you won't get the disconnected message.
2718 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2719 _dbus_assert (connection->server_guid == NULL);
2721 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2722 _dbus_object_tree_free_all_unlocked (connection->objects);
2724 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2725 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2726 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2728 _dbus_watch_list_free (connection->watches);
2729 connection->watches = NULL;
2731 _dbus_timeout_list_free (connection->timeouts);
2732 connection->timeouts = NULL;
2734 _dbus_data_slot_list_free (&connection->slot_list);
2736 link = _dbus_list_get_first_link (&connection->filter_list);
2737 while (link != NULL)
2739 DBusMessageFilter *filter = link->data;
2740 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2742 filter->function = NULL;
2743 _dbus_message_filter_unref (filter); /* calls app callback */
2748 _dbus_list_clear (&connection->filter_list);
2750 /* ---- Done with stuff that invokes application callbacks */
2752 _dbus_object_tree_unref (connection->objects);
2754 _dbus_hash_table_unref (connection->pending_replies);
2755 connection->pending_replies = NULL;
2757 _dbus_list_clear (&connection->filter_list);
2759 _dbus_list_foreach (&connection->outgoing_messages,
2760 free_outgoing_message,
2762 _dbus_list_clear (&connection->outgoing_messages);
2764 _dbus_list_foreach (&connection->incoming_messages,
2765 (DBusForeachFunction) dbus_message_unref,
2767 _dbus_list_clear (&connection->incoming_messages);
2769 _dbus_counter_unref (connection->outgoing_counter);
2771 _dbus_transport_unref (connection->transport);
2773 if (connection->disconnect_message_link)
2775 DBusMessage *message = connection->disconnect_message_link->data;
2776 dbus_message_unref (message);
2777 _dbus_list_free_link (connection->disconnect_message_link);
2780 _dbus_condvar_free_at_location (&connection->dispatch_cond);
2781 _dbus_condvar_free_at_location (&connection->io_path_cond);
2783 _dbus_cmutex_free_at_location (&connection->io_path_mutex);
2784 _dbus_cmutex_free_at_location (&connection->dispatch_mutex);
2786 _dbus_rmutex_free_at_location (&connection->slot_mutex);
2788 _dbus_rmutex_free_at_location (&connection->mutex);
2790 dbus_free (connection);
2794 * Decrements the reference count of a DBusConnection, and finalizes
2795 * it if the count reaches zero.
2797 * Note: it is a bug to drop the last reference to a connection that
2798 * is still connected.
2800 * For shared connections, libdbus will own a reference
2801 * as long as the connection is connected, so you can know that either
2802 * you don't have the last reference, or it's OK to drop the last reference.
2803 * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2804 * return shared connections.
2806 * For private connections, the creator of the connection must arrange for
2807 * dbus_connection_close() to be called prior to dropping the last reference.
2808 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2810 * @param connection the connection.
2813 dbus_connection_unref (DBusConnection *connection)
2815 dbus_int32_t old_refcount;
2817 _dbus_return_if_fail (connection != NULL);
2818 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2820 old_refcount = _dbus_atomic_dec (&connection->refcount);
2822 _dbus_connection_trace_ref (connection, old_refcount, old_refcount - 1,
2825 if (old_refcount == 1)
2827 #ifndef DBUS_DISABLE_CHECKS
2828 if (_dbus_transport_get_is_connected (connection->transport))
2830 _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",
2831 connection->shareable ?
2832 "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2833 "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2837 _dbus_connection_last_unref (connection);
2842 * Note that the transport can disconnect itself (other end drops us)
2843 * and in that case this function never runs. So this function must
2844 * not do anything more than disconnect the transport and update the
2847 * If the transport self-disconnects, then we assume someone will
2848 * dispatch the connection to cause the dispatch status update.
2851 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2853 DBusDispatchStatus status;
2855 HAVE_LOCK_CHECK (connection);
2857 _dbus_verbose ("Disconnecting %p\n", connection);
2859 /* We need to ref because update_dispatch_status_and_unlock will unref
2860 * the connection if it was shared and libdbus was the only remaining
2863 _dbus_connection_ref_unlocked (connection);
2865 _dbus_transport_disconnect (connection->transport);
2867 /* This has the side effect of queuing the disconnect message link
2868 * (unless we don't have enough memory, possibly, so don't assert it).
2869 * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2870 * should never again return the newly-disconnected connection.
2872 * However, we only unref the shared connection and exit_on_disconnect when
2873 * the disconnect message reaches the head of the message queue,
2874 * NOT when it's first queued.
2876 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2878 /* This calls out to user code */
2879 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2881 /* Could also call out to user code */
2882 dbus_connection_unref (connection);
2886 * Closes a private connection, so no further data can be sent or received.
2887 * This disconnects the transport (such as a socket) underlying the
2890 * Attempts to send messages after closing a connection are safe, but will result in
2891 * error replies generated locally in libdbus.
2893 * This function does not affect the connection's reference count. It's
2894 * safe to close a connection more than once; all calls after the
2895 * first do nothing. It's impossible to "reopen" a connection, a
2896 * new connection must be created. This function may result in a call
2897 * to the DBusDispatchStatusFunction set with
2898 * dbus_connection_set_dispatch_status_function(), as the disconnect
2899 * message it generates needs to be dispatched.
2901 * If a connection is dropped by the remote application, it will
2904 * You must close a connection prior to releasing the last reference to
2905 * the connection. If you dbus_connection_unref() for the last time
2906 * without closing the connection, the results are undefined; it
2907 * is a bug in your program and libdbus will try to print a warning.
2909 * You may not close a shared connection. Connections created with
2910 * dbus_connection_open() or dbus_bus_get() are shared.
2911 * These connections are owned by libdbus, and applications should
2912 * only unref them, never close them. Applications can know it is
2913 * safe to unref these connections because libdbus will be holding a
2914 * reference as long as the connection is open. Thus, either the
2915 * connection is closed and it is OK to drop the last reference,
2916 * or the connection is open and the app knows it does not have the
2919 * Connections created with dbus_connection_open_private() or
2920 * dbus_bus_get_private() are not kept track of or referenced by
2921 * libdbus. The creator of these connections is responsible for
2922 * calling dbus_connection_close() prior to releasing the last
2923 * reference, if the connection is not already disconnected.
2925 * @param connection the private (unshared) connection to close
2928 dbus_connection_close (DBusConnection *connection)
2930 _dbus_return_if_fail (connection != NULL);
2931 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2933 CONNECTION_LOCK (connection);
2935 #ifndef DBUS_DISABLE_CHECKS
2936 if (connection->shareable)
2938 CONNECTION_UNLOCK (connection);
2940 _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2945 _dbus_connection_close_possibly_shared_and_unlock (connection);
2949 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2951 HAVE_LOCK_CHECK (connection);
2952 return _dbus_transport_get_is_connected (connection->transport);
2956 * Gets whether the connection is currently open. A connection may
2957 * become disconnected when the remote application closes its end, or
2958 * exits; a connection may also be disconnected with
2959 * dbus_connection_close().
2961 * There are not separate states for "closed" and "disconnected," the two
2962 * terms are synonymous. This function should really be called
2963 * get_is_open() but for historical reasons is not.
2965 * @param connection the connection.
2966 * @returns #TRUE if the connection is still alive.
2969 dbus_connection_get_is_connected (DBusConnection *connection)
2973 _dbus_return_val_if_fail (connection != NULL, FALSE);
2975 CONNECTION_LOCK (connection);
2976 res = _dbus_connection_get_is_connected_unlocked (connection);
2977 CONNECTION_UNLOCK (connection);
2983 * Gets whether the connection was authenticated. (Note that
2984 * if the connection was authenticated then disconnected,
2985 * this function still returns #TRUE)
2987 * @param connection the connection
2988 * @returns #TRUE if the connection was ever authenticated
2991 dbus_connection_get_is_authenticated (DBusConnection *connection)
2995 _dbus_return_val_if_fail (connection != NULL, FALSE);
2997 CONNECTION_LOCK (connection);
2998 res = _dbus_transport_get_is_authenticated (connection->transport);
2999 CONNECTION_UNLOCK (connection);
3005 * Gets whether the connection is not authenticated as a specific
3006 * user. If the connection is not authenticated, this function
3007 * returns #TRUE, and if it is authenticated but as an anonymous user,
3008 * it returns #TRUE. If it is authenticated as a specific user, then
3009 * this returns #FALSE. (Note that if the connection was authenticated
3010 * as anonymous then disconnected, this function still returns #TRUE.)
3012 * If the connection is not anonymous, you can use
3013 * dbus_connection_get_unix_user() and
3014 * dbus_connection_get_windows_user() to see who it's authorized as.
3016 * If you want to prevent non-anonymous authorization, use
3017 * dbus_server_set_auth_mechanisms() to remove the mechanisms that
3018 * allow proving user identity (i.e. only allow the ANONYMOUS
3021 * @param connection the connection
3022 * @returns #TRUE if not authenticated or authenticated as anonymous
3025 dbus_connection_get_is_anonymous (DBusConnection *connection)
3029 _dbus_return_val_if_fail (connection != NULL, FALSE);
3031 CONNECTION_LOCK (connection);
3032 res = _dbus_transport_get_is_anonymous (connection->transport);
3033 CONNECTION_UNLOCK (connection);
3039 * Gets the ID of the server address we are authenticated to, if this
3040 * connection is on the client side. If the connection is on the
3041 * server side, this will always return #NULL - use dbus_server_get_id()
3042 * to get the ID of your own server, if you are the server side.
3044 * If a client-side connection is not authenticated yet, the ID may be
3045 * available if it was included in the server address, but may not be
3046 * available. The only way to be sure the server ID is available
3047 * is to wait for authentication to complete.
3049 * In general, each mode of connecting to a given server will have
3050 * its own ID. So for example, if the session bus daemon is listening
3051 * on UNIX domain sockets and on TCP, then each of those modalities
3052 * will have its own server ID.
3054 * If you want an ID that identifies an entire session bus, look at
3055 * dbus_bus_get_id() instead (which is just a convenience wrapper
3056 * around the org.freedesktop.DBus.GetId method invoked on the bus).
3058 * You can also get a machine ID; see dbus_get_local_machine_id() to
3059 * get the machine you are on. There isn't a convenience wrapper, but
3060 * you can invoke org.freedesktop.DBus.Peer.GetMachineId on any peer
3061 * to get the machine ID on the other end.
3063 * The D-Bus specification describes the server ID and other IDs in a
3066 * @param connection the connection
3067 * @returns the server ID or #NULL if no memory or the connection is server-side
3070 dbus_connection_get_server_id (DBusConnection *connection)
3074 _dbus_return_val_if_fail (connection != NULL, NULL);
3076 CONNECTION_LOCK (connection);
3077 id = _dbus_strdup (_dbus_transport_get_server_id (connection->transport));
3078 CONNECTION_UNLOCK (connection);
3084 * Tests whether a certain type can be send via the connection. This
3085 * will always return TRUE for all types, with the exception of
3086 * DBUS_TYPE_UNIX_FD. The function will return TRUE for
3087 * DBUS_TYPE_UNIX_FD only on systems that know Unix file descriptors
3088 * and can send them via the chosen transport and when the remote side
3091 * This function can be used to do runtime checking for types that
3092 * might be unknown to the specific D-Bus client implementation
3093 * version, i.e. it will return FALSE for all types this
3094 * implementation does not know, including invalid or reserved types.
3096 * @param connection the connection
3097 * @param type the type to check
3098 * @returns TRUE if the type may be send via the connection
3101 dbus_connection_can_send_type(DBusConnection *connection,
3104 _dbus_return_val_if_fail (connection != NULL, FALSE);
3106 if (!dbus_type_is_valid (type))
3109 if (type != DBUS_TYPE_UNIX_FD)
3112 #ifdef HAVE_UNIX_FD_PASSING
3116 CONNECTION_LOCK(connection);
3117 b = _dbus_transport_can_pass_unix_fd(connection->transport);
3118 CONNECTION_UNLOCK(connection);
3128 * Set whether _exit() should be called when the connection receives a
3129 * disconnect signal. The call to _exit() comes after any handlers for
3130 * the disconnect signal run; handlers can cancel the exit by calling
3133 * By default, exit_on_disconnect is #FALSE; but for message bus
3134 * connections returned from dbus_bus_get() it will be toggled on
3137 * @param connection the connection
3138 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
3141 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
3142 dbus_bool_t exit_on_disconnect)
3144 _dbus_return_if_fail (connection != NULL);
3146 CONNECTION_LOCK (connection);
3147 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
3148 CONNECTION_UNLOCK (connection);
3152 * Preallocates resources needed to send a message, allowing the message
3153 * to be sent without the possibility of memory allocation failure.
3154 * Allows apps to create a future guarantee that they can send
3155 * a message regardless of memory shortages.
3157 * @param connection the connection we're preallocating for.
3158 * @returns the preallocated resources, or #NULL
3160 DBusPreallocatedSend*
3161 dbus_connection_preallocate_send (DBusConnection *connection)
3163 DBusPreallocatedSend *preallocated;
3165 _dbus_return_val_if_fail (connection != NULL, NULL);
3167 CONNECTION_LOCK (connection);
3170 _dbus_connection_preallocate_send_unlocked (connection);
3172 CONNECTION_UNLOCK (connection);
3174 return preallocated;
3178 * Frees preallocated message-sending resources from
3179 * dbus_connection_preallocate_send(). Should only
3180 * be called if the preallocated resources are not used
3181 * to send a message.
3183 * @param connection the connection
3184 * @param preallocated the resources
3187 dbus_connection_free_preallocated_send (DBusConnection *connection,
3188 DBusPreallocatedSend *preallocated)
3190 _dbus_return_if_fail (connection != NULL);
3191 _dbus_return_if_fail (preallocated != NULL);
3192 _dbus_return_if_fail (connection == preallocated->connection);
3194 _dbus_list_free_link (preallocated->queue_link);
3195 _dbus_counter_unref (preallocated->counter_link->data);
3196 _dbus_list_free_link (preallocated->counter_link);
3197 dbus_free (preallocated);
3201 * Sends a message using preallocated resources. This function cannot fail.
3202 * It works identically to dbus_connection_send() in other respects.
3203 * Preallocated resources comes from dbus_connection_preallocate_send().
3204 * This function "consumes" the preallocated resources, they need not
3205 * be freed separately.
3207 * @param connection the connection
3208 * @param preallocated the preallocated resources
3209 * @param message the message to send
3210 * @param client_serial return location for client serial assigned to the message
3213 dbus_connection_send_preallocated (DBusConnection *connection,
3214 DBusPreallocatedSend *preallocated,
3215 DBusMessage *message,
3216 dbus_uint32_t *client_serial)
3218 _dbus_return_if_fail (connection != NULL);
3219 _dbus_return_if_fail (preallocated != NULL);
3220 _dbus_return_if_fail (message != NULL);
3221 _dbus_return_if_fail (preallocated->connection == connection);
3222 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3223 dbus_message_get_member (message) != NULL);
3224 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
3225 (dbus_message_get_interface (message) != NULL &&
3226 dbus_message_get_member (message) != NULL));
3228 CONNECTION_LOCK (connection);
3230 #ifdef HAVE_UNIX_FD_PASSING
3232 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3233 message->n_unix_fds > 0)
3235 /* Refuse to send fds on a connection that cannot handle
3236 them. Unfortunately we cannot return a proper error here, so
3237 the best we can is just return. */
3238 CONNECTION_UNLOCK (connection);
3244 _dbus_connection_send_preallocated_and_unlock (connection,
3246 message, client_serial);
3250 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
3251 DBusMessage *message,
3252 dbus_uint32_t *client_serial)
3254 DBusPreallocatedSend *preallocated;
3256 _dbus_assert (connection != NULL);
3257 _dbus_assert (message != NULL);
3259 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
3260 if (preallocated == NULL)
3263 _dbus_connection_send_preallocated_unlocked_no_update (connection,
3271 * Adds a message to the outgoing message queue. Does not block to
3272 * write the message to the network; that happens asynchronously. To
3273 * force the message to be written, call dbus_connection_flush() however
3274 * it is not necessary to call dbus_connection_flush() by hand; the
3275 * message will be sent the next time the main loop is run.
3276 * dbus_connection_flush() should only be used, for example, if
3277 * the application was expected to exit before running the main loop.
3279 * Because this only queues the message, the only reason it can
3280 * fail is lack of memory. Even if the connection is disconnected,
3281 * no error will be returned. If the function fails due to lack of memory,
3282 * it returns #FALSE. The function will never fail for other reasons; even
3283 * if the connection is disconnected, you can queue an outgoing message,
3284 * though obviously it won't be sent.
3286 * The message serial is used by the remote application to send a
3287 * reply; see dbus_message_get_serial() or the D-Bus specification.
3289 * dbus_message_unref() can be called as soon as this method returns
3290 * as the message queue will hold its own ref until the message is sent.
3292 * @param connection the connection.
3293 * @param message the message to write.
3294 * @param serial return location for message serial, or #NULL if you don't care
3295 * @returns #TRUE on success.
3298 dbus_connection_send (DBusConnection *connection,
3299 DBusMessage *message,
3300 dbus_uint32_t *serial)
3302 _dbus_return_val_if_fail (connection != NULL, FALSE);
3303 _dbus_return_val_if_fail (message != NULL, FALSE);
3305 CONNECTION_LOCK (connection);
3307 #ifdef HAVE_UNIX_FD_PASSING
3309 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3310 message->n_unix_fds > 0)
3312 /* Refuse to send fds on a connection that cannot handle
3313 them. Unfortunately we cannot return a proper error here, so
3314 the best we can is just return. */
3315 CONNECTION_UNLOCK (connection);
3321 return _dbus_connection_send_and_unlock (connection,
3327 reply_handler_timeout (void *data)
3329 DBusConnection *connection;
3330 DBusDispatchStatus status;
3331 DBusPendingCall *pending = data;
3333 connection = _dbus_pending_call_get_connection_and_lock (pending);
3334 _dbus_connection_ref_unlocked (connection);
3336 _dbus_pending_call_queue_timeout_error_unlocked (pending,
3338 _dbus_connection_remove_timeout_unlocked (connection,
3339 _dbus_pending_call_get_timeout_unlocked (pending));
3340 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
3342 _dbus_verbose ("middle\n");
3343 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3345 /* Unlocks, and calls out to user code */
3346 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3347 dbus_connection_unref (connection);
3353 * Queues a message to send, as with dbus_connection_send(),
3354 * but also returns a #DBusPendingCall used to receive a reply to the
3355 * message. If no reply is received in the given timeout_milliseconds,
3356 * this function expires the pending reply and generates a synthetic
3357 * error reply (generated in-process, not by the remote application)
3358 * indicating that a timeout occurred.
3360 * A #DBusPendingCall will see a reply message before any filters or
3361 * registered object path handlers. See dbus_connection_dispatch() for
3362 * details on when handlers are run.
3364 * A #DBusPendingCall will always see exactly one reply message,
3365 * unless it's cancelled with dbus_pending_call_cancel().
3367 * If #NULL is passed for the pending_return, the #DBusPendingCall
3368 * will still be generated internally, and used to track
3369 * the message reply timeout. This means a timeout error will
3370 * occur if no reply arrives, unlike with dbus_connection_send().
3372 * If -1 is passed for the timeout, a sane default timeout is used. -1
3373 * is typically the best value for the timeout for this reason, unless
3374 * you want a very short or very long timeout. If #DBUS_TIMEOUT_INFINITE is
3375 * passed for the timeout, no timeout will be set and the call will block
3378 * @warning if the connection is disconnected or you try to send Unix
3379 * file descriptors on a connection that does not support them, the
3380 * #DBusPendingCall will be set to #NULL, so be careful with this.
3382 * @param connection the connection
3383 * @param message the message to send
3384 * @param pending_return return location for a #DBusPendingCall
3385 * object, or #NULL if connection is disconnected or when you try to
3386 * send Unix file descriptors on a connection that does not support
3388 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3389 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3391 * @returns #FALSE if no memory, #TRUE otherwise.
3395 dbus_connection_send_with_reply (DBusConnection *connection,
3396 DBusMessage *message,
3397 DBusPendingCall **pending_return,
3398 int timeout_milliseconds)
3400 DBusPendingCall *pending;
3401 dbus_int32_t serial = -1;
3402 DBusDispatchStatus status;
3404 _dbus_return_val_if_fail (connection != NULL, FALSE);
3405 _dbus_return_val_if_fail (message != NULL, FALSE);
3406 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3409 *pending_return = NULL;
3411 CONNECTION_LOCK (connection);
3413 #ifdef HAVE_UNIX_FD_PASSING
3415 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3416 message->n_unix_fds > 0)
3418 /* Refuse to send fds on a connection that cannot handle
3419 them. Unfortunately we cannot return a proper error here, so
3420 the best we can do is return TRUE but leave *pending_return
3422 CONNECTION_UNLOCK (connection);
3428 if (!_dbus_connection_get_is_connected_unlocked (connection))
3430 CONNECTION_UNLOCK (connection);
3435 pending = _dbus_pending_call_new_unlocked (connection,
3436 timeout_milliseconds,
3437 reply_handler_timeout);
3439 if (pending == NULL)
3441 CONNECTION_UNLOCK (connection);
3445 /* Assign a serial to the message */
3446 serial = dbus_message_get_serial (message);
3449 serial = _dbus_connection_get_next_client_serial (connection);
3450 dbus_message_set_serial (message, serial);
3453 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3456 /* Insert the serial in the pending replies hash;
3457 * hash takes a refcount on DBusPendingCall.
3458 * Also, add the timeout.
3460 if (!_dbus_connection_attach_pending_call_unlocked (connection,
3464 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3466 _dbus_connection_detach_pending_call_and_unlock (connection,
3468 goto error_unlocked;
3472 *pending_return = pending; /* hand off refcount */
3475 _dbus_connection_detach_pending_call_unlocked (connection, pending);
3476 /* we still have a ref to the pending call in this case, we unref
3477 * after unlocking, below
3481 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3483 /* this calls out to user code */
3484 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3486 if (pending_return == NULL)
3487 dbus_pending_call_unref (pending);
3492 CONNECTION_UNLOCK (connection);
3494 dbus_pending_call_unref (pending);
3499 * Sends a message and blocks a certain time period while waiting for
3500 * a reply. This function does not reenter the main loop,
3501 * i.e. messages other than the reply are queued up but not
3502 * processed. This function is used to invoke method calls on a
3505 * If a normal reply is received, it is returned, and removed from the
3506 * incoming message queue. If it is not received, #NULL is returned
3507 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3508 * received, it is converted to a #DBusError and returned as an error,
3509 * then the reply message is deleted and #NULL is returned. If
3510 * something else goes wrong, result is set to whatever is
3511 * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3512 * #DBUS_ERROR_DISCONNECTED.
3514 * @warning While this function blocks the calling thread will not be
3515 * processing the incoming message queue. This means you can end up
3516 * deadlocked if the application you're talking to needs you to reply
3517 * to a method. To solve this, either avoid the situation, block in a
3518 * separate thread from the main connection-dispatching thread, or use
3519 * dbus_pending_call_set_notify() to avoid blocking.
3521 * @param connection the connection
3522 * @param message the message to send
3523 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3524 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3526 * @param error return location for error message
3527 * @returns the message that is the reply or #NULL with an error code if the
3531 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3532 DBusMessage *message,
3533 int timeout_milliseconds,
3537 DBusPendingCall *pending;
3539 _dbus_return_val_if_fail (connection != NULL, NULL);
3540 _dbus_return_val_if_fail (message != NULL, NULL);
3541 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3542 _dbus_return_val_if_error_is_set (error, NULL);
3544 #ifdef HAVE_UNIX_FD_PASSING
3546 CONNECTION_LOCK (connection);
3547 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3548 message->n_unix_fds > 0)
3550 CONNECTION_UNLOCK (connection);
3551 dbus_set_error(error, DBUS_ERROR_FAILED, "Cannot send file descriptors on this connection.");
3554 CONNECTION_UNLOCK (connection);
3558 if (!dbus_connection_send_with_reply (connection, message,
3559 &pending, timeout_milliseconds))
3561 _DBUS_SET_OOM (error);
3565 if (pending == NULL)
3567 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3571 dbus_pending_call_block (pending);
3573 reply = dbus_pending_call_steal_reply (pending);
3574 dbus_pending_call_unref (pending);
3576 /* call_complete_and_unlock() called from pending_call_block() should
3577 * always fill this in.
3579 _dbus_assert (reply != NULL);
3581 if (dbus_set_error_from_message (error, reply))
3583 dbus_message_unref (reply);
3591 * Blocks until the outgoing message queue is empty.
3592 * Assumes connection lock already held.
3594 * If you call this, you MUST call update_dispatch_status afterword...
3596 * @param connection the connection.
3598 static DBusDispatchStatus
3599 _dbus_connection_flush_unlocked (DBusConnection *connection)
3601 /* We have to specify DBUS_ITERATION_DO_READING here because
3602 * otherwise we could have two apps deadlock if they are both doing
3603 * a flush(), and the kernel buffers fill up. This could change the
3606 DBusDispatchStatus status;
3608 HAVE_LOCK_CHECK (connection);
3610 while (connection->n_outgoing > 0 &&
3611 _dbus_connection_get_is_connected_unlocked (connection))
3613 _dbus_verbose ("doing iteration in\n");
3614 HAVE_LOCK_CHECK (connection);
3615 _dbus_connection_do_iteration_unlocked (connection,
3617 DBUS_ITERATION_DO_READING |
3618 DBUS_ITERATION_DO_WRITING |
3619 DBUS_ITERATION_BLOCK,
3623 HAVE_LOCK_CHECK (connection);
3624 _dbus_verbose ("middle\n");
3625 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3627 HAVE_LOCK_CHECK (connection);
3632 * Blocks until the outgoing message queue is empty.
3634 * @param connection the connection.
3637 dbus_connection_flush (DBusConnection *connection)
3639 /* We have to specify DBUS_ITERATION_DO_READING here because
3640 * otherwise we could have two apps deadlock if they are both doing
3641 * a flush(), and the kernel buffers fill up. This could change the
3644 DBusDispatchStatus status;
3646 _dbus_return_if_fail (connection != NULL);
3648 CONNECTION_LOCK (connection);
3650 status = _dbus_connection_flush_unlocked (connection);
3652 HAVE_LOCK_CHECK (connection);
3653 /* Unlocks and calls out to user code */
3654 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3656 _dbus_verbose ("end\n");
3660 * This function implements dbus_connection_read_write_dispatch() and
3661 * dbus_connection_read_write() (they pass a different value for the
3662 * dispatch parameter).
3664 * @param connection the connection
3665 * @param timeout_milliseconds max time to block or -1 for infinite
3666 * @param dispatch dispatch new messages or leave them on the incoming queue
3667 * @returns #TRUE if the disconnect message has not been processed
3670 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3671 int timeout_milliseconds,
3672 dbus_bool_t dispatch)
3674 DBusDispatchStatus dstatus;
3675 dbus_bool_t progress_possible;
3677 /* Need to grab a ref here in case we're a private connection and
3678 * the user drops the last ref in a handler we call; see bug
3679 * https://bugs.freedesktop.org/show_bug.cgi?id=15635
3681 dbus_connection_ref (connection);
3682 dstatus = dbus_connection_get_dispatch_status (connection);
3684 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3686 _dbus_verbose ("doing dispatch\n");
3687 dbus_connection_dispatch (connection);
3688 CONNECTION_LOCK (connection);
3690 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3692 _dbus_verbose ("pausing for memory\n");
3693 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3694 CONNECTION_LOCK (connection);
3698 CONNECTION_LOCK (connection);
3699 if (_dbus_connection_get_is_connected_unlocked (connection))
3701 _dbus_verbose ("doing iteration\n");
3702 _dbus_connection_do_iteration_unlocked (connection,
3704 DBUS_ITERATION_DO_READING |
3705 DBUS_ITERATION_DO_WRITING |
3706 DBUS_ITERATION_BLOCK,
3707 timeout_milliseconds);
3711 HAVE_LOCK_CHECK (connection);
3712 /* If we can dispatch, we can make progress until the Disconnected message
3713 * has been processed; if we can only read/write, we can make progress
3714 * as long as the transport is open.
3717 progress_possible = connection->n_incoming != 0 ||
3718 connection->disconnect_message_link != NULL;
3720 progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3722 CONNECTION_UNLOCK (connection);
3724 dbus_connection_unref (connection);
3726 return progress_possible; /* TRUE if we can make more progress */
3731 * This function is intended for use with applications that don't want
3732 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3733 * example usage would be:
3736 * while (dbus_connection_read_write_dispatch (connection, -1))
3737 * ; // empty loop body
3740 * In this usage you would normally have set up a filter function to look
3741 * at each message as it is dispatched. The loop terminates when the last
3742 * message from the connection (the disconnected signal) is processed.
3744 * If there are messages to dispatch, this function will
3745 * dbus_connection_dispatch() once, and return. If there are no
3746 * messages to dispatch, this function will block until it can read or
3747 * write, then read or write, then return.
3749 * The way to think of this function is that it either makes some sort
3750 * of progress, or it blocks. Note that, while it is blocked on I/O, it
3751 * cannot be interrupted (even by other threads), which makes this function
3752 * unsuitable for applications that do more than just react to received
3755 * The return value indicates whether the disconnect message has been
3756 * processed, NOT whether the connection is connected. This is
3757 * important because even after disconnecting, you want to process any
3758 * messages you received prior to the disconnect.
3760 * @param connection the connection
3761 * @param timeout_milliseconds max time to block or -1 for infinite
3762 * @returns #TRUE if the disconnect message has not been processed
3765 dbus_connection_read_write_dispatch (DBusConnection *connection,
3766 int timeout_milliseconds)
3768 _dbus_return_val_if_fail (connection != NULL, FALSE);
3769 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3770 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3774 * This function is intended for use with applications that don't want to
3775 * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3776 * dbus_connection_read_write_dispatch().
3778 * As long as the connection is open, this function will block until it can
3779 * read or write, then read or write, then return #TRUE.
3781 * If the connection is closed, the function returns #FALSE.
3783 * The return value indicates whether reading or writing is still
3784 * possible, i.e. whether the connection is connected.
3786 * Note that even after disconnection, messages may remain in the
3787 * incoming queue that need to be
3788 * processed. dbus_connection_read_write_dispatch() dispatches
3789 * incoming messages for you; with dbus_connection_read_write() you
3790 * have to arrange to drain the incoming queue yourself.
3792 * @param connection the connection
3793 * @param timeout_milliseconds max time to block or -1 for infinite
3794 * @returns #TRUE if still connected
3797 dbus_connection_read_write (DBusConnection *connection,
3798 int timeout_milliseconds)
3800 _dbus_return_val_if_fail (connection != NULL, FALSE);
3801 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3802 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3805 /* We need to call this anytime we pop the head of the queue, and then
3806 * update_dispatch_status_and_unlock needs to be called afterward
3807 * which will "process" the disconnected message and set
3808 * disconnected_message_processed.
3811 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3812 DBusMessage *head_of_queue)
3814 HAVE_LOCK_CHECK (connection);
3816 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3817 if (connection->disconnect_message_link == NULL &&
3818 dbus_message_is_signal (head_of_queue,
3819 DBUS_INTERFACE_LOCAL,
3822 connection->disconnected_message_arrived = TRUE;
3827 * Returns the first-received message from the incoming message queue,
3828 * leaving it in the queue. If the queue is empty, returns #NULL.
3830 * The caller does not own a reference to the returned message, and
3831 * must either return it using dbus_connection_return_message() or
3832 * keep it after calling dbus_connection_steal_borrowed_message(). No
3833 * one can get at the message while its borrowed, so return it as
3834 * quickly as possible and don't keep a reference to it after
3835 * returning it. If you need to keep the message, make a copy of it.
3837 * dbus_connection_dispatch() will block if called while a borrowed
3838 * message is outstanding; only one piece of code can be playing with
3839 * the incoming queue at a time. This function will block if called
3840 * during a dbus_connection_dispatch().
3842 * @param connection the connection.
3843 * @returns next message in the incoming queue.
3846 dbus_connection_borrow_message (DBusConnection *connection)
3848 DBusDispatchStatus status;
3849 DBusMessage *message;
3851 _dbus_return_val_if_fail (connection != NULL, NULL);
3853 _dbus_verbose ("start\n");
3855 /* this is called for the side effect that it queues
3856 * up any messages from the transport
3858 status = dbus_connection_get_dispatch_status (connection);
3859 if (status != DBUS_DISPATCH_DATA_REMAINS)
3862 CONNECTION_LOCK (connection);
3864 _dbus_connection_acquire_dispatch (connection);
3866 /* While a message is outstanding, the dispatch lock is held */
3867 _dbus_assert (connection->message_borrowed == NULL);
3869 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3871 message = connection->message_borrowed;
3873 check_disconnected_message_arrived_unlocked (connection, message);
3875 /* Note that we KEEP the dispatch lock until the message is returned */
3876 if (message == NULL)
3877 _dbus_connection_release_dispatch (connection);
3879 CONNECTION_UNLOCK (connection);
3881 _dbus_message_trace_ref (message, -1, -1, "dbus_connection_borrow_message");
3883 /* We don't update dispatch status until it's returned or stolen */
3889 * Used to return a message after peeking at it using
3890 * dbus_connection_borrow_message(). Only called if
3891 * message from dbus_connection_borrow_message() was non-#NULL.
3893 * @param connection the connection
3894 * @param message the message from dbus_connection_borrow_message()
3897 dbus_connection_return_message (DBusConnection *connection,
3898 DBusMessage *message)
3900 DBusDispatchStatus status;
3902 _dbus_return_if_fail (connection != NULL);
3903 _dbus_return_if_fail (message != NULL);
3904 _dbus_return_if_fail (message == connection->message_borrowed);
3905 _dbus_return_if_fail (connection->dispatch_acquired);
3907 CONNECTION_LOCK (connection);
3909 _dbus_assert (message == connection->message_borrowed);
3911 connection->message_borrowed = NULL;
3913 _dbus_connection_release_dispatch (connection);
3915 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3916 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3918 _dbus_message_trace_ref (message, -1, -1, "dbus_connection_return_message");
3922 * Used to keep a message after peeking at it using
3923 * dbus_connection_borrow_message(). Before using this function, see
3924 * the caveats/warnings in the documentation for
3925 * dbus_connection_pop_message().
3927 * @param connection the connection
3928 * @param message the message from dbus_connection_borrow_message()
3931 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3932 DBusMessage *message)
3934 DBusMessage *pop_message;
3935 DBusDispatchStatus status;
3937 _dbus_return_if_fail (connection != NULL);
3938 _dbus_return_if_fail (message != NULL);
3939 _dbus_return_if_fail (message == connection->message_borrowed);
3940 _dbus_return_if_fail (connection->dispatch_acquired);
3942 CONNECTION_LOCK (connection);
3944 _dbus_assert (message == connection->message_borrowed);
3946 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3947 _dbus_assert (message == pop_message);
3948 (void) pop_message; /* unused unless asserting */
3950 connection->n_incoming -= 1;
3952 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3953 message, connection->n_incoming);
3955 connection->message_borrowed = NULL;
3957 _dbus_connection_release_dispatch (connection);
3959 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3960 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3961 _dbus_message_trace_ref (message, -1, -1,
3962 "dbus_connection_steal_borrowed_message");
3965 /* See dbus_connection_pop_message, but requires the caller to own
3966 * the lock before calling. May drop the lock while running.
3969 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3971 HAVE_LOCK_CHECK (connection);
3973 _dbus_assert (connection->message_borrowed == NULL);
3975 if (connection->n_incoming > 0)
3979 link = _dbus_list_pop_first_link (&connection->incoming_messages);
3980 connection->n_incoming -= 1;
3982 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from incoming queue %p, %d incoming\n",
3984 dbus_message_type_to_string (dbus_message_get_type (link->data)),
3985 dbus_message_get_path (link->data) ?
3986 dbus_message_get_path (link->data) :
3988 dbus_message_get_interface (link->data) ?
3989 dbus_message_get_interface (link->data) :
3991 dbus_message_get_member (link->data) ?
3992 dbus_message_get_member (link->data) :
3994 dbus_message_get_signature (link->data),
3995 connection, connection->n_incoming);
3997 _dbus_message_trace_ref (link->data, -1, -1,
3998 "_dbus_connection_pop_message_link_unlocked");
4000 check_disconnected_message_arrived_unlocked (connection, link->data);
4008 /* See dbus_connection_pop_message, but requires the caller to own
4009 * the lock before calling. May drop the lock while running.
4012 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
4016 HAVE_LOCK_CHECK (connection);
4018 link = _dbus_connection_pop_message_link_unlocked (connection);
4022 DBusMessage *message;
4024 message = link->data;
4026 _dbus_list_free_link (link);
4035 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
4036 DBusList *message_link)
4038 HAVE_LOCK_CHECK (connection);
4040 _dbus_assert (message_link != NULL);
4041 /* You can't borrow a message while a link is outstanding */
4042 _dbus_assert (connection->message_borrowed == NULL);
4043 /* We had to have the dispatch lock across the pop/putback */
4044 _dbus_assert (connection->dispatch_acquired);
4046 _dbus_list_prepend_link (&connection->incoming_messages,
4048 connection->n_incoming += 1;
4050 _dbus_verbose ("Message %p (%s %s %s '%s') put back into queue %p, %d incoming\n",
4052 dbus_message_type_to_string (dbus_message_get_type (message_link->data)),
4053 dbus_message_get_interface (message_link->data) ?
4054 dbus_message_get_interface (message_link->data) :
4056 dbus_message_get_member (message_link->data) ?
4057 dbus_message_get_member (message_link->data) :
4059 dbus_message_get_signature (message_link->data),
4060 connection, connection->n_incoming);
4062 _dbus_message_trace_ref (message_link->data, -1, -1,
4063 "_dbus_connection_putback_message_link_unlocked");
4067 * Returns the first-received message from the incoming message queue,
4068 * removing it from the queue. The caller owns a reference to the
4069 * returned message. If the queue is empty, returns #NULL.
4071 * This function bypasses any message handlers that are registered,
4072 * and so using it is usually wrong. Instead, let the main loop invoke
4073 * dbus_connection_dispatch(). Popping messages manually is only
4074 * useful in very simple programs that don't share a #DBusConnection
4075 * with any libraries or other modules.
4077 * There is a lock that covers all ways of accessing the incoming message
4078 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
4079 * dbus_connection_borrow_message(), etc. will all block while one of the others
4080 * in the group is running.
4082 * @param connection the connection.
4083 * @returns next message in the incoming queue.
4086 dbus_connection_pop_message (DBusConnection *connection)
4088 DBusMessage *message;
4089 DBusDispatchStatus status;
4091 _dbus_verbose ("start\n");
4093 /* this is called for the side effect that it queues
4094 * up any messages from the transport
4096 status = dbus_connection_get_dispatch_status (connection);
4097 if (status != DBUS_DISPATCH_DATA_REMAINS)
4100 CONNECTION_LOCK (connection);
4101 _dbus_connection_acquire_dispatch (connection);
4102 HAVE_LOCK_CHECK (connection);
4104 message = _dbus_connection_pop_message_unlocked (connection);
4106 _dbus_verbose ("Returning popped message %p\n", message);
4108 _dbus_connection_release_dispatch (connection);
4110 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4111 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4117 * Acquire the dispatcher. This is a separate lock so the main
4118 * connection lock can be dropped to call out to application dispatch
4121 * @param connection the connection.
4124 _dbus_connection_acquire_dispatch (DBusConnection *connection)
4126 HAVE_LOCK_CHECK (connection);
4128 _dbus_connection_ref_unlocked (connection);
4129 CONNECTION_UNLOCK (connection);
4131 _dbus_verbose ("locking dispatch_mutex\n");
4132 _dbus_cmutex_lock (connection->dispatch_mutex);
4134 while (connection->dispatch_acquired)
4136 _dbus_verbose ("waiting for dispatch to be acquirable\n");
4137 _dbus_condvar_wait (connection->dispatch_cond,
4138 connection->dispatch_mutex);
4141 _dbus_assert (!connection->dispatch_acquired);
4143 connection->dispatch_acquired = TRUE;
4145 _dbus_verbose ("unlocking dispatch_mutex\n");
4146 _dbus_cmutex_unlock (connection->dispatch_mutex);
4148 CONNECTION_LOCK (connection);
4149 _dbus_connection_unref_unlocked (connection);
4153 * Release the dispatcher when you're done with it. Only call
4154 * after you've acquired the dispatcher. Wakes up at most one
4155 * thread currently waiting to acquire the dispatcher.
4157 * @param connection the connection.
4160 _dbus_connection_release_dispatch (DBusConnection *connection)
4162 HAVE_LOCK_CHECK (connection);
4164 _dbus_verbose ("locking dispatch_mutex\n");
4165 _dbus_cmutex_lock (connection->dispatch_mutex);
4167 _dbus_assert (connection->dispatch_acquired);
4169 connection->dispatch_acquired = FALSE;
4170 _dbus_condvar_wake_one (connection->dispatch_cond);
4172 _dbus_verbose ("unlocking dispatch_mutex\n");
4173 _dbus_cmutex_unlock (connection->dispatch_mutex);
4177 _dbus_connection_failed_pop (DBusConnection *connection,
4178 DBusList *message_link)
4180 _dbus_list_prepend_link (&connection->incoming_messages,
4182 connection->n_incoming += 1;
4185 /* Note this may be called multiple times since we don't track whether we already did it */
4187 notify_disconnected_unlocked (DBusConnection *connection)
4189 HAVE_LOCK_CHECK (connection);
4191 /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
4192 * connection from dbus_bus_get(). We make the same guarantee for
4193 * dbus_connection_open() but in a different way since we don't want to
4194 * unref right here; we instead check for connectedness before returning
4195 * the connection from the hash.
4197 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
4199 /* Dump the outgoing queue, we aren't going to be able to
4200 * send it now, and we'd like accessors like
4201 * dbus_connection_get_outgoing_size() to be accurate.
4203 if (connection->n_outgoing > 0)
4207 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
4208 connection->n_outgoing);
4210 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
4212 _dbus_connection_message_sent_unlocked (connection, link->data);
4217 /* Note this may be called multiple times since we don't track whether we already did it */
4218 static DBusDispatchStatus
4219 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
4221 HAVE_LOCK_CHECK (connection);
4223 if (connection->disconnect_message_link != NULL)
4225 _dbus_verbose ("Sending disconnect message\n");
4227 /* If we have pending calls, queue their timeouts - we want the Disconnected
4228 * to be the last message, after these timeouts.
4230 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
4232 /* We haven't sent the disconnect message already,
4233 * and all real messages have been queued up.
4235 _dbus_connection_queue_synthesized_message_link (connection,
4236 connection->disconnect_message_link);
4237 connection->disconnect_message_link = NULL;
4239 return DBUS_DISPATCH_DATA_REMAINS;
4242 return DBUS_DISPATCH_COMPLETE;
4245 static DBusDispatchStatus
4246 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
4248 HAVE_LOCK_CHECK (connection);
4250 if (connection->n_incoming > 0)
4251 return DBUS_DISPATCH_DATA_REMAINS;
4252 else if (!_dbus_transport_queue_messages (connection->transport))
4253 return DBUS_DISPATCH_NEED_MEMORY;
4256 DBusDispatchStatus status;
4257 dbus_bool_t is_connected;
4259 status = _dbus_transport_get_dispatch_status (connection->transport);
4260 is_connected = _dbus_transport_get_is_connected (connection->transport);
4262 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
4263 DISPATCH_STATUS_NAME (status), is_connected);
4267 /* It's possible this would be better done by having an explicit
4268 * notification from _dbus_transport_disconnect() that would
4269 * synchronously do this, instead of waiting for the next dispatch
4270 * status check. However, probably not good to change until it causes
4273 notify_disconnected_unlocked (connection);
4275 /* I'm not sure this is needed; the idea is that we want to
4276 * queue the Disconnected only after we've read all the
4277 * messages, but if we're disconnected maybe we are guaranteed
4278 * to have read them all ?
4280 if (status == DBUS_DISPATCH_COMPLETE)
4281 status = notify_disconnected_and_dispatch_complete_unlocked (connection);
4284 if (status != DBUS_DISPATCH_COMPLETE)
4286 else if (connection->n_incoming > 0)
4287 return DBUS_DISPATCH_DATA_REMAINS;
4289 return DBUS_DISPATCH_COMPLETE;
4294 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
4295 DBusDispatchStatus new_status)
4297 dbus_bool_t changed;
4298 DBusDispatchStatusFunction function;
4301 HAVE_LOCK_CHECK (connection);
4303 _dbus_connection_ref_unlocked (connection);
4305 changed = new_status != connection->last_dispatch_status;
4307 connection->last_dispatch_status = new_status;
4309 function = connection->dispatch_status_function;
4310 data = connection->dispatch_status_data;
4312 if (connection->disconnected_message_arrived &&
4313 !connection->disconnected_message_processed)
4315 connection->disconnected_message_processed = TRUE;
4317 /* this does an unref, but we have a ref
4318 * so we should not run the finalizer here
4321 connection_forget_shared_unlocked (connection);
4323 if (connection->exit_on_disconnect)
4325 CONNECTION_UNLOCK (connection);
4327 _dbus_verbose ("Exiting on Disconnected signal\n");
4329 _dbus_assert_not_reached ("Call to exit() returned");
4333 /* We drop the lock */
4334 CONNECTION_UNLOCK (connection);
4336 if (changed && function)
4338 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
4339 connection, new_status,
4340 DISPATCH_STATUS_NAME (new_status));
4341 (* function) (connection, new_status, data);
4344 dbus_connection_unref (connection);
4348 * Gets the current state of the incoming message queue.
4349 * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
4350 * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
4351 * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
4352 * there could be data, but we can't know for sure without more
4355 * To process the incoming message queue, use dbus_connection_dispatch()
4356 * or (in rare cases) dbus_connection_pop_message().
4358 * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
4359 * have messages in the queue, or we have raw bytes buffered up
4360 * that need to be parsed. When these bytes are parsed, they
4361 * may not add up to an entire message. Thus, it's possible
4362 * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
4363 * have a message yet.
4365 * In particular this happens on initial connection, because all sorts
4366 * of authentication protocol stuff has to be parsed before the
4367 * first message arrives.
4369 * @param connection the connection.
4370 * @returns current dispatch status
4373 dbus_connection_get_dispatch_status (DBusConnection *connection)
4375 DBusDispatchStatus status;
4377 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4379 _dbus_verbose ("start\n");
4381 CONNECTION_LOCK (connection);
4383 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4385 CONNECTION_UNLOCK (connection);
4391 * Filter funtion for handling the Peer standard interface.
4393 static DBusHandlerResult
4394 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
4395 DBusMessage *message)
4397 dbus_bool_t sent = FALSE;
4398 DBusMessage *ret = NULL;
4399 DBusList *expire_link;
4401 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
4403 /* This means we're letting the bus route this message */
4404 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4407 if (!dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4409 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4412 /* Preallocate a linked-list link, so that if we need to dispose of a
4413 * message, we can attach it to the expired list */
4414 expire_link = _dbus_list_alloc_link (NULL);
4417 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4419 if (dbus_message_is_method_call (message,
4420 DBUS_INTERFACE_PEER,
4423 ret = dbus_message_new_method_return (message);
4427 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4429 else if (dbus_message_is_method_call (message,
4430 DBUS_INTERFACE_PEER,
4435 ret = dbus_message_new_method_return (message);
4439 _dbus_string_init (&uuid);
4440 if (_dbus_get_local_machine_uuid_encoded (&uuid))
4442 const char *v_STRING = _dbus_string_get_const_data (&uuid);
4443 if (dbus_message_append_args (ret,
4444 DBUS_TYPE_STRING, &v_STRING,
4447 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4450 _dbus_string_free (&uuid);
4454 /* We need to bounce anything else with this interface, otherwise apps
4455 * could start extending the interface and when we added extensions
4456 * here to DBusConnection we'd break those apps.
4458 ret = dbus_message_new_error (message,
4459 DBUS_ERROR_UNKNOWN_METHOD,
4460 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4464 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4470 _dbus_list_free_link (expire_link);
4474 /* It'll be safe to unref the reply when we unlock */
4475 expire_link->data = ret;
4476 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4480 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4482 return DBUS_HANDLER_RESULT_HANDLED;
4486 * Processes all builtin filter functions
4488 * If the spec specifies a standard interface
4489 * they should be processed from this method
4491 static DBusHandlerResult
4492 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4493 DBusMessage *message)
4495 /* We just run one filter for now but have the option to run more
4496 if the spec calls for it in the future */
4498 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4502 * Processes any incoming data.
4504 * If there's incoming raw data that has not yet been parsed, it is
4505 * parsed, which may or may not result in adding messages to the
4508 * The incoming data buffer is filled when the connection reads from
4509 * its underlying transport (such as a socket). Reading usually
4510 * happens in dbus_watch_handle() or dbus_connection_read_write().
4512 * If there are complete messages in the incoming queue,
4513 * dbus_connection_dispatch() removes one message from the queue and
4514 * processes it. Processing has three steps.
4516 * First, any method replies are passed to #DBusPendingCall or
4517 * dbus_connection_send_with_reply_and_block() in order to
4518 * complete the pending method call.
4520 * Second, any filters registered with dbus_connection_add_filter()
4521 * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4522 * then processing stops after that filter.
4524 * Third, if the message is a method call it is forwarded to
4525 * any registered object path handlers added with
4526 * dbus_connection_register_object_path() or
4527 * dbus_connection_register_fallback().
4529 * A single call to dbus_connection_dispatch() will process at most
4530 * one message; it will not clear the entire message queue.
4532 * Be careful about calling dbus_connection_dispatch() from inside a
4533 * message handler, i.e. calling dbus_connection_dispatch()
4534 * recursively. If threads have been initialized with a recursive
4535 * mutex function, then this will not deadlock; however, it can
4536 * certainly confuse your application.
4538 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4540 * @param connection the connection
4541 * @returns dispatch status, see dbus_connection_get_dispatch_status()
4544 dbus_connection_dispatch (DBusConnection *connection)
4546 DBusMessage *message;
4547 DBusList *link, *filter_list_copy, *message_link;
4548 DBusHandlerResult result;
4549 DBusPendingCall *pending;
4550 dbus_int32_t reply_serial;
4551 DBusDispatchStatus status;
4552 dbus_bool_t found_object;
4554 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4556 _dbus_verbose ("\n");
4558 CONNECTION_LOCK (connection);
4559 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4560 if (status != DBUS_DISPATCH_DATA_REMAINS)
4562 /* unlocks and calls out to user code */
4563 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4567 /* We need to ref the connection since the callback could potentially
4568 * drop the last ref to it
4570 _dbus_connection_ref_unlocked (connection);
4572 _dbus_connection_acquire_dispatch (connection);
4573 HAVE_LOCK_CHECK (connection);
4575 message_link = _dbus_connection_pop_message_link_unlocked (connection);
4576 if (message_link == NULL)
4578 /* another thread dispatched our stuff */
4580 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4582 _dbus_connection_release_dispatch (connection);
4584 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4586 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4588 dbus_connection_unref (connection);
4593 message = message_link->data;
4595 _dbus_verbose (" dispatching message %p (%s %s %s '%s')\n",
4597 dbus_message_type_to_string (dbus_message_get_type (message)),
4598 dbus_message_get_interface (message) ?
4599 dbus_message_get_interface (message) :
4601 dbus_message_get_member (message) ?
4602 dbus_message_get_member (message) :
4604 dbus_message_get_signature (message));
4606 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4608 /* Pending call handling must be first, because if you do
4609 * dbus_connection_send_with_reply_and_block() or
4610 * dbus_pending_call_block() then no handlers/filters will be run on
4611 * the reply. We want consistent semantics in the case where we
4612 * dbus_connection_dispatch() the reply.
4615 reply_serial = dbus_message_get_reply_serial (message);
4616 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4620 _dbus_verbose ("Dispatching a pending reply\n");
4621 complete_pending_call_and_unlock (connection, pending, message);
4622 pending = NULL; /* it's probably unref'd */
4624 CONNECTION_LOCK (connection);
4625 _dbus_verbose ("pending call completed in dispatch\n");
4626 result = DBUS_HANDLER_RESULT_HANDLED;
4630 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4631 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4634 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4636 _dbus_connection_release_dispatch (connection);
4637 HAVE_LOCK_CHECK (connection);
4639 _dbus_connection_failed_pop (connection, message_link);
4641 /* unlocks and calls user code */
4642 _dbus_connection_update_dispatch_status_and_unlock (connection,
4643 DBUS_DISPATCH_NEED_MEMORY);
4644 dbus_connection_unref (connection);
4646 return DBUS_DISPATCH_NEED_MEMORY;
4649 _dbus_list_foreach (&filter_list_copy,
4650 (DBusForeachFunction)_dbus_message_filter_ref,
4653 /* We're still protected from dispatch() reentrancy here
4654 * since we acquired the dispatcher
4656 CONNECTION_UNLOCK (connection);
4658 link = _dbus_list_get_first_link (&filter_list_copy);
4659 while (link != NULL)
4661 DBusMessageFilter *filter = link->data;
4662 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4664 if (filter->function == NULL)
4666 _dbus_verbose (" filter was removed in a callback function\n");
4671 _dbus_verbose (" running filter on message %p\n", message);
4672 result = (* filter->function) (connection, message, filter->user_data);
4674 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4680 _dbus_list_foreach (&filter_list_copy,
4681 (DBusForeachFunction)_dbus_message_filter_unref,
4683 _dbus_list_clear (&filter_list_copy);
4685 CONNECTION_LOCK (connection);
4687 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4689 _dbus_verbose ("No memory\n");
4692 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4694 _dbus_verbose ("filter handled message in dispatch\n");
4698 /* We're still protected from dispatch() reentrancy here
4699 * since we acquired the dispatcher
4701 _dbus_verbose (" running object path dispatch on message %p (%s %s %s '%s')\n",
4703 dbus_message_type_to_string (dbus_message_get_type (message)),
4704 dbus_message_get_interface (message) ?
4705 dbus_message_get_interface (message) :
4707 dbus_message_get_member (message) ?
4708 dbus_message_get_member (message) :
4710 dbus_message_get_signature (message));
4712 HAVE_LOCK_CHECK (connection);
4713 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4717 CONNECTION_LOCK (connection);
4719 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4721 _dbus_verbose ("object tree handled message in dispatch\n");
4725 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4729 DBusPreallocatedSend *preallocated;
4730 DBusList *expire_link;
4732 _dbus_verbose (" sending error %s\n",
4733 DBUS_ERROR_UNKNOWN_METHOD);
4735 if (!_dbus_string_init (&str))
4737 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4738 _dbus_verbose ("no memory for error string in dispatch\n");
4742 if (!_dbus_string_append_printf (&str,
4743 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4744 dbus_message_get_member (message),
4745 dbus_message_get_signature (message),
4746 dbus_message_get_interface (message)))
4748 _dbus_string_free (&str);
4749 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4750 _dbus_verbose ("no memory for error string in dispatch\n");
4754 reply = dbus_message_new_error (message,
4755 found_object ? DBUS_ERROR_UNKNOWN_METHOD : DBUS_ERROR_UNKNOWN_OBJECT,
4756 _dbus_string_get_const_data (&str));
4757 _dbus_string_free (&str);
4761 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4762 _dbus_verbose ("no memory for error reply in dispatch\n");
4766 expire_link = _dbus_list_alloc_link (reply);
4768 if (expire_link == NULL)
4770 dbus_message_unref (reply);
4771 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4772 _dbus_verbose ("no memory for error send in dispatch\n");
4776 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4778 if (preallocated == NULL)
4780 _dbus_list_free_link (expire_link);
4781 /* It's OK that this is finalized, because it hasn't been seen by
4782 * anything that could attach user callbacks */
4783 dbus_message_unref (reply);
4784 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4785 _dbus_verbose ("no memory for error send in dispatch\n");
4789 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4791 /* reply will be freed when we release the lock */
4792 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4794 result = DBUS_HANDLER_RESULT_HANDLED;
4797 _dbus_verbose (" done dispatching %p (%s %s %s '%s') on connection %p\n", message,
4798 dbus_message_type_to_string (dbus_message_get_type (message)),
4799 dbus_message_get_interface (message) ?
4800 dbus_message_get_interface (message) :
4802 dbus_message_get_member (message) ?
4803 dbus_message_get_member (message) :
4805 dbus_message_get_signature (message),
4809 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4811 _dbus_verbose ("out of memory\n");
4813 /* Put message back, and we'll start over.
4814 * Yes this means handlers must be idempotent if they
4815 * don't return HANDLED; c'est la vie.
4817 _dbus_connection_putback_message_link_unlocked (connection,
4819 /* now we don't want to free them */
4820 message_link = NULL;
4825 _dbus_verbose (" ... done dispatching\n");
4828 _dbus_connection_release_dispatch (connection);
4829 HAVE_LOCK_CHECK (connection);
4831 if (message != NULL)
4833 /* We don't want this message to count in maximum message limits when
4834 * computing the dispatch status, below. We have to drop the lock
4835 * temporarily, because finalizing a message can trigger callbacks.
4837 * We have a reference to the connection, and we don't use any cached
4838 * pointers to the connection's internals below this point, so it should
4839 * be safe to drop the lock and take it back. */
4840 CONNECTION_UNLOCK (connection);
4841 dbus_message_unref (message);
4842 CONNECTION_LOCK (connection);
4845 if (message_link != NULL)
4846 _dbus_list_free_link (message_link);
4848 _dbus_verbose ("before final status update\n");
4849 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4851 /* unlocks and calls user code */
4852 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4854 dbus_connection_unref (connection);
4860 * Sets the watch functions for the connection. These functions are
4861 * responsible for making the application's main loop aware of file
4862 * descriptors that need to be monitored for events, using select() or
4863 * poll(). When using Qt, typically the DBusAddWatchFunction would
4864 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4865 * could call g_io_add_watch(), or could be used as part of a more
4866 * elaborate GSource. Note that when a watch is added, it may
4869 * The DBusWatchToggledFunction notifies the application that the
4870 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4871 * to check this. A disabled watch should have no effect, and enabled
4872 * watch should be added to the main loop. This feature is used
4873 * instead of simply adding/removing the watch because
4874 * enabling/disabling can be done without memory allocation. The
4875 * toggled function may be NULL if a main loop re-queries
4876 * dbus_watch_get_enabled() every time anyway.
4878 * The DBusWatch can be queried for the file descriptor to watch using
4879 * dbus_watch_get_unix_fd() or dbus_watch_get_socket(), and for the
4880 * events to watch for using dbus_watch_get_flags(). The flags
4881 * returned by dbus_watch_get_flags() will only contain
4882 * DBUS_WATCH_READABLE and DBUS_WATCH_WRITABLE, never
4883 * DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR; all watches implicitly
4884 * include a watch for hangups, errors, and other exceptional
4887 * Once a file descriptor becomes readable or writable, or an exception
4888 * occurs, dbus_watch_handle() should be called to
4889 * notify the connection of the file descriptor's condition.
4891 * dbus_watch_handle() cannot be called during the
4892 * DBusAddWatchFunction, as the connection will not be ready to handle
4895 * It is not allowed to reference a DBusWatch after it has been passed
4896 * to remove_function.
4898 * If #FALSE is returned due to lack of memory, the failure may be due
4899 * to a #FALSE return from the new add_function. If so, the
4900 * add_function may have been called successfully one or more times,
4901 * but the remove_function will also have been called to remove any
4902 * successful adds. i.e. if #FALSE is returned the net result
4903 * should be that dbus_connection_set_watch_functions() has no effect,
4904 * but the add_function and remove_function may have been called.
4906 * @note The thread lock on DBusConnection is held while
4907 * watch functions are invoked, so inside these functions you
4908 * may not invoke any methods on DBusConnection or it will deadlock.
4909 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/tread.html#8144
4910 * if you encounter this issue and want to attempt writing a patch.
4912 * @param connection the connection.
4913 * @param add_function function to begin monitoring a new descriptor.
4914 * @param remove_function function to stop monitoring a descriptor.
4915 * @param toggled_function function to notify of enable/disable
4916 * @param data data to pass to add_function and remove_function.
4917 * @param free_data_function function to be called to free the data.
4918 * @returns #FALSE on failure (no memory)
4921 dbus_connection_set_watch_functions (DBusConnection *connection,
4922 DBusAddWatchFunction add_function,
4923 DBusRemoveWatchFunction remove_function,
4924 DBusWatchToggledFunction toggled_function,
4926 DBusFreeFunction free_data_function)
4930 _dbus_return_val_if_fail (connection != NULL, FALSE);
4932 CONNECTION_LOCK (connection);
4934 retval = _dbus_watch_list_set_functions (connection->watches,
4935 add_function, remove_function,
4937 data, free_data_function);
4939 CONNECTION_UNLOCK (connection);
4945 * Sets the timeout functions for the connection. These functions are
4946 * responsible for making the application's main loop aware of timeouts.
4947 * When using Qt, typically the DBusAddTimeoutFunction would create a
4948 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4951 * The DBusTimeoutToggledFunction notifies the application that the
4952 * timeout has been enabled or disabled. Call
4953 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4954 * have no effect, and enabled timeout should be added to the main
4955 * loop. This feature is used instead of simply adding/removing the
4956 * timeout because enabling/disabling can be done without memory
4957 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4958 * to enable and disable. The toggled function may be NULL if a main
4959 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4960 * Whenever a timeout is toggled, its interval may change.
4962 * The DBusTimeout can be queried for the timer interval using
4963 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4964 * repeatedly, each time the interval elapses, starting after it has
4965 * elapsed once. The timeout stops firing when it is removed with the
4966 * given remove_function. The timer interval may change whenever the
4967 * timeout is added, removed, or toggled.
4969 * @note The thread lock on DBusConnection is held while
4970 * timeout functions are invoked, so inside these functions you
4971 * may not invoke any methods on DBusConnection or it will deadlock.
4972 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
4973 * if you encounter this issue and want to attempt writing a patch.
4975 * @param connection the connection.
4976 * @param add_function function to add a timeout.
4977 * @param remove_function function to remove a timeout.
4978 * @param toggled_function function to notify of enable/disable
4979 * @param data data to pass to add_function and remove_function.
4980 * @param free_data_function function to be called to free the data.
4981 * @returns #FALSE on failure (no memory)
4984 dbus_connection_set_timeout_functions (DBusConnection *connection,
4985 DBusAddTimeoutFunction add_function,
4986 DBusRemoveTimeoutFunction remove_function,
4987 DBusTimeoutToggledFunction toggled_function,
4989 DBusFreeFunction free_data_function)
4993 _dbus_return_val_if_fail (connection != NULL, FALSE);
4995 CONNECTION_LOCK (connection);
4997 retval = _dbus_timeout_list_set_functions (connection->timeouts,
4998 add_function, remove_function,
5000 data, free_data_function);
5002 CONNECTION_UNLOCK (connection);
5008 * Sets the mainloop wakeup function for the connection. This function
5009 * is responsible for waking up the main loop (if its sleeping in
5010 * another thread) when some some change has happened to the
5011 * connection that the mainloop needs to reconsider (e.g. a message
5012 * has been queued for writing). When using Qt, this typically
5013 * results in a call to QEventLoop::wakeUp(). When using GLib, it
5014 * would call g_main_context_wakeup().
5016 * @param connection the connection.
5017 * @param wakeup_main_function function to wake up the mainloop
5018 * @param data data to pass wakeup_main_function
5019 * @param free_data_function function to be called to free the data.
5022 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
5023 DBusWakeupMainFunction wakeup_main_function,
5025 DBusFreeFunction free_data_function)
5028 DBusFreeFunction old_free_data;
5030 _dbus_return_if_fail (connection != NULL);
5032 CONNECTION_LOCK (connection);
5033 old_data = connection->wakeup_main_data;
5034 old_free_data = connection->free_wakeup_main_data;
5036 connection->wakeup_main_function = wakeup_main_function;
5037 connection->wakeup_main_data = data;
5038 connection->free_wakeup_main_data = free_data_function;
5040 CONNECTION_UNLOCK (connection);
5042 /* Callback outside the lock */
5044 (*old_free_data) (old_data);
5048 * Set a function to be invoked when the dispatch status changes.
5049 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
5050 * dbus_connection_dispatch() needs to be called to process incoming
5051 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
5052 * from inside the DBusDispatchStatusFunction. Indeed, almost
5053 * any reentrancy in this function is a bad idea. Instead,
5054 * the DBusDispatchStatusFunction should simply save an indication
5055 * that messages should be dispatched later, when the main loop
5058 * If you don't set a dispatch status function, you have to be sure to
5059 * dispatch on every iteration of your main loop, especially if
5060 * dbus_watch_handle() or dbus_timeout_handle() were called.
5062 * @param connection the connection
5063 * @param function function to call on dispatch status changes
5064 * @param data data for function
5065 * @param free_data_function free the function data
5068 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
5069 DBusDispatchStatusFunction function,
5071 DBusFreeFunction free_data_function)
5074 DBusFreeFunction old_free_data;
5076 _dbus_return_if_fail (connection != NULL);
5078 CONNECTION_LOCK (connection);
5079 old_data = connection->dispatch_status_data;
5080 old_free_data = connection->free_dispatch_status_data;
5082 connection->dispatch_status_function = function;
5083 connection->dispatch_status_data = data;
5084 connection->free_dispatch_status_data = free_data_function;
5086 CONNECTION_UNLOCK (connection);
5088 /* Callback outside the lock */
5090 (*old_free_data) (old_data);
5094 * Get the UNIX file descriptor of the connection, if any. This can
5095 * be used for SELinux access control checks with getpeercon() for
5096 * example. DO NOT read or write to the file descriptor, or try to
5097 * select() on it; use DBusWatch for main loop integration. Not all
5098 * connections will have a file descriptor. So for adding descriptors
5099 * to the main loop, use dbus_watch_get_unix_fd() and so forth.
5101 * If the connection is socket-based, you can also use
5102 * dbus_connection_get_socket(), which will work on Windows too.
5103 * This function always fails on Windows.
5105 * Right now the returned descriptor is always a socket, but
5106 * that is not guaranteed.
5108 * @param connection the connection
5109 * @param fd return location for the file descriptor.
5110 * @returns #TRUE if fd is successfully obtained.
5113 dbus_connection_get_unix_fd (DBusConnection *connection,
5116 _dbus_return_val_if_fail (connection != NULL, FALSE);
5117 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5120 /* FIXME do this on a lower level */
5124 return dbus_connection_get_socket(connection, fd);
5128 * Gets the underlying Windows or UNIX socket file descriptor
5129 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
5130 * select() on it; use DBusWatch for main loop integration. Not all
5131 * connections will have a socket. So for adding descriptors
5132 * to the main loop, use dbus_watch_get_socket() and so forth.
5134 * If the connection is not socket-based, this function will return FALSE,
5135 * even if the connection does have a file descriptor of some kind.
5136 * i.e. this function always returns specifically a socket file descriptor.
5138 * @param connection the connection
5139 * @param fd return location for the file descriptor.
5140 * @returns #TRUE if fd is successfully obtained.
5143 dbus_connection_get_socket(DBusConnection *connection,
5148 _dbus_return_val_if_fail (connection != NULL, FALSE);
5149 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5151 CONNECTION_LOCK (connection);
5153 retval = _dbus_transport_get_socket_fd (connection->transport,
5156 CONNECTION_UNLOCK (connection);
5163 * Gets the UNIX user ID of the connection if known. Returns #TRUE if
5164 * the uid is filled in. Always returns #FALSE on non-UNIX platforms
5165 * for now, though in theory someone could hook Windows to NIS or
5166 * something. Always returns #FALSE prior to authenticating the
5169 * The UID is only read by servers from clients; clients can't usually
5170 * get the UID of servers, because servers do not authenticate to
5171 * clients. The returned UID is the UID the connection authenticated
5174 * The message bus is a server and the apps connecting to the bus
5177 * You can ask the bus to tell you the UID of another connection though
5178 * if you like; this is done with dbus_bus_get_unix_user().
5180 * @param connection the connection
5181 * @param uid return location for the user ID
5182 * @returns #TRUE if uid is filled in with a valid user ID
5185 dbus_connection_get_unix_user (DBusConnection *connection,
5190 _dbus_return_val_if_fail (connection != NULL, FALSE);
5191 _dbus_return_val_if_fail (uid != NULL, FALSE);
5193 CONNECTION_LOCK (connection);
5195 if (!_dbus_transport_get_is_authenticated (connection->transport))
5198 result = _dbus_transport_get_unix_user (connection->transport,
5202 _dbus_assert (!result);
5205 CONNECTION_UNLOCK (connection);
5211 * Gets the process ID of the connection if any.
5212 * Returns #TRUE if the pid is filled in.
5213 * Always returns #FALSE prior to authenticating the
5216 * @param connection the connection
5217 * @param pid return location for the process ID
5218 * @returns #TRUE if uid is filled in with a valid process ID
5221 dbus_connection_get_unix_process_id (DBusConnection *connection,
5226 _dbus_return_val_if_fail (connection != NULL, FALSE);
5227 _dbus_return_val_if_fail (pid != NULL, FALSE);
5229 CONNECTION_LOCK (connection);
5231 if (!_dbus_transport_get_is_authenticated (connection->transport))
5234 result = _dbus_transport_get_unix_process_id (connection->transport,
5237 CONNECTION_UNLOCK (connection);
5243 * Gets the ADT audit data of the connection if any.
5244 * Returns #TRUE if the structure pointer is returned.
5245 * Always returns #FALSE prior to authenticating the
5248 * @param connection the connection
5249 * @param data return location for audit data
5250 * @returns #TRUE if audit data is filled in with a valid ucred pointer
5253 dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
5255 dbus_int32_t *data_size)
5259 _dbus_return_val_if_fail (connection != NULL, FALSE);
5260 _dbus_return_val_if_fail (data != NULL, FALSE);
5261 _dbus_return_val_if_fail (data_size != NULL, FALSE);
5263 CONNECTION_LOCK (connection);
5265 if (!_dbus_transport_get_is_authenticated (connection->transport))
5268 result = _dbus_transport_get_adt_audit_session_data (connection->transport,
5271 CONNECTION_UNLOCK (connection);
5277 * Sets a predicate function used to determine whether a given user ID
5278 * is allowed to connect. When an incoming connection has
5279 * authenticated with a particular user ID, this function is called;
5280 * if it returns #TRUE, the connection is allowed to proceed,
5281 * otherwise the connection is disconnected.
5283 * If the function is set to #NULL (as it is by default), then
5284 * only the same UID as the server process will be allowed to
5285 * connect. Also, root is always allowed to connect.
5287 * On Windows, the function will be set and its free_data_function will
5288 * be invoked when the connection is freed or a new function is set.
5289 * However, the function will never be called, because there are
5290 * no UNIX user ids to pass to it, or at least none of the existing
5291 * auth protocols would allow authenticating as a UNIX user on Windows.
5293 * @param connection the connection
5294 * @param function the predicate
5295 * @param data data to pass to the predicate
5296 * @param free_data_function function to free the data
5299 dbus_connection_set_unix_user_function (DBusConnection *connection,
5300 DBusAllowUnixUserFunction function,
5302 DBusFreeFunction free_data_function)
5304 void *old_data = NULL;
5305 DBusFreeFunction old_free_function = NULL;
5307 _dbus_return_if_fail (connection != NULL);
5309 CONNECTION_LOCK (connection);
5310 _dbus_transport_set_unix_user_function (connection->transport,
5311 function, data, free_data_function,
5312 &old_data, &old_free_function);
5313 CONNECTION_UNLOCK (connection);
5315 if (old_free_function != NULL)
5316 (* old_free_function) (old_data);
5320 * Gets the Windows user SID of the connection if known. Returns
5321 * #TRUE if the ID is filled in. Always returns #FALSE on non-Windows
5322 * platforms for now, though in theory someone could hook UNIX to
5323 * Active Directory or something. Always returns #FALSE prior to
5324 * authenticating the connection.
5326 * The user is only read by servers from clients; clients can't usually
5327 * get the user of servers, because servers do not authenticate to
5328 * clients. The returned user is the user the connection authenticated
5331 * The message bus is a server and the apps connecting to the bus
5334 * The returned user string has to be freed with dbus_free().
5336 * The return value indicates whether the user SID is available;
5337 * if it's available but we don't have the memory to copy it,
5338 * then the return value is #TRUE and #NULL is given as the SID.
5340 * @todo We would like to be able to say "You can ask the bus to tell
5341 * you the user of another connection though if you like; this is done
5342 * with dbus_bus_get_windows_user()." But this has to be implemented
5343 * in bus/driver.c and dbus/dbus-bus.c, and is pointless anyway
5344 * since on Windows we only use the session bus for now.
5346 * @param connection the connection
5347 * @param windows_sid_p return location for an allocated copy of the user ID, or #NULL if no memory
5348 * @returns #TRUE if user is available (returned value may be #NULL anyway if no memory)
5351 dbus_connection_get_windows_user (DBusConnection *connection,
5352 char **windows_sid_p)
5356 _dbus_return_val_if_fail (connection != NULL, FALSE);
5357 _dbus_return_val_if_fail (windows_sid_p != NULL, FALSE);
5359 CONNECTION_LOCK (connection);
5361 if (!_dbus_transport_get_is_authenticated (connection->transport))
5364 result = _dbus_transport_get_windows_user (connection->transport,
5368 _dbus_assert (!result);
5371 CONNECTION_UNLOCK (connection);
5377 * Sets a predicate function used to determine whether a given user ID
5378 * is allowed to connect. When an incoming connection has
5379 * authenticated with a particular user ID, this function is called;
5380 * if it returns #TRUE, the connection is allowed to proceed,
5381 * otherwise the connection is disconnected.
5383 * If the function is set to #NULL (as it is by default), then
5384 * only the same user owning the server process will be allowed to
5387 * On UNIX, the function will be set and its free_data_function will
5388 * be invoked when the connection is freed or a new function is set.
5389 * However, the function will never be called, because there is no
5390 * way right now to authenticate as a Windows user on UNIX.
5392 * @param connection the connection
5393 * @param function the predicate
5394 * @param data data to pass to the predicate
5395 * @param free_data_function function to free the data
5398 dbus_connection_set_windows_user_function (DBusConnection *connection,
5399 DBusAllowWindowsUserFunction function,
5401 DBusFreeFunction free_data_function)
5403 void *old_data = NULL;
5404 DBusFreeFunction old_free_function = NULL;
5406 _dbus_return_if_fail (connection != NULL);
5408 CONNECTION_LOCK (connection);
5409 _dbus_transport_set_windows_user_function (connection->transport,
5410 function, data, free_data_function,
5411 &old_data, &old_free_function);
5412 CONNECTION_UNLOCK (connection);
5414 if (old_free_function != NULL)
5415 (* old_free_function) (old_data);
5419 * This function must be called on the server side of a connection when the
5420 * connection is first seen in the #DBusNewConnectionFunction. If set to
5421 * #TRUE (the default is #FALSE), then the connection can proceed even if
5422 * the client does not authenticate as some user identity, i.e. clients
5423 * can connect anonymously.
5425 * This setting interacts with the available authorization mechanisms
5426 * (see dbus_server_set_auth_mechanisms()). Namely, an auth mechanism
5427 * such as ANONYMOUS that supports anonymous auth must be included in
5428 * the list of available mechanisms for anonymous login to work.
5430 * This setting also changes the default rule for connections
5431 * authorized as a user; normally, if a connection authorizes as
5432 * a user identity, it is permitted if the user identity is
5433 * root or the user identity matches the user identity of the server
5434 * process. If anonymous connections are allowed, however,
5435 * then any user identity is allowed.
5437 * You can override the rules for connections authorized as a
5438 * user identity with dbus_connection_set_unix_user_function()
5439 * and dbus_connection_set_windows_user_function().
5441 * @param connection the connection
5442 * @param value whether to allow authentication as an anonymous user
5445 dbus_connection_set_allow_anonymous (DBusConnection *connection,
5448 _dbus_return_if_fail (connection != NULL);
5450 CONNECTION_LOCK (connection);
5451 _dbus_transport_set_allow_anonymous (connection->transport, value);
5452 CONNECTION_UNLOCK (connection);
5457 * Normally #DBusConnection automatically handles all messages to the
5458 * org.freedesktop.DBus.Peer interface. However, the message bus wants
5459 * to be able to route methods on that interface through the bus and
5460 * to other applications. If routing peer messages is enabled, then
5461 * messages with the org.freedesktop.DBus.Peer interface that also
5462 * have a bus destination name set will not be automatically
5463 * handled by the #DBusConnection and instead will be dispatched
5464 * normally to the application.
5466 * If a normal application sets this flag, it can break things badly.
5467 * So don't set this unless you are the message bus.
5469 * @param connection the connection
5470 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
5473 dbus_connection_set_route_peer_messages (DBusConnection *connection,
5476 _dbus_return_if_fail (connection != NULL);
5478 CONNECTION_LOCK (connection);
5479 connection->route_peer_messages = TRUE;
5480 CONNECTION_UNLOCK (connection);
5484 * Adds a message filter. Filters are handlers that are run on all
5485 * incoming messages, prior to the objects registered with
5486 * dbus_connection_register_object_path(). Filters are run in the
5487 * order that they were added. The same handler can be added as a
5488 * filter more than once, in which case it will be run more than once.
5489 * Filters added during a filter callback won't be run on the message
5492 * @todo we don't run filters on messages while blocking without
5493 * entering the main loop, since filters are run as part of
5494 * dbus_connection_dispatch(). This is probably a feature, as filters
5495 * could create arbitrary reentrancy. But kind of sucks if you're
5496 * trying to filter METHOD_RETURN for some reason.
5498 * @param connection the connection
5499 * @param function function to handle messages
5500 * @param user_data user data to pass to the function
5501 * @param free_data_function function to use for freeing user data
5502 * @returns #TRUE on success, #FALSE if not enough memory.
5505 dbus_connection_add_filter (DBusConnection *connection,
5506 DBusHandleMessageFunction function,
5508 DBusFreeFunction free_data_function)
5510 DBusMessageFilter *filter;
5512 _dbus_return_val_if_fail (connection != NULL, FALSE);
5513 _dbus_return_val_if_fail (function != NULL, FALSE);
5515 filter = dbus_new0 (DBusMessageFilter, 1);
5519 _dbus_atomic_inc (&filter->refcount);
5521 CONNECTION_LOCK (connection);
5523 if (!_dbus_list_append (&connection->filter_list,
5526 _dbus_message_filter_unref (filter);
5527 CONNECTION_UNLOCK (connection);
5531 /* Fill in filter after all memory allocated,
5532 * so we don't run the free_user_data_function
5533 * if the add_filter() fails
5536 filter->function = function;
5537 filter->user_data = user_data;
5538 filter->free_user_data_function = free_data_function;
5540 CONNECTION_UNLOCK (connection);
5545 * Removes a previously-added message filter. It is a programming
5546 * error to call this function for a handler that has not been added
5547 * as a filter. If the given handler was added more than once, only
5548 * one instance of it will be removed (the most recently-added
5551 * @param connection the connection
5552 * @param function the handler to remove
5553 * @param user_data user data for the handler to remove
5557 dbus_connection_remove_filter (DBusConnection *connection,
5558 DBusHandleMessageFunction function,
5562 DBusMessageFilter *filter;
5564 _dbus_return_if_fail (connection != NULL);
5565 _dbus_return_if_fail (function != NULL);
5567 CONNECTION_LOCK (connection);
5571 link = _dbus_list_get_last_link (&connection->filter_list);
5572 while (link != NULL)
5574 filter = link->data;
5576 if (filter->function == function &&
5577 filter->user_data == user_data)
5579 _dbus_list_remove_link (&connection->filter_list, link);
5580 filter->function = NULL;
5585 link = _dbus_list_get_prev_link (&connection->filter_list, link);
5589 CONNECTION_UNLOCK (connection);
5591 #ifndef DBUS_DISABLE_CHECKS
5594 _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5595 function, user_data);
5600 /* Call application code */
5601 if (filter->free_user_data_function)
5602 (* filter->free_user_data_function) (filter->user_data);
5604 filter->free_user_data_function = NULL;
5605 filter->user_data = NULL;
5607 _dbus_message_filter_unref (filter);
5611 * Registers a handler for a given path or subsection in the object
5612 * hierarchy. The given vtable handles messages sent to exactly the
5613 * given path or also for paths bellow that, depending on fallback
5616 * @param connection the connection
5617 * @param fallback whether to handle messages also for "subdirectory"
5618 * @param path a '/' delimited string of path elements
5619 * @param vtable the virtual table
5620 * @param user_data data to pass to functions in the vtable
5621 * @param error address where an error can be returned
5622 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5623 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5626 _dbus_connection_register_object_path (DBusConnection *connection,
5627 dbus_bool_t fallback,
5629 const DBusObjectPathVTable *vtable,
5633 char **decomposed_path;
5636 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5639 CONNECTION_LOCK (connection);
5641 retval = _dbus_object_tree_register (connection->objects,
5643 (const char **) decomposed_path, vtable,
5646 CONNECTION_UNLOCK (connection);
5648 dbus_free_string_array (decomposed_path);
5654 * Registers a handler for a given path in the object hierarchy.
5655 * The given vtable handles messages sent to exactly the given path.
5657 * @param connection the connection
5658 * @param path a '/' delimited string of path elements
5659 * @param vtable the virtual table
5660 * @param user_data data to pass to functions in the vtable
5661 * @param error address where an error can be returned
5662 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5663 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5666 dbus_connection_try_register_object_path (DBusConnection *connection,
5668 const DBusObjectPathVTable *vtable,
5672 _dbus_return_val_if_fail (connection != NULL, FALSE);
5673 _dbus_return_val_if_fail (path != NULL, FALSE);
5674 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5675 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5677 return _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, error);
5681 * Registers a handler for a given path in the object hierarchy.
5682 * The given vtable handles messages sent to exactly the given path.
5684 * It is a bug to call this function for object paths which already
5685 * have a handler. Use dbus_connection_try_register_object_path() if this
5686 * might be the case.
5688 * @param connection the connection
5689 * @param path a '/' delimited string of path elements
5690 * @param vtable the virtual table
5691 * @param user_data data to pass to functions in the vtable
5692 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5693 * #DBUS_ERROR_OBJECT_PATH_IN_USE) ocurred
5696 dbus_connection_register_object_path (DBusConnection *connection,
5698 const DBusObjectPathVTable *vtable,
5702 DBusError error = DBUS_ERROR_INIT;
5704 _dbus_return_val_if_fail (connection != NULL, FALSE);
5705 _dbus_return_val_if_fail (path != NULL, FALSE);
5706 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5707 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5709 retval = _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, &error);
5711 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5713 _dbus_warn ("%s\n", error.message);
5714 dbus_error_free (&error);
5722 * Registers a fallback handler for a given subsection of the object
5723 * hierarchy. The given vtable handles messages at or below the given
5724 * path. You can use this to establish a default message handling
5725 * policy for a whole "subdirectory."
5727 * @param connection the connection
5728 * @param path a '/' delimited string of path elements
5729 * @param vtable the virtual table
5730 * @param user_data data to pass to functions in the vtable
5731 * @param error address where an error can be returned
5732 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5733 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5736 dbus_connection_try_register_fallback (DBusConnection *connection,
5738 const DBusObjectPathVTable *vtable,
5742 _dbus_return_val_if_fail (connection != NULL, FALSE);
5743 _dbus_return_val_if_fail (path != NULL, FALSE);
5744 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5745 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5747 return _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, error);
5751 * Registers a fallback handler for a given subsection of the object
5752 * hierarchy. The given vtable handles messages at or below the given
5753 * path. You can use this to establish a default message handling
5754 * policy for a whole "subdirectory."
5756 * It is a bug to call this function for object paths which already
5757 * have a handler. Use dbus_connection_try_register_fallback() if this
5758 * might be the case.
5760 * @param connection the connection
5761 * @param path a '/' delimited string of path elements
5762 * @param vtable the virtual table
5763 * @param user_data data to pass to functions in the vtable
5764 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5765 * #DBUS_ERROR_OBJECT_PATH_IN_USE) occured
5768 dbus_connection_register_fallback (DBusConnection *connection,
5770 const DBusObjectPathVTable *vtable,
5774 DBusError error = DBUS_ERROR_INIT;
5776 _dbus_return_val_if_fail (connection != NULL, FALSE);
5777 _dbus_return_val_if_fail (path != NULL, FALSE);
5778 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5779 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5781 retval = _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, &error);
5783 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5785 _dbus_warn ("%s\n", error.message);
5786 dbus_error_free (&error);
5794 * Unregisters the handler registered with exactly the given path.
5795 * It's a bug to call this function for a path that isn't registered.
5796 * Can unregister both fallback paths and object paths.
5798 * @param connection the connection
5799 * @param path a '/' delimited string of path elements
5800 * @returns #FALSE if not enough memory
5803 dbus_connection_unregister_object_path (DBusConnection *connection,
5806 char **decomposed_path;
5808 _dbus_return_val_if_fail (connection != NULL, FALSE);
5809 _dbus_return_val_if_fail (path != NULL, FALSE);
5810 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5812 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5815 CONNECTION_LOCK (connection);
5817 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5819 dbus_free_string_array (decomposed_path);
5825 * Gets the user data passed to dbus_connection_register_object_path()
5826 * or dbus_connection_register_fallback(). If nothing was registered
5827 * at this path, the data is filled in with #NULL.
5829 * @param connection the connection
5830 * @param path the path you registered with
5831 * @param data_p location to store the user data, or #NULL
5832 * @returns #FALSE if not enough memory
5835 dbus_connection_get_object_path_data (DBusConnection *connection,
5839 char **decomposed_path;
5841 _dbus_return_val_if_fail (connection != NULL, FALSE);
5842 _dbus_return_val_if_fail (path != NULL, FALSE);
5843 _dbus_return_val_if_fail (data_p != NULL, FALSE);
5847 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5850 CONNECTION_LOCK (connection);
5852 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5854 CONNECTION_UNLOCK (connection);
5856 dbus_free_string_array (decomposed_path);
5862 * Lists the registered fallback handlers and object path handlers at
5863 * the given parent_path. The returned array should be freed with
5864 * dbus_free_string_array().
5866 * @param connection the connection
5867 * @param parent_path the path to list the child handlers of
5868 * @param child_entries returns #NULL-terminated array of children
5869 * @returns #FALSE if no memory to allocate the child entries
5872 dbus_connection_list_registered (DBusConnection *connection,
5873 const char *parent_path,
5874 char ***child_entries)
5876 char **decomposed_path;
5878 _dbus_return_val_if_fail (connection != NULL, FALSE);
5879 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5880 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5881 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5883 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5886 CONNECTION_LOCK (connection);
5888 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5889 (const char **) decomposed_path,
5891 dbus_free_string_array (decomposed_path);
5896 static DBusDataSlotAllocator slot_allocator =
5897 _DBUS_DATA_SLOT_ALLOCATOR_INIT (_DBUS_LOCK_NAME (connection_slots));
5900 * Allocates an integer ID to be used for storing application-specific
5901 * data on any DBusConnection. The allocated ID may then be used
5902 * with dbus_connection_set_data() and dbus_connection_get_data().
5903 * The passed-in slot must be initialized to -1, and is filled in
5904 * with the slot ID. If the passed-in slot is not -1, it's assumed
5905 * to be already allocated, and its refcount is incremented.
5907 * The allocated slot is global, i.e. all DBusConnection objects will
5908 * have a slot with the given integer ID reserved.
5910 * @param slot_p address of a global variable storing the slot
5911 * @returns #FALSE on failure (no memory)
5914 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5916 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5921 * Deallocates a global ID for connection data slots.
5922 * dbus_connection_get_data() and dbus_connection_set_data() may no
5923 * longer be used with this slot. Existing data stored on existing
5924 * DBusConnection objects will be freed when the connection is
5925 * finalized, but may not be retrieved (and may only be replaced if
5926 * someone else reallocates the slot). When the refcount on the
5927 * passed-in slot reaches 0, it is set to -1.
5929 * @param slot_p address storing the slot to deallocate
5932 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5934 _dbus_return_if_fail (*slot_p >= 0);
5936 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5940 * Stores a pointer on a DBusConnection, along
5941 * with an optional function to be used for freeing
5942 * the data when the data is set again, or when
5943 * the connection is finalized. The slot number
5944 * must have been allocated with dbus_connection_allocate_data_slot().
5946 * @note This function does not take the
5947 * main thread lock on DBusConnection, which allows it to be
5948 * used from inside watch and timeout functions. (See the
5949 * note in docs for dbus_connection_set_watch_functions().)
5950 * A side effect of this is that you need to know there's
5951 * a reference held on the connection while invoking
5952 * dbus_connection_set_data(), or the connection could be
5953 * finalized during dbus_connection_set_data().
5955 * @param connection the connection
5956 * @param slot the slot number
5957 * @param data the data to store
5958 * @param free_data_func finalizer function for the data
5959 * @returns #TRUE if there was enough memory to store the data
5962 dbus_connection_set_data (DBusConnection *connection,
5965 DBusFreeFunction free_data_func)
5967 DBusFreeFunction old_free_func;
5971 _dbus_return_val_if_fail (connection != NULL, FALSE);
5972 _dbus_return_val_if_fail (slot >= 0, FALSE);
5974 SLOTS_LOCK (connection);
5976 retval = _dbus_data_slot_list_set (&slot_allocator,
5977 &connection->slot_list,
5978 slot, data, free_data_func,
5979 &old_free_func, &old_data);
5981 SLOTS_UNLOCK (connection);
5985 /* Do the actual free outside the connection lock */
5987 (* old_free_func) (old_data);
5994 * Retrieves data previously set with dbus_connection_set_data().
5995 * The slot must still be allocated (must not have been freed).
5997 * @note This function does not take the
5998 * main thread lock on DBusConnection, which allows it to be
5999 * used from inside watch and timeout functions. (See the
6000 * note in docs for dbus_connection_set_watch_functions().)
6001 * A side effect of this is that you need to know there's
6002 * a reference held on the connection while invoking
6003 * dbus_connection_get_data(), or the connection could be
6004 * finalized during dbus_connection_get_data().
6006 * @param connection the connection
6007 * @param slot the slot to get data from
6008 * @returns the data, or #NULL if not found
6011 dbus_connection_get_data (DBusConnection *connection,
6016 _dbus_return_val_if_fail (connection != NULL, NULL);
6017 _dbus_return_val_if_fail (slot >= 0, NULL);
6019 SLOTS_LOCK (connection);
6021 res = _dbus_data_slot_list_get (&slot_allocator,
6022 &connection->slot_list,
6025 SLOTS_UNLOCK (connection);
6031 * This function sets a global flag for whether dbus_connection_new()
6032 * will set SIGPIPE behavior to SIG_IGN.
6034 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
6037 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
6039 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
6043 * Specifies the maximum size message this connection is allowed to
6044 * receive. Larger messages will result in disconnecting the
6047 * @param connection a #DBusConnection
6048 * @param size maximum message size the connection can receive, in bytes
6051 dbus_connection_set_max_message_size (DBusConnection *connection,
6054 _dbus_return_if_fail (connection != NULL);
6056 CONNECTION_LOCK (connection);
6057 _dbus_transport_set_max_message_size (connection->transport,
6059 CONNECTION_UNLOCK (connection);
6063 * Gets the value set by dbus_connection_set_max_message_size().
6065 * @param connection the connection
6066 * @returns the max size of a single message
6069 dbus_connection_get_max_message_size (DBusConnection *connection)
6073 _dbus_return_val_if_fail (connection != NULL, 0);
6075 CONNECTION_LOCK (connection);
6076 res = _dbus_transport_get_max_message_size (connection->transport);
6077 CONNECTION_UNLOCK (connection);
6082 * Specifies the maximum number of unix fds a message on this
6083 * connection is allowed to receive. Messages with more unix fds will
6084 * result in disconnecting the connection.
6086 * @param connection a #DBusConnection
6087 * @param size maximum message unix fds the connection can receive
6090 dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
6093 _dbus_return_if_fail (connection != NULL);
6095 CONNECTION_LOCK (connection);
6096 _dbus_transport_set_max_message_unix_fds (connection->transport,
6098 CONNECTION_UNLOCK (connection);
6102 * Gets the value set by dbus_connection_set_max_message_unix_fds().
6104 * @param connection the connection
6105 * @returns the max numer of unix fds of a single message
6108 dbus_connection_get_max_message_unix_fds (DBusConnection *connection)
6112 _dbus_return_val_if_fail (connection != NULL, 0);
6114 CONNECTION_LOCK (connection);
6115 res = _dbus_transport_get_max_message_unix_fds (connection->transport);
6116 CONNECTION_UNLOCK (connection);
6121 * Sets the maximum total number of bytes that can be used for all messages
6122 * received on this connection. Messages count toward the maximum until
6123 * they are finalized. When the maximum is reached, the connection will
6124 * not read more data until some messages are finalized.
6126 * The semantics of the maximum are: if outstanding messages are
6127 * already above the maximum, additional messages will not be read.
6128 * The semantics are not: if the next message would cause us to exceed
6129 * the maximum, we don't read it. The reason is that we don't know the
6130 * size of a message until after we read it.
6132 * Thus, the max live messages size can actually be exceeded
6133 * by up to the maximum size of a single message.
6135 * Also, if we read say 1024 bytes off the wire in a single read(),
6136 * and that contains a half-dozen small messages, we may exceed the
6137 * size max by that amount. But this should be inconsequential.
6139 * This does imply that we can't call read() with a buffer larger
6140 * than we're willing to exceed this limit by.
6142 * @param connection the connection
6143 * @param size the maximum size in bytes of all outstanding messages
6146 dbus_connection_set_max_received_size (DBusConnection *connection,
6149 _dbus_return_if_fail (connection != NULL);
6151 CONNECTION_LOCK (connection);
6152 _dbus_transport_set_max_received_size (connection->transport,
6154 CONNECTION_UNLOCK (connection);
6158 * Gets the value set by dbus_connection_set_max_received_size().
6160 * @param connection the connection
6161 * @returns the max size of all live messages
6164 dbus_connection_get_max_received_size (DBusConnection *connection)
6168 _dbus_return_val_if_fail (connection != NULL, 0);
6170 CONNECTION_LOCK (connection);
6171 res = _dbus_transport_get_max_received_size (connection->transport);
6172 CONNECTION_UNLOCK (connection);
6177 * Sets the maximum total number of unix fds that can be used for all messages
6178 * received on this connection. Messages count toward the maximum until
6179 * they are finalized. When the maximum is reached, the connection will
6180 * not read more data until some messages are finalized.
6182 * The semantics are analogous to those of dbus_connection_set_max_received_size().
6184 * @param connection the connection
6185 * @param size the maximum size in bytes of all outstanding messages
6188 dbus_connection_set_max_received_unix_fds (DBusConnection *connection,
6191 _dbus_return_if_fail (connection != NULL);
6193 CONNECTION_LOCK (connection);
6194 _dbus_transport_set_max_received_unix_fds (connection->transport,
6196 CONNECTION_UNLOCK (connection);
6200 * Gets the value set by dbus_connection_set_max_received_unix_fds().
6202 * @param connection the connection
6203 * @returns the max unix fds of all live messages
6206 dbus_connection_get_max_received_unix_fds (DBusConnection *connection)
6210 _dbus_return_val_if_fail (connection != NULL, 0);
6212 CONNECTION_LOCK (connection);
6213 res = _dbus_transport_get_max_received_unix_fds (connection->transport);
6214 CONNECTION_UNLOCK (connection);
6219 * Gets the approximate size in bytes of all messages in the outgoing
6220 * message queue. The size is approximate in that you shouldn't use
6221 * it to decide how many bytes to read off the network or anything
6222 * of that nature, as optimizations may choose to tell small white lies
6223 * to avoid performance overhead.
6225 * @param connection the connection
6226 * @returns the number of bytes that have been queued up but not sent
6229 dbus_connection_get_outgoing_size (DBusConnection *connection)
6233 _dbus_return_val_if_fail (connection != NULL, 0);
6235 CONNECTION_LOCK (connection);
6236 res = _dbus_counter_get_size_value (connection->outgoing_counter);
6237 CONNECTION_UNLOCK (connection);
6241 #ifdef DBUS_ENABLE_STATS
6243 _dbus_connection_get_stats (DBusConnection *connection,
6244 dbus_uint32_t *in_messages,
6245 dbus_uint32_t *in_bytes,
6246 dbus_uint32_t *in_fds,
6247 dbus_uint32_t *in_peak_bytes,
6248 dbus_uint32_t *in_peak_fds,
6249 dbus_uint32_t *out_messages,
6250 dbus_uint32_t *out_bytes,
6251 dbus_uint32_t *out_fds,
6252 dbus_uint32_t *out_peak_bytes,
6253 dbus_uint32_t *out_peak_fds)
6255 CONNECTION_LOCK (connection);
6257 if (in_messages != NULL)
6258 *in_messages = connection->n_incoming;
6260 _dbus_transport_get_stats (connection->transport,
6261 in_bytes, in_fds, in_peak_bytes, in_peak_fds);
6263 if (out_messages != NULL)
6264 *out_messages = connection->n_outgoing;
6266 if (out_bytes != NULL)
6267 *out_bytes = _dbus_counter_get_size_value (connection->outgoing_counter);
6269 if (out_fds != NULL)
6270 *out_fds = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6272 if (out_peak_bytes != NULL)
6273 *out_peak_bytes = _dbus_counter_get_peak_size_value (connection->outgoing_counter);
6275 if (out_peak_fds != NULL)
6276 *out_peak_fds = _dbus_counter_get_peak_unix_fd_value (connection->outgoing_counter);
6278 CONNECTION_UNLOCK (connection);
6280 #endif /* DBUS_ENABLE_STATS */
6283 * Gets the approximate number of uni fds of all messages in the
6284 * outgoing message queue.
6286 * @param connection the connection
6287 * @returns the number of unix fds that have been queued up but not sent
6290 dbus_connection_get_outgoing_unix_fds (DBusConnection *connection)
6294 _dbus_return_val_if_fail (connection != NULL, 0);
6296 CONNECTION_LOCK (connection);
6297 res = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6298 CONNECTION_UNLOCK (connection);
6302 #ifdef DBUS_BUILD_TESTS
6304 * Returns the address of the transport object of this connection
6306 * @param connection the connection
6307 * @returns the address string
6310 _dbus_connection_get_address (DBusConnection *connection)
6312 return _dbus_transport_get_address (connection->transport);