1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-connection.c DBusConnection object
4 * Copyright (C) 2002-2006 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-shared.h"
26 #include "dbus-connection.h"
27 #include "dbus-list.h"
28 #include "dbus-timeout.h"
29 #include "dbus-transport.h"
30 #include "dbus-watch.h"
31 #include "dbus-connection-internal.h"
32 #include "dbus-pending-call-internal.h"
33 #include "dbus-list.h"
34 #include "dbus-hash.h"
35 #include "dbus-message-internal.h"
36 #include "dbus-message-private.h"
37 #include "dbus-threads.h"
38 #include "dbus-protocol.h"
39 #include "dbus-dataslot.h"
40 #include "dbus-string.h"
41 #include "dbus-signature.h"
42 #include "dbus-pending-call.h"
43 #include "dbus-object-tree.h"
44 #include "dbus-threads-internal.h"
46 #include "dbus-marshal-basic.h"
48 #ifdef DBUS_DISABLE_CHECKS
49 #define TOOK_LOCK_CHECK(connection)
50 #define RELEASING_LOCK_CHECK(connection)
51 #define HAVE_LOCK_CHECK(connection)
53 #define TOOK_LOCK_CHECK(connection) do { \
54 _dbus_assert (!(connection)->have_connection_lock); \
55 (connection)->have_connection_lock = TRUE; \
57 #define RELEASING_LOCK_CHECK(connection) do { \
58 _dbus_assert ((connection)->have_connection_lock); \
59 (connection)->have_connection_lock = FALSE; \
61 #define HAVE_LOCK_CHECK(connection) _dbus_assert ((connection)->have_connection_lock)
62 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
67 #define CONNECTION_LOCK(connection) do { \
68 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
69 _dbus_rmutex_lock ((connection)->mutex); \
70 TOOK_LOCK_CHECK (connection); \
73 #define CONNECTION_UNLOCK(connection) _dbus_connection_unlock (connection)
75 #define SLOTS_LOCK(connection) do { \
76 _dbus_rmutex_lock ((connection)->slot_mutex); \
79 #define SLOTS_UNLOCK(connection) do { \
80 _dbus_rmutex_unlock ((connection)->slot_mutex); \
83 #define DISPATCH_STATUS_NAME(s) \
84 ((s) == DBUS_DISPATCH_COMPLETE ? "complete" : \
85 (s) == DBUS_DISPATCH_DATA_REMAINS ? "data remains" : \
86 (s) == DBUS_DISPATCH_NEED_MEMORY ? "need memory" : \
90 * @defgroup DBusConnection DBusConnection
92 * @brief Connection to another application
94 * A DBusConnection represents a connection to another
95 * application. Messages can be sent and received via this connection.
96 * The other application may be a message bus; for convenience, the
97 * function dbus_bus_get() is provided to automatically open a
98 * connection to the well-known message buses.
100 * In brief a DBusConnection is a message queue associated with some
101 * message transport mechanism such as a socket. The connection
102 * maintains a queue of incoming messages and a queue of outgoing
105 * Several functions use the following terms:
107 * <li><b>read</b> means to fill the incoming message queue by reading from the socket</li>
108 * <li><b>write</b> means to drain the outgoing queue by writing to the socket</li>
109 * <li><b>dispatch</b> means to drain the incoming queue by invoking application-provided message handlers</li>
112 * The function dbus_connection_read_write_dispatch() for example does all
113 * three of these things, offering a simple alternative to a main loop.
115 * In an application with a main loop, the read/write/dispatch
116 * operations are usually separate.
118 * The connection provides #DBusWatch and #DBusTimeout objects to
119 * the main loop. These are used to know when reading, writing, or
120 * dispatching should be performed.
122 * Incoming messages are processed
123 * by calling dbus_connection_dispatch(). dbus_connection_dispatch()
124 * runs any handlers registered for the topmost message in the message
125 * queue, then discards the message, then returns.
127 * dbus_connection_get_dispatch_status() indicates whether
128 * messages are currently in the queue that need dispatching.
129 * dbus_connection_set_dispatch_status_function() allows
130 * you to set a function to be used to monitor the dispatch status.
132 * If you're using GLib or Qt add-on libraries for D-Bus, there are
133 * special convenience APIs in those libraries that hide
134 * all the details of dispatch and watch/timeout monitoring.
135 * For example, dbus_connection_setup_with_g_main().
137 * If you aren't using these add-on libraries, but want to process
138 * messages asynchronously, you must manually call
139 * dbus_connection_set_dispatch_status_function(),
140 * dbus_connection_set_watch_functions(),
141 * dbus_connection_set_timeout_functions() providing appropriate
142 * functions to integrate the connection with your application's main
143 * loop. This can be tricky to get right; main loops are not simple.
145 * If you don't need to be asynchronous, you can ignore #DBusWatch,
146 * #DBusTimeout, and dbus_connection_dispatch(). Instead,
147 * dbus_connection_read_write_dispatch() can be used.
149 * Or, in <em>very</em> simple applications,
150 * dbus_connection_pop_message() may be all you need, allowing you to
151 * avoid setting up any handler functions (see
152 * dbus_connection_add_filter(),
153 * dbus_connection_register_object_path() for more on handlers).
155 * When you use dbus_connection_send() or one of its variants to send
156 * a message, the message is added to the outgoing queue. It's
157 * actually written to the network later; either in
158 * dbus_watch_handle() invoked by your main loop, or in
159 * dbus_connection_flush() which blocks until it can write out the
160 * entire outgoing queue. The GLib/Qt add-on libraries again
161 * handle the details here for you by setting up watch functions.
163 * When a connection is disconnected, you are guaranteed to get a
164 * signal "Disconnected" from the interface
165 * #DBUS_INTERFACE_LOCAL, path
168 * You may not drop the last reference to a #DBusConnection
169 * until that connection has been disconnected.
171 * You may dispatch the unprocessed incoming message queue even if the
172 * connection is disconnected. However, "Disconnected" will always be
173 * the last message in the queue (obviously no messages are received
174 * after disconnection).
176 * After calling dbus_threads_init(), #DBusConnection has thread
177 * locks and drops them when invoking user callbacks, so in general is
178 * transparently threadsafe. However, #DBusMessage does NOT have
179 * thread locks; you must not send the same message to multiple
180 * #DBusConnection if those connections will be used from different threads,
183 * Also, if you dispatch or pop messages from multiple threads, it
184 * may work in the sense that it won't crash, but it's tough to imagine
185 * sane results; it will be completely unpredictable which messages
186 * go to which threads.
188 * It's recommended to dispatch from a single thread.
190 * The most useful function to call from multiple threads at once
191 * is dbus_connection_send_with_reply_and_block(). That is,
192 * multiple threads can make method calls at the same time.
194 * If you aren't using threads, you can use a main loop and
195 * dbus_pending_call_set_notify() to achieve a similar result.
199 * @defgroup DBusConnectionInternals DBusConnection implementation details
200 * @ingroup DBusInternals
201 * @brief Implementation details of DBusConnection
206 #ifdef DBUS_ENABLE_VERBOSE_MODE
208 _dbus_connection_trace_ref (DBusConnection *connection,
213 static int enabled = -1;
215 _dbus_trace_ref ("DBusConnection", connection, old_refcount, new_refcount,
216 why, "DBUS_CONNECTION_TRACE", &enabled);
219 #define _dbus_connection_trace_ref(c,o,n,w) \
228 * Internal struct representing a message filter function
230 typedef struct DBusMessageFilter DBusMessageFilter;
233 * Internal struct representing a message filter function
235 struct DBusMessageFilter
237 DBusAtomic refcount; /**< Reference count */
238 DBusHandleMessageFunction function; /**< Function to call to filter */
239 void *user_data; /**< User data for the function */
240 DBusFreeFunction free_user_data_function; /**< Function to free the user data */
245 * Internals of DBusPreallocatedSend
247 struct DBusPreallocatedSend
249 DBusConnection *connection; /**< Connection we'd send the message to */
250 DBusList *queue_link; /**< Preallocated link in the queue */
251 DBusList *counter_link; /**< Preallocated link in the resource counter */
254 #if HAVE_DECL_MSG_NOSIGNAL
255 static dbus_bool_t _dbus_modify_sigpipe = FALSE;
257 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
261 * Implementation details of DBusConnection. All fields are private.
263 struct DBusConnection
265 DBusAtomic refcount; /**< Reference count. */
267 DBusRMutex *mutex; /**< Lock on the entire DBusConnection */
269 DBusCMutex *dispatch_mutex; /**< Protects dispatch_acquired */
270 DBusCondVar *dispatch_cond; /**< Notify when dispatch_acquired is available */
271 DBusCMutex *io_path_mutex; /**< Protects io_path_acquired */
272 DBusCondVar *io_path_cond; /**< Notify when io_path_acquired is available */
274 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
275 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
276 DBusList *expired_messages; /**< Messages that will be released when we next unlock. */
278 DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
279 * dispatch_acquired will be set by the borrower
282 int n_outgoing; /**< Length of outgoing queue. */
283 int n_incoming; /**< Length of incoming queue. */
285 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
287 DBusTransport *transport; /**< Object that sends/receives messages over network. */
288 DBusWatchList *watches; /**< Stores active watches. */
289 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
291 DBusList *filter_list; /**< List of filters. */
293 DBusRMutex *slot_mutex; /**< Lock on slot_list so overall connection lock need not be taken */
294 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
296 DBusHashTable *pending_replies; /**< Hash of message serials to #DBusPendingCall. */
298 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
299 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
301 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
302 void *wakeup_main_data; /**< Application data for wakeup_main_function */
303 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
305 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
306 void *dispatch_status_data; /**< Application data for dispatch_status_function */
307 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
309 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
311 DBusObjectTree *objects; /**< Object path handlers registered with this connection */
313 char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
315 /* These two MUST be bools and not bitfields, because they are protected by a separate lock
316 * from connection->mutex and all bitfields in a word have to be read/written together.
317 * So you can't have a different lock for different bitfields in the same word.
319 dbus_bool_t dispatch_acquired; /**< Someone has dispatch path (can drain incoming queue) */
320 dbus_bool_t io_path_acquired; /**< Someone has transport io path (can use the transport to read/write messages) */
322 unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
324 unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
326 unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
328 unsigned int disconnected_message_arrived : 1; /**< We popped or are dispatching the disconnected message.
329 * if the disconnect_message_link is NULL then we queued it, but
330 * this flag is whether it got to the head of the queue.
332 unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
333 * such as closing the connection.
336 #ifndef DBUS_DISABLE_CHECKS
337 unsigned int have_connection_lock : 1; /**< Used to check locking */
340 #ifndef DBUS_DISABLE_CHECKS
341 int generation; /**< _dbus_current_generation that should correspond to this connection */
345 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
346 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
347 DBusDispatchStatus new_status);
348 static void _dbus_connection_last_unref (DBusConnection *connection);
349 static void _dbus_connection_acquire_dispatch (DBusConnection *connection);
350 static void _dbus_connection_release_dispatch (DBusConnection *connection);
351 static DBusDispatchStatus _dbus_connection_flush_unlocked (DBusConnection *connection);
352 static void _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection);
353 static dbus_bool_t _dbus_connection_get_is_connected_unlocked (DBusConnection *connection);
354 static dbus_bool_t _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
355 dbus_uint32_t client_serial);
357 static DBusMessageFilter *
358 _dbus_message_filter_ref (DBusMessageFilter *filter)
360 #ifdef DBUS_DISABLE_ASSERT
361 _dbus_atomic_inc (&filter->refcount);
363 dbus_int32_t old_value;
365 old_value = _dbus_atomic_inc (&filter->refcount);
366 _dbus_assert (old_value > 0);
373 _dbus_message_filter_unref (DBusMessageFilter *filter)
375 dbus_int32_t old_value;
377 old_value = _dbus_atomic_dec (&filter->refcount);
378 _dbus_assert (old_value > 0);
382 if (filter->free_user_data_function)
383 (* filter->free_user_data_function) (filter->user_data);
390 * Acquires the connection lock.
392 * @param connection the connection.
395 _dbus_connection_lock (DBusConnection *connection)
397 CONNECTION_LOCK (connection);
401 * Releases the connection lock.
403 * @param connection the connection.
406 _dbus_connection_unlock (DBusConnection *connection)
408 DBusList *expired_messages;
413 _dbus_verbose ("UNLOCK\n");
416 /* If we had messages that expired (fell off the incoming or outgoing
417 * queues) while we were locked, actually release them now */
418 expired_messages = connection->expired_messages;
419 connection->expired_messages = NULL;
421 RELEASING_LOCK_CHECK (connection);
422 _dbus_rmutex_unlock (connection->mutex);
424 for (iter = _dbus_list_pop_first_link (&expired_messages);
426 iter = _dbus_list_pop_first_link (&expired_messages))
428 DBusMessage *message = iter->data;
430 dbus_message_unref (message);
431 _dbus_list_free_link (iter);
436 * Wakes up the main loop if it is sleeping
437 * Needed if we're e.g. queueing outgoing messages
438 * on a thread while the mainloop sleeps.
440 * @param connection the connection.
443 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
445 if (connection->wakeup_main_function)
446 (*connection->wakeup_main_function) (connection->wakeup_main_data);
449 #ifdef DBUS_BUILD_TESTS
451 * Gets the locks so we can examine them
453 * @param connection the connection.
454 * @param mutex_loc return for the location of the main mutex pointer
455 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
456 * @param io_path_mutex_loc return location of the io_path mutex pointer
457 * @param dispatch_cond_loc return location of the dispatch conditional
459 * @param io_path_cond_loc return location of the io_path conditional
463 _dbus_connection_test_get_locks (DBusConnection *connection,
464 DBusMutex **mutex_loc,
465 DBusMutex **dispatch_mutex_loc,
466 DBusMutex **io_path_mutex_loc,
467 DBusCondVar **dispatch_cond_loc,
468 DBusCondVar **io_path_cond_loc)
470 *mutex_loc = (DBusMutex *) connection->mutex;
471 *dispatch_mutex_loc = (DBusMutex *) connection->dispatch_mutex;
472 *io_path_mutex_loc = (DBusMutex *) connection->io_path_mutex;
473 *dispatch_cond_loc = connection->dispatch_cond;
474 *io_path_cond_loc = connection->io_path_cond;
479 * Adds a message-containing list link to the incoming message queue,
480 * taking ownership of the link and the message's current refcount.
481 * Cannot fail due to lack of memory.
483 * @param connection the connection.
484 * @param link the message link to queue.
487 _dbus_connection_queue_received_message_link (DBusConnection *connection,
490 DBusPendingCall *pending;
491 dbus_uint32_t reply_serial;
492 DBusMessage *message;
494 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
496 _dbus_list_append_link (&connection->incoming_messages,
498 message = link->data;
500 /* If this is a reply we're waiting on, remove timeout for it */
501 reply_serial = dbus_message_get_reply_serial (message);
502 if (reply_serial != 0)
504 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
508 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
509 _dbus_connection_remove_timeout_unlocked (connection,
510 _dbus_pending_call_get_timeout_unlocked (pending));
512 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
518 connection->n_incoming += 1;
520 _dbus_connection_wakeup_mainloop (connection);
522 _dbus_verbose ("Message %p (%s %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
524 dbus_message_type_to_string (dbus_message_get_type (message)),
525 dbus_message_get_path (message) ?
526 dbus_message_get_path (message) :
528 dbus_message_get_interface (message) ?
529 dbus_message_get_interface (message) :
531 dbus_message_get_member (message) ?
532 dbus_message_get_member (message) :
534 dbus_message_get_signature (message),
535 dbus_message_get_reply_serial (message),
537 connection->n_incoming);
539 _dbus_message_trace_ref (message, -1, -1,
540 "_dbus_conection_queue_received_message_link");
544 * Adds a link + message to the incoming message queue.
545 * Can't fail. Takes ownership of both link and message.
547 * @param connection the connection.
548 * @param link the list node and message to queue.
552 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
555 HAVE_LOCK_CHECK (connection);
557 _dbus_list_append_link (&connection->incoming_messages, link);
559 connection->n_incoming += 1;
561 _dbus_connection_wakeup_mainloop (connection);
563 _dbus_message_trace_ref (link->data, -1, -1,
564 "_dbus_connection_queue_synthesized_message_link");
566 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
567 link->data, connection, connection->n_incoming);
572 * Checks whether there are messages in the outgoing message queue.
573 * Called with connection lock held.
575 * @param connection the connection.
576 * @returns #TRUE if the outgoing queue is non-empty.
579 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
581 HAVE_LOCK_CHECK (connection);
582 return connection->outgoing_messages != NULL;
586 * Checks whether there are messages in the outgoing message queue.
587 * Use dbus_connection_flush() to block until all outgoing
588 * messages have been written to the underlying transport
589 * (such as a socket).
591 * @param connection the connection.
592 * @returns #TRUE if the outgoing queue is non-empty.
595 dbus_connection_has_messages_to_send (DBusConnection *connection)
599 _dbus_return_val_if_fail (connection != NULL, FALSE);
601 CONNECTION_LOCK (connection);
602 v = _dbus_connection_has_messages_to_send_unlocked (connection);
603 CONNECTION_UNLOCK (connection);
609 * Gets the next outgoing message. The message remains in the
610 * queue, and the caller does not own a reference to it.
612 * @param connection the connection.
613 * @returns the message to be sent.
616 _dbus_connection_get_message_to_send (DBusConnection *connection)
618 HAVE_LOCK_CHECK (connection);
620 return _dbus_list_get_last (&connection->outgoing_messages);
624 * Notifies the connection that a message has been sent, so the
625 * message can be removed from the outgoing queue.
626 * Called with the connection lock held.
628 * @param connection the connection.
629 * @param message the message that was sent.
632 _dbus_connection_message_sent_unlocked (DBusConnection *connection,
633 DBusMessage *message)
637 HAVE_LOCK_CHECK (connection);
639 /* This can be called before we even complete authentication, since
640 * it's called on disconnect to clean up the outgoing queue.
641 * It's also called as we successfully send each message.
644 link = _dbus_list_get_last_link (&connection->outgoing_messages);
645 _dbus_assert (link != NULL);
646 _dbus_assert (link->data == message);
648 _dbus_list_unlink (&connection->outgoing_messages,
650 _dbus_list_prepend_link (&connection->expired_messages, link);
652 connection->n_outgoing -= 1;
654 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
656 dbus_message_type_to_string (dbus_message_get_type (message)),
657 dbus_message_get_path (message) ?
658 dbus_message_get_path (message) :
660 dbus_message_get_interface (message) ?
661 dbus_message_get_interface (message) :
663 dbus_message_get_member (message) ?
664 dbus_message_get_member (message) :
666 dbus_message_get_signature (message),
667 connection, connection->n_outgoing);
669 /* It's OK that in principle we call the notify function, because for the
670 * outgoing limit, there isn't one */
671 _dbus_message_remove_counter (message, connection->outgoing_counter);
673 /* The message will actually be unreffed when we unlock */
676 /** Function to be called in protected_change_watch() with refcount held */
677 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
679 /** Function to be called in protected_change_watch() with refcount held */
680 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
682 /** Function to be called in protected_change_watch() with refcount held */
683 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
685 dbus_bool_t enabled);
688 protected_change_watch (DBusConnection *connection,
690 DBusWatchAddFunction add_function,
691 DBusWatchRemoveFunction remove_function,
692 DBusWatchToggleFunction toggle_function,
697 HAVE_LOCK_CHECK (connection);
699 /* The original purpose of protected_change_watch() was to hold a
700 * ref on the connection while dropping the connection lock, then
701 * calling out to the app. This was a broken hack that did not
702 * work, since the connection was in a hosed state (no WatchList
703 * field) while calling out.
705 * So for now we'll just keep the lock while calling out. This means
706 * apps are not allowed to call DBusConnection methods inside a
707 * watch function or they will deadlock.
709 * The "real fix" is to use the _and_unlock() pattern found
710 * elsewhere in the code, to defer calling out to the app until
711 * we're about to drop locks and return flow of control to the app
714 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
717 if (connection->watches)
720 retval = (* add_function) (connection->watches, watch);
721 else if (remove_function)
724 (* remove_function) (connection->watches, watch);
729 (* toggle_function) (connection->watches, watch, enabled);
739 * Adds a watch using the connection's DBusAddWatchFunction if
740 * available. Otherwise records the watch to be added when said
741 * function is available. Also re-adds the watch if the
742 * DBusAddWatchFunction changes. May fail due to lack of memory.
743 * Connection lock should be held when calling this.
745 * @param connection the connection.
746 * @param watch the watch to add.
747 * @returns #TRUE on success.
750 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
753 return protected_change_watch (connection, watch,
754 _dbus_watch_list_add_watch,
759 * Removes a watch using the connection's DBusRemoveWatchFunction
760 * if available. It's an error to call this function on a watch
761 * that was not previously added.
762 * Connection lock should be held when calling this.
764 * @param connection the connection.
765 * @param watch the watch to remove.
768 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
771 protected_change_watch (connection, watch,
773 _dbus_watch_list_remove_watch,
778 * Toggles a watch and notifies app via connection's
779 * DBusWatchToggledFunction if available. It's an error to call this
780 * function on a watch that was not previously added.
781 * Connection lock should be held when calling this.
783 * @param connection the connection.
784 * @param watch the watch to toggle.
785 * @param enabled whether to enable or disable
788 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
792 _dbus_assert (watch != NULL);
794 protected_change_watch (connection, watch,
796 _dbus_watch_list_toggle_watch,
800 /** Function to be called in protected_change_timeout() with refcount held */
801 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
802 DBusTimeout *timeout);
803 /** Function to be called in protected_change_timeout() with refcount held */
804 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
805 DBusTimeout *timeout);
806 /** Function to be called in protected_change_timeout() with refcount held */
807 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
808 DBusTimeout *timeout,
809 dbus_bool_t enabled);
812 protected_change_timeout (DBusConnection *connection,
813 DBusTimeout *timeout,
814 DBusTimeoutAddFunction add_function,
815 DBusTimeoutRemoveFunction remove_function,
816 DBusTimeoutToggleFunction toggle_function,
821 HAVE_LOCK_CHECK (connection);
823 /* The original purpose of protected_change_timeout() was to hold a
824 * ref on the connection while dropping the connection lock, then
825 * calling out to the app. This was a broken hack that did not
826 * work, since the connection was in a hosed state (no TimeoutList
827 * field) while calling out.
829 * So for now we'll just keep the lock while calling out. This means
830 * apps are not allowed to call DBusConnection methods inside a
831 * timeout function or they will deadlock.
833 * The "real fix" is to use the _and_unlock() pattern found
834 * elsewhere in the code, to defer calling out to the app until
835 * we're about to drop locks and return flow of control to the app
838 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
841 if (connection->timeouts)
844 retval = (* add_function) (connection->timeouts, timeout);
845 else if (remove_function)
848 (* remove_function) (connection->timeouts, timeout);
853 (* toggle_function) (connection->timeouts, timeout, enabled);
862 * Adds a timeout using the connection's DBusAddTimeoutFunction if
863 * available. Otherwise records the timeout to be added when said
864 * function is available. Also re-adds the timeout if the
865 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
866 * The timeout will fire repeatedly until removed.
867 * Connection lock should be held when calling this.
869 * @param connection the connection.
870 * @param timeout the timeout to add.
871 * @returns #TRUE on success.
874 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
875 DBusTimeout *timeout)
877 return protected_change_timeout (connection, timeout,
878 _dbus_timeout_list_add_timeout,
883 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
884 * if available. It's an error to call this function on a timeout
885 * that was not previously added.
886 * Connection lock should be held when calling this.
888 * @param connection the connection.
889 * @param timeout the timeout to remove.
892 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
893 DBusTimeout *timeout)
895 protected_change_timeout (connection, timeout,
897 _dbus_timeout_list_remove_timeout,
902 * Toggles a timeout and notifies app via connection's
903 * DBusTimeoutToggledFunction if available. It's an error to call this
904 * function on a timeout that was not previously added.
905 * Connection lock should be held when calling this.
907 * @param connection the connection.
908 * @param timeout the timeout to toggle.
909 * @param enabled whether to enable or disable
912 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
913 DBusTimeout *timeout,
916 protected_change_timeout (connection, timeout,
918 _dbus_timeout_list_toggle_timeout,
923 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
924 DBusPendingCall *pending)
926 dbus_uint32_t reply_serial;
927 DBusTimeout *timeout;
929 HAVE_LOCK_CHECK (connection);
931 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
933 _dbus_assert (reply_serial != 0);
935 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
939 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
942 if (!_dbus_hash_table_insert_int (connection->pending_replies,
946 _dbus_connection_remove_timeout_unlocked (connection, timeout);
948 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
949 HAVE_LOCK_CHECK (connection);
953 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
957 if (!_dbus_hash_table_insert_int (connection->pending_replies,
961 HAVE_LOCK_CHECK (connection);
966 _dbus_pending_call_ref_unlocked (pending);
968 HAVE_LOCK_CHECK (connection);
974 free_pending_call_on_hash_removal (void *data)
976 DBusPendingCall *pending;
977 DBusConnection *connection;
984 connection = _dbus_pending_call_get_connection_unlocked (pending);
986 HAVE_LOCK_CHECK (connection);
988 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
990 _dbus_connection_remove_timeout_unlocked (connection,
991 _dbus_pending_call_get_timeout_unlocked (pending));
993 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
996 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
997 * here, but the pending call finalizer could in principle call out to
998 * application code so we pretty much have to... some larger code reorg
1001 _dbus_connection_ref_unlocked (connection);
1002 _dbus_pending_call_unref_and_unlock (pending);
1003 CONNECTION_LOCK (connection);
1004 _dbus_connection_unref_unlocked (connection);
1008 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
1009 DBusPendingCall *pending)
1011 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
1014 _dbus_hash_table_remove_int (connection->pending_replies,
1015 _dbus_pending_call_get_reply_serial_unlocked (pending));
1019 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
1020 DBusPendingCall *pending)
1022 /* The idea here is to avoid finalizing the pending call
1023 * with the lock held, since there's a destroy notifier
1024 * in pending call that goes out to application code.
1026 * There's an extra unlock inside the hash table
1027 * "free pending call" function FIXME...
1029 _dbus_pending_call_ref_unlocked (pending);
1030 _dbus_hash_table_remove_int (connection->pending_replies,
1031 _dbus_pending_call_get_reply_serial_unlocked (pending));
1033 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
1034 _dbus_connection_remove_timeout_unlocked (connection,
1035 _dbus_pending_call_get_timeout_unlocked (pending));
1037 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
1039 _dbus_pending_call_unref_and_unlock (pending);
1043 * Removes a pending call from the connection, such that
1044 * the pending reply will be ignored. May drop the last
1045 * reference to the pending call.
1047 * @param connection the connection
1048 * @param pending the pending call
1051 _dbus_connection_remove_pending_call (DBusConnection *connection,
1052 DBusPendingCall *pending)
1054 CONNECTION_LOCK (connection);
1055 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
1059 * Acquire the transporter I/O path. This must be done before
1060 * doing any I/O in the transporter. May sleep and drop the
1061 * IO path mutex while waiting for the I/O path.
1063 * @param connection the connection.
1064 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1065 * @returns TRUE if the I/O path was acquired.
1068 _dbus_connection_acquire_io_path (DBusConnection *connection,
1069 int timeout_milliseconds)
1071 dbus_bool_t we_acquired;
1073 HAVE_LOCK_CHECK (connection);
1075 /* We don't want the connection to vanish */
1076 _dbus_connection_ref_unlocked (connection);
1078 /* We will only touch io_path_acquired which is protected by our mutex */
1079 CONNECTION_UNLOCK (connection);
1081 _dbus_verbose ("locking io_path_mutex\n");
1082 _dbus_cmutex_lock (connection->io_path_mutex);
1084 _dbus_verbose ("start connection->io_path_acquired = %d timeout = %d\n",
1085 connection->io_path_acquired, timeout_milliseconds);
1087 we_acquired = FALSE;
1089 if (connection->io_path_acquired)
1091 if (timeout_milliseconds != -1)
1093 _dbus_verbose ("waiting %d for IO path to be acquirable\n",
1094 timeout_milliseconds);
1096 if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1097 connection->io_path_mutex,
1098 timeout_milliseconds))
1100 /* We timed out before anyone signaled. */
1101 /* (writing the loop to handle the !timedout case by
1102 * waiting longer if needed is a pain since dbus
1103 * wraps pthread_cond_timedwait to take a relative
1104 * time instead of absolute, something kind of stupid
1105 * on our part. for now it doesn't matter, we will just
1106 * end up back here eventually.)
1112 while (connection->io_path_acquired)
1114 _dbus_verbose ("waiting for IO path to be acquirable\n");
1115 _dbus_condvar_wait (connection->io_path_cond,
1116 connection->io_path_mutex);
1121 if (!connection->io_path_acquired)
1124 connection->io_path_acquired = TRUE;
1127 _dbus_verbose ("end connection->io_path_acquired = %d we_acquired = %d\n",
1128 connection->io_path_acquired, we_acquired);
1130 _dbus_verbose ("unlocking io_path_mutex\n");
1131 _dbus_cmutex_unlock (connection->io_path_mutex);
1133 CONNECTION_LOCK (connection);
1135 HAVE_LOCK_CHECK (connection);
1137 _dbus_connection_unref_unlocked (connection);
1143 * Release the I/O path when you're done with it. Only call
1144 * after you've acquired the I/O. Wakes up at most one thread
1145 * currently waiting to acquire the I/O path.
1147 * @param connection the connection.
1150 _dbus_connection_release_io_path (DBusConnection *connection)
1152 HAVE_LOCK_CHECK (connection);
1154 _dbus_verbose ("locking io_path_mutex\n");
1155 _dbus_cmutex_lock (connection->io_path_mutex);
1157 _dbus_assert (connection->io_path_acquired);
1159 _dbus_verbose ("start connection->io_path_acquired = %d\n",
1160 connection->io_path_acquired);
1162 connection->io_path_acquired = FALSE;
1163 _dbus_condvar_wake_one (connection->io_path_cond);
1165 _dbus_verbose ("unlocking io_path_mutex\n");
1166 _dbus_cmutex_unlock (connection->io_path_mutex);
1170 * Queues incoming messages and sends outgoing messages for this
1171 * connection, optionally blocking in the process. Each call to
1172 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1173 * time and then read or write data if possible.
1175 * The purpose of this function is to be able to flush outgoing
1176 * messages or queue up incoming messages without returning
1177 * control to the application and causing reentrancy weirdness.
1179 * The flags parameter allows you to specify whether to
1180 * read incoming messages, write outgoing messages, or both,
1181 * and whether to block if no immediate action is possible.
1183 * The timeout_milliseconds parameter does nothing unless the
1184 * iteration is blocking.
1186 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1187 * wasn't specified, then it's impossible to block, even if
1188 * you specify DBUS_ITERATION_BLOCK; in that case the function
1189 * returns immediately.
1191 * If pending is not NULL then a check is made if the pending call
1192 * is completed after the io path has been required. If the call
1193 * has been completed nothing is done. This must be done since
1194 * the _dbus_connection_acquire_io_path releases the connection
1197 * Called with connection lock held.
1199 * @param connection the connection.
1200 * @param pending the pending call that should be checked or NULL
1201 * @param flags iteration flags.
1202 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1205 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1206 DBusPendingCall *pending,
1208 int timeout_milliseconds)
1210 _dbus_verbose ("start\n");
1212 HAVE_LOCK_CHECK (connection);
1214 if (connection->n_outgoing == 0)
1215 flags &= ~DBUS_ITERATION_DO_WRITING;
1217 if (_dbus_connection_acquire_io_path (connection,
1218 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1220 HAVE_LOCK_CHECK (connection);
1222 if ( (pending != NULL) && _dbus_pending_call_get_completed_unlocked(pending))
1224 _dbus_verbose ("pending call completed while acquiring I/O path");
1226 else if ( (pending != NULL) &&
1227 _dbus_connection_peek_for_reply_unlocked (connection,
1228 _dbus_pending_call_get_reply_serial_unlocked (pending)))
1230 _dbus_verbose ("pending call completed while acquiring I/O path (reply found in queue)");
1234 _dbus_transport_do_iteration (connection->transport,
1235 flags, timeout_milliseconds);
1238 _dbus_connection_release_io_path (connection);
1241 HAVE_LOCK_CHECK (connection);
1243 _dbus_verbose ("end\n");
1247 * Creates a new connection for the given transport. A transport
1248 * represents a message stream that uses some concrete mechanism, such
1249 * as UNIX domain sockets. May return #NULL if insufficient
1250 * memory exists to create the connection.
1252 * @param transport the transport.
1253 * @returns the new connection, or #NULL on failure.
1256 _dbus_connection_new_for_transport (DBusTransport *transport)
1258 DBusConnection *connection;
1259 DBusWatchList *watch_list;
1260 DBusTimeoutList *timeout_list;
1261 DBusHashTable *pending_replies;
1262 DBusList *disconnect_link;
1263 DBusMessage *disconnect_message;
1264 DBusCounter *outgoing_counter;
1265 DBusObjectTree *objects;
1269 pending_replies = NULL;
1270 timeout_list = NULL;
1271 disconnect_link = NULL;
1272 disconnect_message = NULL;
1273 outgoing_counter = NULL;
1276 watch_list = _dbus_watch_list_new ();
1277 if (watch_list == NULL)
1280 timeout_list = _dbus_timeout_list_new ();
1281 if (timeout_list == NULL)
1285 _dbus_hash_table_new (DBUS_HASH_INT,
1287 (DBusFreeFunction)free_pending_call_on_hash_removal);
1288 if (pending_replies == NULL)
1291 connection = dbus_new0 (DBusConnection, 1);
1292 if (connection == NULL)
1295 _dbus_rmutex_new_at_location (&connection->mutex);
1296 if (connection->mutex == NULL)
1299 _dbus_cmutex_new_at_location (&connection->io_path_mutex);
1300 if (connection->io_path_mutex == NULL)
1303 _dbus_cmutex_new_at_location (&connection->dispatch_mutex);
1304 if (connection->dispatch_mutex == NULL)
1307 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1308 if (connection->dispatch_cond == NULL)
1311 _dbus_condvar_new_at_location (&connection->io_path_cond);
1312 if (connection->io_path_cond == NULL)
1315 _dbus_rmutex_new_at_location (&connection->slot_mutex);
1316 if (connection->slot_mutex == NULL)
1319 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1320 DBUS_INTERFACE_LOCAL,
1323 if (disconnect_message == NULL)
1326 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1327 if (disconnect_link == NULL)
1330 outgoing_counter = _dbus_counter_new ();
1331 if (outgoing_counter == NULL)
1334 objects = _dbus_object_tree_new (connection);
1335 if (objects == NULL)
1338 if (_dbus_modify_sigpipe)
1339 _dbus_disable_sigpipe ();
1341 /* initialized to 0: use atomic op to avoid mixing atomic and non-atomic */
1342 _dbus_atomic_inc (&connection->refcount);
1343 connection->transport = transport;
1344 connection->watches = watch_list;
1345 connection->timeouts = timeout_list;
1346 connection->pending_replies = pending_replies;
1347 connection->outgoing_counter = outgoing_counter;
1348 connection->filter_list = NULL;
1349 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1350 connection->objects = objects;
1351 connection->exit_on_disconnect = FALSE;
1352 connection->shareable = FALSE;
1353 connection->route_peer_messages = FALSE;
1354 connection->disconnected_message_arrived = FALSE;
1355 connection->disconnected_message_processed = FALSE;
1357 #ifndef DBUS_DISABLE_CHECKS
1358 connection->generation = _dbus_current_generation;
1361 _dbus_data_slot_list_init (&connection->slot_list);
1363 connection->client_serial = 1;
1365 connection->disconnect_message_link = disconnect_link;
1367 CONNECTION_LOCK (connection);
1369 if (!_dbus_transport_set_connection (transport, connection))
1371 CONNECTION_UNLOCK (connection);
1376 _dbus_transport_ref (transport);
1378 CONNECTION_UNLOCK (connection);
1380 _dbus_connection_trace_ref (connection, 0, 1, "new_for_transport");
1384 if (disconnect_message != NULL)
1385 dbus_message_unref (disconnect_message);
1387 if (disconnect_link != NULL)
1388 _dbus_list_free_link (disconnect_link);
1390 if (connection != NULL)
1392 _dbus_condvar_free_at_location (&connection->io_path_cond);
1393 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1394 _dbus_rmutex_free_at_location (&connection->mutex);
1395 _dbus_cmutex_free_at_location (&connection->io_path_mutex);
1396 _dbus_cmutex_free_at_location (&connection->dispatch_mutex);
1397 _dbus_rmutex_free_at_location (&connection->slot_mutex);
1398 dbus_free (connection);
1400 if (pending_replies)
1401 _dbus_hash_table_unref (pending_replies);
1404 _dbus_watch_list_free (watch_list);
1407 _dbus_timeout_list_free (timeout_list);
1409 if (outgoing_counter)
1410 _dbus_counter_unref (outgoing_counter);
1413 _dbus_object_tree_unref (objects);
1419 * Increments the reference count of a DBusConnection.
1420 * Requires that the caller already holds the connection lock.
1422 * @param connection the connection.
1423 * @returns the connection.
1426 _dbus_connection_ref_unlocked (DBusConnection *connection)
1428 dbus_int32_t old_refcount;
1430 _dbus_assert (connection != NULL);
1431 _dbus_assert (connection->generation == _dbus_current_generation);
1433 HAVE_LOCK_CHECK (connection);
1435 old_refcount = _dbus_atomic_inc (&connection->refcount);
1436 _dbus_connection_trace_ref (connection, old_refcount, old_refcount + 1,
1443 * Decrements the reference count of a DBusConnection.
1444 * Requires that the caller already holds the connection lock.
1446 * @param connection the connection.
1449 _dbus_connection_unref_unlocked (DBusConnection *connection)
1451 dbus_int32_t old_refcount;
1453 HAVE_LOCK_CHECK (connection);
1455 _dbus_assert (connection != NULL);
1457 old_refcount = _dbus_atomic_dec (&connection->refcount);
1459 _dbus_connection_trace_ref (connection, old_refcount, old_refcount - 1,
1462 if (old_refcount == 1)
1463 _dbus_connection_last_unref (connection);
1466 static dbus_uint32_t
1467 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1469 dbus_uint32_t serial;
1471 serial = connection->client_serial++;
1473 if (connection->client_serial == 0)
1474 connection->client_serial = 1;
1480 * A callback for use with dbus_watch_new() to create a DBusWatch.
1482 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1483 * and the virtual handle_watch in DBusTransport if we got rid of it.
1484 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1487 * @param watch the watch.
1488 * @param condition the current condition of the file descriptors being watched.
1489 * @param data must be a pointer to a #DBusConnection
1490 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1493 _dbus_connection_handle_watch (DBusWatch *watch,
1494 unsigned int condition,
1497 DBusConnection *connection;
1499 DBusDispatchStatus status;
1503 _dbus_verbose ("start\n");
1505 CONNECTION_LOCK (connection);
1507 if (!_dbus_connection_acquire_io_path (connection, 1))
1509 /* another thread is handling the message */
1510 CONNECTION_UNLOCK (connection);
1514 HAVE_LOCK_CHECK (connection);
1515 retval = _dbus_transport_handle_watch (connection->transport,
1518 _dbus_connection_release_io_path (connection);
1520 HAVE_LOCK_CHECK (connection);
1522 _dbus_verbose ("middle\n");
1524 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1526 /* this calls out to user code */
1527 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1529 _dbus_verbose ("end\n");
1534 /* Protected by _DBUS_LOCK (shared_connections) */
1535 static DBusHashTable *shared_connections = NULL;
1536 static DBusList *shared_connections_no_guid = NULL;
1539 close_connection_on_shutdown (DBusConnection *connection)
1541 DBusMessage *message;
1543 dbus_connection_ref (connection);
1544 _dbus_connection_close_possibly_shared (connection);
1546 /* Churn through to the Disconnected message */
1547 while ((message = dbus_connection_pop_message (connection)))
1549 dbus_message_unref (message);
1551 dbus_connection_unref (connection);
1555 shared_connections_shutdown (void *data)
1559 if (!_DBUS_LOCK (shared_connections))
1561 /* We'd have initialized locks before adding anything, so there
1562 * can't be anything there. */
1566 /* This is a little bit unpleasant... better ideas? */
1567 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1569 DBusConnection *connection;
1572 _dbus_hash_iter_init (shared_connections, &iter);
1573 _dbus_hash_iter_next (&iter);
1575 connection = _dbus_hash_iter_get_value (&iter);
1577 _DBUS_UNLOCK (shared_connections);
1578 close_connection_on_shutdown (connection);
1579 if (!_DBUS_LOCK (shared_connections))
1580 _dbus_assert_not_reached ("global locks were already initialized");
1582 /* The connection should now be dead and not in our hash ... */
1583 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1586 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1588 _dbus_hash_table_unref (shared_connections);
1589 shared_connections = NULL;
1591 if (shared_connections_no_guid != NULL)
1593 DBusConnection *connection;
1594 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1595 while (connection != NULL)
1597 _DBUS_UNLOCK (shared_connections);
1598 close_connection_on_shutdown (connection);
1599 if (!_DBUS_LOCK (shared_connections))
1600 _dbus_assert_not_reached ("global locks were already initialized");
1601 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1605 shared_connections_no_guid = NULL;
1607 _DBUS_UNLOCK (shared_connections);
1611 connection_lookup_shared (DBusAddressEntry *entry,
1612 DBusConnection **result)
1614 _dbus_verbose ("checking for existing connection\n");
1618 if (!_DBUS_LOCK (shared_connections))
1620 /* If it was shared, we'd have initialized global locks when we put
1621 * it in shared_connections. */
1625 if (shared_connections == NULL)
1627 _dbus_verbose ("creating shared_connections hash table\n");
1629 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1632 if (shared_connections == NULL)
1634 _DBUS_UNLOCK (shared_connections);
1638 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1640 _dbus_hash_table_unref (shared_connections);
1641 shared_connections = NULL;
1642 _DBUS_UNLOCK (shared_connections);
1646 _dbus_verbose (" successfully created shared_connections\n");
1648 _DBUS_UNLOCK (shared_connections);
1649 return TRUE; /* no point looking up in the hash we just made */
1655 guid = dbus_address_entry_get_value (entry, "guid");
1659 DBusConnection *connection;
1661 connection = _dbus_hash_table_lookup_string (shared_connections,
1666 /* The DBusConnection can't be finalized without taking
1667 * the shared_connections lock to remove it from the
1668 * hash. So it's safe to ref the connection here.
1669 * However, it may be disconnected if the Disconnected
1670 * message hasn't been processed yet, in which case we
1671 * want to pretend it isn't in the hash and avoid
1674 * The idea is to avoid ever returning a disconnected connection
1675 * from dbus_connection_open(). We could just synchronously
1676 * drop our shared ref to the connection on connection disconnect,
1677 * and then assert here that the connection is connected, but
1678 * that causes reentrancy headaches.
1680 CONNECTION_LOCK (connection);
1681 if (_dbus_connection_get_is_connected_unlocked (connection))
1683 _dbus_connection_ref_unlocked (connection);
1684 *result = connection;
1685 _dbus_verbose ("looked up existing connection to server guid %s\n",
1690 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1693 CONNECTION_UNLOCK (connection);
1697 _DBUS_UNLOCK (shared_connections);
1703 connection_record_shared_unlocked (DBusConnection *connection,
1707 char *guid_in_connection;
1709 HAVE_LOCK_CHECK (connection);
1710 _dbus_assert (connection->server_guid == NULL);
1711 _dbus_assert (connection->shareable);
1713 /* get a hard ref on this connection, even if
1714 * we won't in fact store it in the hash, we still
1715 * need to hold a ref on it until it's disconnected.
1717 _dbus_connection_ref_unlocked (connection);
1721 if (!_DBUS_LOCK (shared_connections))
1724 if (!_dbus_list_prepend (&shared_connections_no_guid, connection))
1726 _DBUS_UNLOCK (shared_connections);
1730 _DBUS_UNLOCK (shared_connections);
1731 return TRUE; /* don't store in the hash */
1734 /* A separate copy of the key is required in the hash table, because
1735 * we don't have a lock on the connection when we are doing a hash
1739 guid_key = _dbus_strdup (guid);
1740 if (guid_key == NULL)
1743 guid_in_connection = _dbus_strdup (guid);
1744 if (guid_in_connection == NULL)
1746 dbus_free (guid_key);
1750 if (!_DBUS_LOCK (shared_connections))
1752 dbus_free (guid_in_connection);
1753 dbus_free (guid_key);
1757 _dbus_assert (shared_connections != NULL);
1759 if (!_dbus_hash_table_insert_string (shared_connections,
1760 guid_key, connection))
1762 dbus_free (guid_key);
1763 dbus_free (guid_in_connection);
1764 _DBUS_UNLOCK (shared_connections);
1768 connection->server_guid = guid_in_connection;
1770 _dbus_verbose ("stored connection to %s to be shared\n",
1771 connection->server_guid);
1773 _DBUS_UNLOCK (shared_connections);
1775 _dbus_assert (connection->server_guid != NULL);
1781 connection_forget_shared_unlocked (DBusConnection *connection)
1783 HAVE_LOCK_CHECK (connection);
1785 if (!connection->shareable)
1788 if (!_DBUS_LOCK (shared_connections))
1790 /* If it was shared, we'd have initialized global locks when we put
1791 * it in the table; so it can't be there. */
1795 if (connection->server_guid != NULL)
1797 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1798 connection->server_guid);
1800 if (!_dbus_hash_table_remove_string (shared_connections,
1801 connection->server_guid))
1802 _dbus_assert_not_reached ("connection was not in the shared table");
1804 dbus_free (connection->server_guid);
1805 connection->server_guid = NULL;
1809 _dbus_list_remove (&shared_connections_no_guid, connection);
1812 _DBUS_UNLOCK (shared_connections);
1814 /* remove our reference held on all shareable connections */
1815 _dbus_connection_unref_unlocked (connection);
1818 static DBusConnection*
1819 connection_try_from_address_entry (DBusAddressEntry *entry,
1822 DBusTransport *transport;
1823 DBusConnection *connection;
1825 transport = _dbus_transport_open (entry, error);
1827 if (transport == NULL)
1829 _DBUS_ASSERT_ERROR_IS_SET (error);
1833 connection = _dbus_connection_new_for_transport (transport);
1835 _dbus_transport_unref (transport);
1837 if (connection == NULL)
1839 _DBUS_SET_OOM (error);
1843 #ifndef DBUS_DISABLE_CHECKS
1844 _dbus_assert (!connection->have_connection_lock);
1850 * If the shared parameter is true, then any existing connection will
1851 * be used (and if a new connection is created, it will be available
1852 * for use by others). If the shared parameter is false, a new
1853 * connection will always be created, and the new connection will
1854 * never be returned to other callers.
1856 * @param address the address
1857 * @param shared whether the connection is shared or private
1858 * @param error error return
1859 * @returns the connection or #NULL on error
1861 static DBusConnection*
1862 _dbus_connection_open_internal (const char *address,
1866 DBusConnection *connection;
1867 DBusAddressEntry **entries;
1868 DBusError tmp_error = DBUS_ERROR_INIT;
1869 DBusError first_error = DBUS_ERROR_INIT;
1872 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1874 _dbus_verbose ("opening %s connection to: %s\n",
1875 shared ? "shared" : "private", address);
1877 if (!dbus_parse_address (address, &entries, &len, error))
1880 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1884 for (i = 0; i < len; i++)
1888 if (!connection_lookup_shared (entries[i], &connection))
1889 _DBUS_SET_OOM (&tmp_error);
1892 if (connection == NULL)
1894 connection = connection_try_from_address_entry (entries[i],
1897 if (connection != NULL && shared)
1901 connection->shareable = TRUE;
1903 /* guid may be NULL */
1904 guid = dbus_address_entry_get_value (entries[i], "guid");
1906 CONNECTION_LOCK (connection);
1908 if (!connection_record_shared_unlocked (connection, guid))
1910 _DBUS_SET_OOM (&tmp_error);
1911 _dbus_connection_close_possibly_shared_and_unlock (connection);
1912 dbus_connection_unref (connection);
1916 CONNECTION_UNLOCK (connection);
1923 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1926 dbus_move_error (&tmp_error, &first_error);
1928 dbus_error_free (&tmp_error);
1931 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1932 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1934 if (connection == NULL)
1936 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1937 dbus_move_error (&first_error, error);
1940 dbus_error_free (&first_error);
1942 dbus_address_entries_free (entries);
1947 * Closes a shared OR private connection, while dbus_connection_close() can
1948 * only be used on private connections. Should only be called by the
1949 * dbus code that owns the connection - an owner must be known,
1950 * the open/close state is like malloc/free, not like ref/unref.
1952 * @param connection the connection
1955 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1957 _dbus_assert (connection != NULL);
1958 _dbus_assert (connection->generation == _dbus_current_generation);
1960 CONNECTION_LOCK (connection);
1961 _dbus_connection_close_possibly_shared_and_unlock (connection);
1964 static DBusPreallocatedSend*
1965 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1967 DBusPreallocatedSend *preallocated;
1969 HAVE_LOCK_CHECK (connection);
1971 _dbus_assert (connection != NULL);
1973 preallocated = dbus_new (DBusPreallocatedSend, 1);
1974 if (preallocated == NULL)
1977 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1978 if (preallocated->queue_link == NULL)
1981 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1982 if (preallocated->counter_link == NULL)
1985 _dbus_counter_ref (preallocated->counter_link->data);
1987 preallocated->connection = connection;
1989 return preallocated;
1992 _dbus_list_free_link (preallocated->queue_link);
1994 dbus_free (preallocated);
1999 /* Called with lock held, does not update dispatch status */
2001 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
2002 DBusPreallocatedSend *preallocated,
2003 DBusMessage *message,
2004 dbus_uint32_t *client_serial)
2006 dbus_uint32_t serial;
2008 preallocated->queue_link->data = message;
2009 _dbus_list_prepend_link (&connection->outgoing_messages,
2010 preallocated->queue_link);
2012 /* It's OK that we'll never call the notify function, because for the
2013 * outgoing limit, there isn't one */
2014 _dbus_message_add_counter_link (message,
2015 preallocated->counter_link);
2017 dbus_free (preallocated);
2018 preallocated = NULL;
2020 dbus_message_ref (message);
2022 connection->n_outgoing += 1;
2024 _dbus_verbose ("Message %p (%s %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
2026 dbus_message_type_to_string (dbus_message_get_type (message)),
2027 dbus_message_get_path (message) ?
2028 dbus_message_get_path (message) :
2030 dbus_message_get_interface (message) ?
2031 dbus_message_get_interface (message) :
2033 dbus_message_get_member (message) ?
2034 dbus_message_get_member (message) :
2036 dbus_message_get_signature (message),
2037 dbus_message_get_destination (message) ?
2038 dbus_message_get_destination (message) :
2041 connection->n_outgoing);
2043 if (dbus_message_get_serial (message) == 0)
2045 serial = _dbus_connection_get_next_client_serial (connection);
2046 dbus_message_set_serial (message, serial);
2048 *client_serial = serial;
2053 *client_serial = dbus_message_get_serial (message);
2056 _dbus_verbose ("Message %p serial is %u\n",
2057 message, dbus_message_get_serial (message));
2059 dbus_message_lock (message);
2061 /* Now we need to run an iteration to hopefully just write the messages
2062 * out immediately, and otherwise get them queued up
2064 _dbus_connection_do_iteration_unlocked (connection,
2066 DBUS_ITERATION_DO_WRITING,
2069 /* If stuff is still queued up, be sure we wake up the main loop */
2070 if (connection->n_outgoing > 0)
2071 _dbus_connection_wakeup_mainloop (connection);
2075 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2076 DBusPreallocatedSend *preallocated,
2077 DBusMessage *message,
2078 dbus_uint32_t *client_serial)
2080 DBusDispatchStatus status;
2082 HAVE_LOCK_CHECK (connection);
2084 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2086 message, client_serial);
2088 _dbus_verbose ("middle\n");
2089 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2091 /* this calls out to user code */
2092 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2096 * Like dbus_connection_send(), but assumes the connection
2097 * is already locked on function entry, and unlocks before returning.
2099 * @param connection the connection
2100 * @param message the message to send
2101 * @param client_serial return location for client serial of sent message
2102 * @returns #FALSE on out-of-memory
2105 _dbus_connection_send_and_unlock (DBusConnection *connection,
2106 DBusMessage *message,
2107 dbus_uint32_t *client_serial)
2109 DBusPreallocatedSend *preallocated;
2111 _dbus_assert (connection != NULL);
2112 _dbus_assert (message != NULL);
2114 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2115 if (preallocated == NULL)
2117 CONNECTION_UNLOCK (connection);
2121 _dbus_connection_send_preallocated_and_unlock (connection,
2129 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2130 * If the new connection function does not ref the connection, we want to close it.
2132 * A bit of a hack, probably the new connection function should have returned a value
2133 * for whether to close, or should have had to close the connection itself if it
2136 * But, this works OK as long as the new connection function doesn't do anything
2137 * crazy like keep the connection around without ref'ing it.
2139 * We have to lock the connection across refcount check and close in case
2140 * the new connection function spawns a thread that closes and unrefs.
2141 * In that case, if the app thread
2142 * closes and unrefs first, we'll harmlessly close again; if the app thread
2143 * still has the ref, we'll close and then the app will close harmlessly.
2144 * If the app unrefs without closing, the app is broken since if the
2145 * app refs from the new connection function it is supposed to also close.
2147 * If we didn't atomically check the refcount and close with the lock held
2148 * though, we could screw this up.
2150 * @param connection the connection
2153 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2155 dbus_int32_t refcount;
2157 CONNECTION_LOCK (connection);
2159 refcount = _dbus_atomic_get (&connection->refcount);
2160 /* The caller should have at least one ref */
2161 _dbus_assert (refcount >= 1);
2164 _dbus_connection_close_possibly_shared_and_unlock (connection);
2166 CONNECTION_UNLOCK (connection);
2171 * When a function that blocks has been called with a timeout, and we
2172 * run out of memory, the time to wait for memory is based on the
2173 * timeout. If the caller was willing to block a long time we wait a
2174 * relatively long time for memory, if they were only willing to block
2175 * briefly then we retry for memory at a rapid rate.
2177 * @timeout_milliseconds the timeout requested for blocking
2180 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2182 if (timeout_milliseconds == -1)
2183 _dbus_sleep_milliseconds (1000);
2184 else if (timeout_milliseconds < 100)
2185 ; /* just busy loop */
2186 else if (timeout_milliseconds <= 1000)
2187 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2189 _dbus_sleep_milliseconds (1000);
2192 static DBusMessage *
2193 generate_local_error_message (dbus_uint32_t serial,
2197 DBusMessage *message;
2198 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2202 if (!dbus_message_set_error_name (message, error_name))
2204 dbus_message_unref (message);
2209 dbus_message_set_no_reply (message, TRUE);
2211 if (!dbus_message_set_reply_serial (message,
2214 dbus_message_unref (message);
2219 if (error_msg != NULL)
2221 DBusMessageIter iter;
2223 dbus_message_iter_init_append (message, &iter);
2224 if (!dbus_message_iter_append_basic (&iter,
2228 dbus_message_unref (message);
2239 * Peek the incoming queue to see if we got reply for a specific serial
2242 _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
2243 dbus_uint32_t client_serial)
2246 HAVE_LOCK_CHECK (connection);
2248 link = _dbus_list_get_first_link (&connection->incoming_messages);
2250 while (link != NULL)
2252 DBusMessage *reply = link->data;
2254 if (dbus_message_get_reply_serial (reply) == client_serial)
2256 _dbus_verbose ("%s reply to %d found in queue\n", _DBUS_FUNCTION_NAME, client_serial);
2259 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2265 /* This is slightly strange since we can pop a message here without
2266 * the dispatch lock.
2269 check_for_reply_unlocked (DBusConnection *connection,
2270 dbus_uint32_t client_serial)
2274 HAVE_LOCK_CHECK (connection);
2276 link = _dbus_list_get_first_link (&connection->incoming_messages);
2278 while (link != NULL)
2280 DBusMessage *reply = link->data;
2282 if (dbus_message_get_reply_serial (reply) == client_serial)
2284 _dbus_list_remove_link (&connection->incoming_messages, link);
2285 connection->n_incoming -= 1;
2288 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2295 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2297 /* We can't iterate over the hash in the normal way since we'll be
2298 * dropping the lock for each item. So we restart the
2299 * iter each time as we drain the hash table.
2302 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2304 DBusPendingCall *pending;
2307 _dbus_hash_iter_init (connection->pending_replies, &iter);
2308 _dbus_hash_iter_next (&iter);
2310 pending = _dbus_hash_iter_get_value (&iter);
2311 _dbus_pending_call_ref_unlocked (pending);
2313 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2316 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
2317 _dbus_connection_remove_timeout_unlocked (connection,
2318 _dbus_pending_call_get_timeout_unlocked (pending));
2319 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2320 _dbus_hash_iter_remove_entry (&iter);
2322 _dbus_pending_call_unref_and_unlock (pending);
2323 CONNECTION_LOCK (connection);
2325 HAVE_LOCK_CHECK (connection);
2329 complete_pending_call_and_unlock (DBusConnection *connection,
2330 DBusPendingCall *pending,
2331 DBusMessage *message)
2333 _dbus_pending_call_set_reply_unlocked (pending, message);
2334 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2335 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2337 /* Must be called unlocked since it invokes app callback */
2338 _dbus_pending_call_complete (pending);
2339 dbus_pending_call_unref (pending);
2343 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2344 DBusPendingCall *pending)
2347 DBusDispatchStatus status;
2349 reply = check_for_reply_unlocked (connection,
2350 _dbus_pending_call_get_reply_serial_unlocked (pending));
2353 _dbus_verbose ("checked for reply\n");
2355 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2357 complete_pending_call_and_unlock (connection, pending, reply);
2358 dbus_message_unref (reply);
2360 CONNECTION_LOCK (connection);
2361 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2362 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2363 dbus_pending_call_unref (pending);
2372 * Blocks until a pending call times out or gets a reply.
2374 * Does not re-enter the main loop or run filter/path-registered
2375 * callbacks. The reply to the message will not be seen by
2378 * Returns immediately if pending call already got a reply.
2380 * @todo could use performance improvements (it keeps scanning
2381 * the whole message queue for example)
2383 * @param pending the pending call we block for a reply on
2386 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2388 long start_tv_sec, start_tv_usec;
2389 long tv_sec, tv_usec;
2390 DBusDispatchStatus status;
2391 DBusConnection *connection;
2392 dbus_uint32_t client_serial;
2393 DBusTimeout *timeout;
2394 int timeout_milliseconds, elapsed_milliseconds;
2396 _dbus_assert (pending != NULL);
2398 if (dbus_pending_call_get_completed (pending))
2401 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2403 connection = _dbus_pending_call_get_connection_and_lock (pending);
2405 /* Flush message queue - note, can affect dispatch status */
2406 _dbus_connection_flush_unlocked (connection);
2408 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2410 /* note that timeout_milliseconds is limited to a smallish value
2411 * in _dbus_pending_call_new() so overflows aren't possible
2414 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
2415 _dbus_get_monotonic_time (&start_tv_sec, &start_tv_usec);
2418 timeout_milliseconds = dbus_timeout_get_interval (timeout);
2420 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec\n",
2421 timeout_milliseconds,
2423 start_tv_sec, start_tv_usec);
2427 timeout_milliseconds = -1;
2429 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block for reply serial %u\n", client_serial);
2432 /* check to see if we already got the data off the socket */
2433 /* from another blocked pending call */
2434 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2437 /* Now we wait... */
2438 /* always block at least once as we know we don't have the reply yet */
2439 _dbus_connection_do_iteration_unlocked (connection,
2441 DBUS_ITERATION_DO_READING |
2442 DBUS_ITERATION_BLOCK,
2443 timeout_milliseconds);
2447 _dbus_verbose ("top of recheck\n");
2449 HAVE_LOCK_CHECK (connection);
2451 /* queue messages and get status */
2453 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2455 /* the get_completed() is in case a dispatch() while we were blocking
2456 * got the reply instead of us.
2458 if (_dbus_pending_call_get_completed_unlocked (pending))
2460 _dbus_verbose ("Pending call completed by dispatch\n");
2461 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2462 dbus_pending_call_unref (pending);
2466 if (status == DBUS_DISPATCH_DATA_REMAINS)
2468 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2472 _dbus_get_monotonic_time (&tv_sec, &tv_usec);
2473 elapsed_milliseconds = (tv_sec - start_tv_sec) * 1000 +
2474 (tv_usec - start_tv_usec) / 1000;
2476 if (!_dbus_connection_get_is_connected_unlocked (connection))
2478 DBusMessage *error_msg;
2480 error_msg = generate_local_error_message (client_serial,
2481 DBUS_ERROR_DISCONNECTED,
2482 "Connection was disconnected before a reply was received");
2484 /* on OOM error_msg is set to NULL */
2485 complete_pending_call_and_unlock (connection, pending, error_msg);
2486 dbus_pending_call_unref (pending);
2489 else if (connection->disconnect_message_link == NULL)
2490 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2491 else if (timeout == NULL)
2493 if (status == DBUS_DISPATCH_NEED_MEMORY)
2495 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2496 * we may already have a reply in the buffer and just can't process
2499 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2501 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2505 /* block again, we don't have the reply buffered yet. */
2506 _dbus_connection_do_iteration_unlocked (connection,
2508 DBUS_ITERATION_DO_READING |
2509 DBUS_ITERATION_BLOCK,
2510 timeout_milliseconds - elapsed_milliseconds);
2513 goto recheck_status;
2515 else if (tv_sec < start_tv_sec)
2516 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2517 else if (elapsed_milliseconds < timeout_milliseconds)
2519 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds - elapsed_milliseconds);
2521 if (status == DBUS_DISPATCH_NEED_MEMORY)
2523 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2524 * we may already have a reply in the buffer and just can't process
2527 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2529 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2533 /* block again, we don't have the reply buffered yet. */
2534 _dbus_connection_do_iteration_unlocked (connection,
2536 DBUS_ITERATION_DO_READING |
2537 DBUS_ITERATION_BLOCK,
2538 timeout_milliseconds - elapsed_milliseconds);
2541 goto recheck_status;
2544 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %d milliseconds and got no reply\n",
2545 elapsed_milliseconds);
2547 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2549 /* unlock and call user code */
2550 complete_pending_call_and_unlock (connection, pending, NULL);
2552 /* update user code on dispatch status */
2553 CONNECTION_LOCK (connection);
2554 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2555 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2556 dbus_pending_call_unref (pending);
2562 * @addtogroup DBusConnection
2568 * Gets a connection to a remote address. If a connection to the given
2569 * address already exists, returns the existing connection with its
2570 * reference count incremented. Otherwise, returns a new connection
2571 * and saves the new connection for possible re-use if a future call
2572 * to dbus_connection_open() asks to connect to the same server.
2574 * Use dbus_connection_open_private() to get a dedicated connection
2575 * not shared with other callers of dbus_connection_open().
2577 * If the open fails, the function returns #NULL, and provides a
2578 * reason for the failure in the error parameter. Pass #NULL for the
2579 * error parameter if you aren't interested in the reason for
2582 * Because this connection is shared, no user of the connection
2583 * may call dbus_connection_close(). However, when you are done with the
2584 * connection you should call dbus_connection_unref().
2586 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2587 * unless you have good reason; connections are expensive enough
2588 * that it's wasteful to create lots of connections to the same
2591 * @param address the address.
2592 * @param error address where an error can be returned.
2593 * @returns new connection, or #NULL on failure.
2596 dbus_connection_open (const char *address,
2599 DBusConnection *connection;
2601 _dbus_return_val_if_fail (address != NULL, NULL);
2602 _dbus_return_val_if_error_is_set (error, NULL);
2604 connection = _dbus_connection_open_internal (address,
2612 * Opens a new, dedicated connection to a remote address. Unlike
2613 * dbus_connection_open(), always creates a new connection.
2614 * This connection will not be saved or recycled by libdbus.
2616 * If the open fails, the function returns #NULL, and provides a
2617 * reason for the failure in the error parameter. Pass #NULL for the
2618 * error parameter if you aren't interested in the reason for
2621 * When you are done with this connection, you must
2622 * dbus_connection_close() to disconnect it,
2623 * and dbus_connection_unref() to free the connection object.
2625 * (The dbus_connection_close() can be skipped if the
2626 * connection is already known to be disconnected, for example
2627 * if you are inside a handler for the Disconnected signal.)
2629 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2630 * unless you have good reason; connections are expensive enough
2631 * that it's wasteful to create lots of connections to the same
2634 * @param address the address.
2635 * @param error address where an error can be returned.
2636 * @returns new connection, or #NULL on failure.
2639 dbus_connection_open_private (const char *address,
2642 DBusConnection *connection;
2644 _dbus_return_val_if_fail (address != NULL, NULL);
2645 _dbus_return_val_if_error_is_set (error, NULL);
2647 connection = _dbus_connection_open_internal (address,
2655 * Increments the reference count of a DBusConnection.
2657 * @param connection the connection.
2658 * @returns the connection.
2661 dbus_connection_ref (DBusConnection *connection)
2663 dbus_int32_t old_refcount;
2665 _dbus_return_val_if_fail (connection != NULL, NULL);
2666 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2667 old_refcount = _dbus_atomic_inc (&connection->refcount);
2668 _dbus_connection_trace_ref (connection, old_refcount, old_refcount + 1,
2675 free_outgoing_message (void *element,
2678 DBusMessage *message = element;
2679 DBusConnection *connection = data;
2681 _dbus_message_remove_counter (message, connection->outgoing_counter);
2682 dbus_message_unref (message);
2685 /* This is run without the mutex held, but after the last reference
2686 * to the connection has been dropped we should have no thread-related
2690 _dbus_connection_last_unref (DBusConnection *connection)
2694 _dbus_verbose ("Finalizing connection %p\n", connection);
2696 _dbus_assert (_dbus_atomic_get (&connection->refcount) == 0);
2698 /* You have to disconnect the connection before unref:ing it. Otherwise
2699 * you won't get the disconnected message.
2701 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2702 _dbus_assert (connection->server_guid == NULL);
2704 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2705 _dbus_object_tree_free_all_unlocked (connection->objects);
2707 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2708 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2709 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2711 _dbus_watch_list_free (connection->watches);
2712 connection->watches = NULL;
2714 _dbus_timeout_list_free (connection->timeouts);
2715 connection->timeouts = NULL;
2717 _dbus_data_slot_list_free (&connection->slot_list);
2719 link = _dbus_list_get_first_link (&connection->filter_list);
2720 while (link != NULL)
2722 DBusMessageFilter *filter = link->data;
2723 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2725 filter->function = NULL;
2726 _dbus_message_filter_unref (filter); /* calls app callback */
2731 _dbus_list_clear (&connection->filter_list);
2733 /* ---- Done with stuff that invokes application callbacks */
2735 _dbus_object_tree_unref (connection->objects);
2737 _dbus_hash_table_unref (connection->pending_replies);
2738 connection->pending_replies = NULL;
2740 _dbus_list_clear (&connection->filter_list);
2742 _dbus_list_foreach (&connection->outgoing_messages,
2743 free_outgoing_message,
2745 _dbus_list_clear (&connection->outgoing_messages);
2747 _dbus_list_foreach (&connection->incoming_messages,
2748 (DBusForeachFunction) dbus_message_unref,
2750 _dbus_list_clear (&connection->incoming_messages);
2752 _dbus_counter_unref (connection->outgoing_counter);
2754 _dbus_transport_unref (connection->transport);
2756 if (connection->disconnect_message_link)
2758 DBusMessage *message = connection->disconnect_message_link->data;
2759 dbus_message_unref (message);
2760 _dbus_list_free_link (connection->disconnect_message_link);
2763 _dbus_condvar_free_at_location (&connection->dispatch_cond);
2764 _dbus_condvar_free_at_location (&connection->io_path_cond);
2766 _dbus_cmutex_free_at_location (&connection->io_path_mutex);
2767 _dbus_cmutex_free_at_location (&connection->dispatch_mutex);
2769 _dbus_rmutex_free_at_location (&connection->slot_mutex);
2771 _dbus_rmutex_free_at_location (&connection->mutex);
2773 dbus_free (connection);
2777 * Decrements the reference count of a DBusConnection, and finalizes
2778 * it if the count reaches zero.
2780 * Note: it is a bug to drop the last reference to a connection that
2781 * is still connected.
2783 * For shared connections, libdbus will own a reference
2784 * as long as the connection is connected, so you can know that either
2785 * you don't have the last reference, or it's OK to drop the last reference.
2786 * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2787 * return shared connections.
2789 * For private connections, the creator of the connection must arrange for
2790 * dbus_connection_close() to be called prior to dropping the last reference.
2791 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2793 * @param connection the connection.
2796 dbus_connection_unref (DBusConnection *connection)
2798 dbus_int32_t old_refcount;
2800 _dbus_return_if_fail (connection != NULL);
2801 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2803 old_refcount = _dbus_atomic_dec (&connection->refcount);
2805 _dbus_connection_trace_ref (connection, old_refcount, old_refcount - 1,
2808 if (old_refcount == 1)
2810 #ifndef DBUS_DISABLE_CHECKS
2811 if (_dbus_transport_get_is_connected (connection->transport))
2813 _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",
2814 connection->shareable ?
2815 "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2816 "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2820 _dbus_connection_last_unref (connection);
2825 * Note that the transport can disconnect itself (other end drops us)
2826 * and in that case this function never runs. So this function must
2827 * not do anything more than disconnect the transport and update the
2830 * If the transport self-disconnects, then we assume someone will
2831 * dispatch the connection to cause the dispatch status update.
2834 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2836 DBusDispatchStatus status;
2838 HAVE_LOCK_CHECK (connection);
2840 _dbus_verbose ("Disconnecting %p\n", connection);
2842 /* We need to ref because update_dispatch_status_and_unlock will unref
2843 * the connection if it was shared and libdbus was the only remaining
2846 _dbus_connection_ref_unlocked (connection);
2848 _dbus_transport_disconnect (connection->transport);
2850 /* This has the side effect of queuing the disconnect message link
2851 * (unless we don't have enough memory, possibly, so don't assert it).
2852 * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2853 * should never again return the newly-disconnected connection.
2855 * However, we only unref the shared connection and exit_on_disconnect when
2856 * the disconnect message reaches the head of the message queue,
2857 * NOT when it's first queued.
2859 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2861 /* This calls out to user code */
2862 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2864 /* Could also call out to user code */
2865 dbus_connection_unref (connection);
2869 * Closes a private connection, so no further data can be sent or received.
2870 * This disconnects the transport (such as a socket) underlying the
2873 * Attempts to send messages after closing a connection are safe, but will result in
2874 * error replies generated locally in libdbus.
2876 * This function does not affect the connection's reference count. It's
2877 * safe to close a connection more than once; all calls after the
2878 * first do nothing. It's impossible to "reopen" a connection, a
2879 * new connection must be created. This function may result in a call
2880 * to the DBusDispatchStatusFunction set with
2881 * dbus_connection_set_dispatch_status_function(), as the disconnect
2882 * message it generates needs to be dispatched.
2884 * If a connection is dropped by the remote application, it will
2887 * You must close a connection prior to releasing the last reference to
2888 * the connection. If you dbus_connection_unref() for the last time
2889 * without closing the connection, the results are undefined; it
2890 * is a bug in your program and libdbus will try to print a warning.
2892 * You may not close a shared connection. Connections created with
2893 * dbus_connection_open() or dbus_bus_get() are shared.
2894 * These connections are owned by libdbus, and applications should
2895 * only unref them, never close them. Applications can know it is
2896 * safe to unref these connections because libdbus will be holding a
2897 * reference as long as the connection is open. Thus, either the
2898 * connection is closed and it is OK to drop the last reference,
2899 * or the connection is open and the app knows it does not have the
2902 * Connections created with dbus_connection_open_private() or
2903 * dbus_bus_get_private() are not kept track of or referenced by
2904 * libdbus. The creator of these connections is responsible for
2905 * calling dbus_connection_close() prior to releasing the last
2906 * reference, if the connection is not already disconnected.
2908 * @param connection the private (unshared) connection to close
2911 dbus_connection_close (DBusConnection *connection)
2913 _dbus_return_if_fail (connection != NULL);
2914 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2916 CONNECTION_LOCK (connection);
2918 #ifndef DBUS_DISABLE_CHECKS
2919 if (connection->shareable)
2921 CONNECTION_UNLOCK (connection);
2923 _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2928 _dbus_connection_close_possibly_shared_and_unlock (connection);
2932 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2934 HAVE_LOCK_CHECK (connection);
2935 return _dbus_transport_get_is_connected (connection->transport);
2939 * Gets whether the connection is currently open. A connection may
2940 * become disconnected when the remote application closes its end, or
2941 * exits; a connection may also be disconnected with
2942 * dbus_connection_close().
2944 * There are not separate states for "closed" and "disconnected," the two
2945 * terms are synonymous. This function should really be called
2946 * get_is_open() but for historical reasons is not.
2948 * @param connection the connection.
2949 * @returns #TRUE if the connection is still alive.
2952 dbus_connection_get_is_connected (DBusConnection *connection)
2956 _dbus_return_val_if_fail (connection != NULL, FALSE);
2958 CONNECTION_LOCK (connection);
2959 res = _dbus_connection_get_is_connected_unlocked (connection);
2960 CONNECTION_UNLOCK (connection);
2966 * Gets whether the connection was authenticated. (Note that
2967 * if the connection was authenticated then disconnected,
2968 * this function still returns #TRUE)
2970 * @param connection the connection
2971 * @returns #TRUE if the connection was ever authenticated
2974 dbus_connection_get_is_authenticated (DBusConnection *connection)
2978 _dbus_return_val_if_fail (connection != NULL, FALSE);
2980 CONNECTION_LOCK (connection);
2981 res = _dbus_transport_get_is_authenticated (connection->transport);
2982 CONNECTION_UNLOCK (connection);
2988 * Gets whether the connection is not authenticated as a specific
2989 * user. If the connection is not authenticated, this function
2990 * returns #TRUE, and if it is authenticated but as an anonymous user,
2991 * it returns #TRUE. If it is authenticated as a specific user, then
2992 * this returns #FALSE. (Note that if the connection was authenticated
2993 * as anonymous then disconnected, this function still returns #TRUE.)
2995 * If the connection is not anonymous, you can use
2996 * dbus_connection_get_unix_user() and
2997 * dbus_connection_get_windows_user() to see who it's authorized as.
2999 * If you want to prevent non-anonymous authorization, use
3000 * dbus_server_set_auth_mechanisms() to remove the mechanisms that
3001 * allow proving user identity (i.e. only allow the ANONYMOUS
3004 * @param connection the connection
3005 * @returns #TRUE if not authenticated or authenticated as anonymous
3008 dbus_connection_get_is_anonymous (DBusConnection *connection)
3012 _dbus_return_val_if_fail (connection != NULL, FALSE);
3014 CONNECTION_LOCK (connection);
3015 res = _dbus_transport_get_is_anonymous (connection->transport);
3016 CONNECTION_UNLOCK (connection);
3022 * Gets the ID of the server address we are authenticated to, if this
3023 * connection is on the client side. If the connection is on the
3024 * server side, this will always return #NULL - use dbus_server_get_id()
3025 * to get the ID of your own server, if you are the server side.
3027 * If a client-side connection is not authenticated yet, the ID may be
3028 * available if it was included in the server address, but may not be
3029 * available. The only way to be sure the server ID is available
3030 * is to wait for authentication to complete.
3032 * In general, each mode of connecting to a given server will have
3033 * its own ID. So for example, if the session bus daemon is listening
3034 * on UNIX domain sockets and on TCP, then each of those modalities
3035 * will have its own server ID.
3037 * If you want an ID that identifies an entire session bus, look at
3038 * dbus_bus_get_id() instead (which is just a convenience wrapper
3039 * around the org.freedesktop.DBus.GetId method invoked on the bus).
3041 * You can also get a machine ID; see dbus_get_local_machine_id() to
3042 * get the machine you are on. There isn't a convenience wrapper, but
3043 * you can invoke org.freedesktop.DBus.Peer.GetMachineId on any peer
3044 * to get the machine ID on the other end.
3046 * The D-Bus specification describes the server ID and other IDs in a
3049 * @param connection the connection
3050 * @returns the server ID or #NULL if no memory or the connection is server-side
3053 dbus_connection_get_server_id (DBusConnection *connection)
3057 _dbus_return_val_if_fail (connection != NULL, NULL);
3059 CONNECTION_LOCK (connection);
3060 id = _dbus_strdup (_dbus_transport_get_server_id (connection->transport));
3061 CONNECTION_UNLOCK (connection);
3067 * Tests whether a certain type can be send via the connection. This
3068 * will always return TRUE for all types, with the exception of
3069 * DBUS_TYPE_UNIX_FD. The function will return TRUE for
3070 * DBUS_TYPE_UNIX_FD only on systems that know Unix file descriptors
3071 * and can send them via the chosen transport and when the remote side
3074 * This function can be used to do runtime checking for types that
3075 * might be unknown to the specific D-Bus client implementation
3076 * version, i.e. it will return FALSE for all types this
3077 * implementation does not know, including invalid or reserved types.
3079 * @param connection the connection
3080 * @param type the type to check
3081 * @returns TRUE if the type may be send via the connection
3084 dbus_connection_can_send_type(DBusConnection *connection,
3087 _dbus_return_val_if_fail (connection != NULL, FALSE);
3089 if (!dbus_type_is_valid (type))
3092 if (type != DBUS_TYPE_UNIX_FD)
3095 #ifdef HAVE_UNIX_FD_PASSING
3099 CONNECTION_LOCK(connection);
3100 b = _dbus_transport_can_pass_unix_fd(connection->transport);
3101 CONNECTION_UNLOCK(connection);
3111 * Set whether _exit() should be called when the connection receives a
3112 * disconnect signal. The call to _exit() comes after any handlers for
3113 * the disconnect signal run; handlers can cancel the exit by calling
3116 * By default, exit_on_disconnect is #FALSE; but for message bus
3117 * connections returned from dbus_bus_get() it will be toggled on
3120 * @param connection the connection
3121 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
3124 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
3125 dbus_bool_t exit_on_disconnect)
3127 _dbus_return_if_fail (connection != NULL);
3129 CONNECTION_LOCK (connection);
3130 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
3131 CONNECTION_UNLOCK (connection);
3135 * Preallocates resources needed to send a message, allowing the message
3136 * to be sent without the possibility of memory allocation failure.
3137 * Allows apps to create a future guarantee that they can send
3138 * a message regardless of memory shortages.
3140 * @param connection the connection we're preallocating for.
3141 * @returns the preallocated resources, or #NULL
3143 DBusPreallocatedSend*
3144 dbus_connection_preallocate_send (DBusConnection *connection)
3146 DBusPreallocatedSend *preallocated;
3148 _dbus_return_val_if_fail (connection != NULL, NULL);
3150 CONNECTION_LOCK (connection);
3153 _dbus_connection_preallocate_send_unlocked (connection);
3155 CONNECTION_UNLOCK (connection);
3157 return preallocated;
3161 * Frees preallocated message-sending resources from
3162 * dbus_connection_preallocate_send(). Should only
3163 * be called if the preallocated resources are not used
3164 * to send a message.
3166 * @param connection the connection
3167 * @param preallocated the resources
3170 dbus_connection_free_preallocated_send (DBusConnection *connection,
3171 DBusPreallocatedSend *preallocated)
3173 _dbus_return_if_fail (connection != NULL);
3174 _dbus_return_if_fail (preallocated != NULL);
3175 _dbus_return_if_fail (connection == preallocated->connection);
3177 _dbus_list_free_link (preallocated->queue_link);
3178 _dbus_counter_unref (preallocated->counter_link->data);
3179 _dbus_list_free_link (preallocated->counter_link);
3180 dbus_free (preallocated);
3184 * Sends a message using preallocated resources. This function cannot fail.
3185 * It works identically to dbus_connection_send() in other respects.
3186 * Preallocated resources comes from dbus_connection_preallocate_send().
3187 * This function "consumes" the preallocated resources, they need not
3188 * be freed separately.
3190 * @param connection the connection
3191 * @param preallocated the preallocated resources
3192 * @param message the message to send
3193 * @param client_serial return location for client serial assigned to the message
3196 dbus_connection_send_preallocated (DBusConnection *connection,
3197 DBusPreallocatedSend *preallocated,
3198 DBusMessage *message,
3199 dbus_uint32_t *client_serial)
3201 _dbus_return_if_fail (connection != NULL);
3202 _dbus_return_if_fail (preallocated != NULL);
3203 _dbus_return_if_fail (message != NULL);
3204 _dbus_return_if_fail (preallocated->connection == connection);
3205 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3206 dbus_message_get_member (message) != NULL);
3207 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
3208 (dbus_message_get_interface (message) != NULL &&
3209 dbus_message_get_member (message) != NULL));
3211 CONNECTION_LOCK (connection);
3213 #ifdef HAVE_UNIX_FD_PASSING
3215 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3216 message->n_unix_fds > 0)
3218 /* Refuse to send fds on a connection that cannot handle
3219 them. Unfortunately we cannot return a proper error here, so
3220 the best we can is just return. */
3221 CONNECTION_UNLOCK (connection);
3227 _dbus_connection_send_preallocated_and_unlock (connection,
3229 message, client_serial);
3233 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
3234 DBusMessage *message,
3235 dbus_uint32_t *client_serial)
3237 DBusPreallocatedSend *preallocated;
3239 _dbus_assert (connection != NULL);
3240 _dbus_assert (message != NULL);
3242 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
3243 if (preallocated == NULL)
3246 _dbus_connection_send_preallocated_unlocked_no_update (connection,
3254 * Adds a message to the outgoing message queue. Does not block to
3255 * write the message to the network; that happens asynchronously. To
3256 * force the message to be written, call dbus_connection_flush() however
3257 * it is not necessary to call dbus_connection_flush() by hand; the
3258 * message will be sent the next time the main loop is run.
3259 * dbus_connection_flush() should only be used, for example, if
3260 * the application was expected to exit before running the main loop.
3262 * Because this only queues the message, the only reason it can
3263 * fail is lack of memory. Even if the connection is disconnected,
3264 * no error will be returned. If the function fails due to lack of memory,
3265 * it returns #FALSE. The function will never fail for other reasons; even
3266 * if the connection is disconnected, you can queue an outgoing message,
3267 * though obviously it won't be sent.
3269 * The message serial is used by the remote application to send a
3270 * reply; see dbus_message_get_serial() or the D-Bus specification.
3272 * dbus_message_unref() can be called as soon as this method returns
3273 * as the message queue will hold its own ref until the message is sent.
3275 * @param connection the connection.
3276 * @param message the message to write.
3277 * @param serial return location for message serial, or #NULL if you don't care
3278 * @returns #TRUE on success.
3281 dbus_connection_send (DBusConnection *connection,
3282 DBusMessage *message,
3283 dbus_uint32_t *serial)
3285 _dbus_return_val_if_fail (connection != NULL, FALSE);
3286 _dbus_return_val_if_fail (message != NULL, FALSE);
3288 CONNECTION_LOCK (connection);
3290 #ifdef HAVE_UNIX_FD_PASSING
3292 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3293 message->n_unix_fds > 0)
3295 /* Refuse to send fds on a connection that cannot handle
3296 them. Unfortunately we cannot return a proper error here, so
3297 the best we can is just return. */
3298 CONNECTION_UNLOCK (connection);
3304 return _dbus_connection_send_and_unlock (connection,
3310 reply_handler_timeout (void *data)
3312 DBusConnection *connection;
3313 DBusDispatchStatus status;
3314 DBusPendingCall *pending = data;
3316 connection = _dbus_pending_call_get_connection_and_lock (pending);
3317 _dbus_connection_ref_unlocked (connection);
3319 _dbus_pending_call_queue_timeout_error_unlocked (pending,
3321 _dbus_connection_remove_timeout_unlocked (connection,
3322 _dbus_pending_call_get_timeout_unlocked (pending));
3323 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
3325 _dbus_verbose ("middle\n");
3326 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3328 /* Unlocks, and calls out to user code */
3329 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3330 dbus_connection_unref (connection);
3336 * Queues a message to send, as with dbus_connection_send(),
3337 * but also returns a #DBusPendingCall used to receive a reply to the
3338 * message. If no reply is received in the given timeout_milliseconds,
3339 * this function expires the pending reply and generates a synthetic
3340 * error reply (generated in-process, not by the remote application)
3341 * indicating that a timeout occurred.
3343 * A #DBusPendingCall will see a reply message before any filters or
3344 * registered object path handlers. See dbus_connection_dispatch() for
3345 * details on when handlers are run.
3347 * A #DBusPendingCall will always see exactly one reply message,
3348 * unless it's cancelled with dbus_pending_call_cancel().
3350 * If #NULL is passed for the pending_return, the #DBusPendingCall
3351 * will still be generated internally, and used to track
3352 * the message reply timeout. This means a timeout error will
3353 * occur if no reply arrives, unlike with dbus_connection_send().
3355 * If -1 is passed for the timeout, a sane default timeout is used. -1
3356 * is typically the best value for the timeout for this reason, unless
3357 * you want a very short or very long timeout. If #DBUS_TIMEOUT_INFINITE is
3358 * passed for the timeout, no timeout will be set and the call will block
3361 * @warning if the connection is disconnected or you try to send Unix
3362 * file descriptors on a connection that does not support them, the
3363 * #DBusPendingCall will be set to #NULL, so be careful with this.
3365 * @param connection the connection
3366 * @param message the message to send
3367 * @param pending_return return location for a #DBusPendingCall
3368 * object, or #NULL if connection is disconnected or when you try to
3369 * send Unix file descriptors on a connection that does not support
3371 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3372 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3374 * @returns #FALSE if no memory, #TRUE otherwise.
3378 dbus_connection_send_with_reply (DBusConnection *connection,
3379 DBusMessage *message,
3380 DBusPendingCall **pending_return,
3381 int timeout_milliseconds)
3383 DBusPendingCall *pending;
3384 dbus_int32_t serial = -1;
3385 DBusDispatchStatus status;
3387 _dbus_return_val_if_fail (connection != NULL, FALSE);
3388 _dbus_return_val_if_fail (message != NULL, FALSE);
3389 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3392 *pending_return = NULL;
3394 CONNECTION_LOCK (connection);
3396 #ifdef HAVE_UNIX_FD_PASSING
3398 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3399 message->n_unix_fds > 0)
3401 /* Refuse to send fds on a connection that cannot handle
3402 them. Unfortunately we cannot return a proper error here, so
3403 the best we can do is return TRUE but leave *pending_return
3405 CONNECTION_UNLOCK (connection);
3411 if (!_dbus_connection_get_is_connected_unlocked (connection))
3413 CONNECTION_UNLOCK (connection);
3418 pending = _dbus_pending_call_new_unlocked (connection,
3419 timeout_milliseconds,
3420 reply_handler_timeout);
3422 if (pending == NULL)
3424 CONNECTION_UNLOCK (connection);
3428 /* Assign a serial to the message */
3429 serial = dbus_message_get_serial (message);
3432 serial = _dbus_connection_get_next_client_serial (connection);
3433 dbus_message_set_serial (message, serial);
3436 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3439 /* Insert the serial in the pending replies hash;
3440 * hash takes a refcount on DBusPendingCall.
3441 * Also, add the timeout.
3443 if (!_dbus_connection_attach_pending_call_unlocked (connection,
3447 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3449 _dbus_connection_detach_pending_call_and_unlock (connection,
3451 goto error_unlocked;
3455 *pending_return = pending; /* hand off refcount */
3458 _dbus_connection_detach_pending_call_unlocked (connection, pending);
3459 /* we still have a ref to the pending call in this case, we unref
3460 * after unlocking, below
3464 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3466 /* this calls out to user code */
3467 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3469 if (pending_return == NULL)
3470 dbus_pending_call_unref (pending);
3475 CONNECTION_UNLOCK (connection);
3477 dbus_pending_call_unref (pending);
3482 * Sends a message and blocks a certain time period while waiting for
3483 * a reply. This function does not reenter the main loop,
3484 * i.e. messages other than the reply are queued up but not
3485 * processed. This function is used to invoke method calls on a
3488 * If a normal reply is received, it is returned, and removed from the
3489 * incoming message queue. If it is not received, #NULL is returned
3490 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3491 * received, it is converted to a #DBusError and returned as an error,
3492 * then the reply message is deleted and #NULL is returned. If
3493 * something else goes wrong, result is set to whatever is
3494 * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3495 * #DBUS_ERROR_DISCONNECTED.
3497 * @warning While this function blocks the calling thread will not be
3498 * processing the incoming message queue. This means you can end up
3499 * deadlocked if the application you're talking to needs you to reply
3500 * to a method. To solve this, either avoid the situation, block in a
3501 * separate thread from the main connection-dispatching thread, or use
3502 * dbus_pending_call_set_notify() to avoid blocking.
3504 * @param connection the connection
3505 * @param message the message to send
3506 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3507 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3509 * @param error return location for error message
3510 * @returns the message that is the reply or #NULL with an error code if the
3514 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3515 DBusMessage *message,
3516 int timeout_milliseconds,
3520 DBusPendingCall *pending;
3522 _dbus_return_val_if_fail (connection != NULL, NULL);
3523 _dbus_return_val_if_fail (message != NULL, NULL);
3524 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3525 _dbus_return_val_if_error_is_set (error, NULL);
3527 #ifdef HAVE_UNIX_FD_PASSING
3529 CONNECTION_LOCK (connection);
3530 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3531 message->n_unix_fds > 0)
3533 CONNECTION_UNLOCK (connection);
3534 dbus_set_error(error, DBUS_ERROR_FAILED, "Cannot send file descriptors on this connection.");
3537 CONNECTION_UNLOCK (connection);
3541 if (!dbus_connection_send_with_reply (connection, message,
3542 &pending, timeout_milliseconds))
3544 _DBUS_SET_OOM (error);
3548 if (pending == NULL)
3550 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3554 dbus_pending_call_block (pending);
3556 reply = dbus_pending_call_steal_reply (pending);
3557 dbus_pending_call_unref (pending);
3559 /* call_complete_and_unlock() called from pending_call_block() should
3560 * always fill this in.
3562 _dbus_assert (reply != NULL);
3564 if (dbus_set_error_from_message (error, reply))
3566 dbus_message_unref (reply);
3574 * Blocks until the outgoing message queue is empty.
3575 * Assumes connection lock already held.
3577 * If you call this, you MUST call update_dispatch_status afterword...
3579 * @param connection the connection.
3581 static DBusDispatchStatus
3582 _dbus_connection_flush_unlocked (DBusConnection *connection)
3584 /* We have to specify DBUS_ITERATION_DO_READING here because
3585 * otherwise we could have two apps deadlock if they are both doing
3586 * a flush(), and the kernel buffers fill up. This could change the
3589 DBusDispatchStatus status;
3591 HAVE_LOCK_CHECK (connection);
3593 while (connection->n_outgoing > 0 &&
3594 _dbus_connection_get_is_connected_unlocked (connection))
3596 _dbus_verbose ("doing iteration in\n");
3597 HAVE_LOCK_CHECK (connection);
3598 _dbus_connection_do_iteration_unlocked (connection,
3600 DBUS_ITERATION_DO_READING |
3601 DBUS_ITERATION_DO_WRITING |
3602 DBUS_ITERATION_BLOCK,
3606 HAVE_LOCK_CHECK (connection);
3607 _dbus_verbose ("middle\n");
3608 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3610 HAVE_LOCK_CHECK (connection);
3615 * Blocks until the outgoing message queue is empty.
3617 * @param connection the connection.
3620 dbus_connection_flush (DBusConnection *connection)
3622 /* We have to specify DBUS_ITERATION_DO_READING here because
3623 * otherwise we could have two apps deadlock if they are both doing
3624 * a flush(), and the kernel buffers fill up. This could change the
3627 DBusDispatchStatus status;
3629 _dbus_return_if_fail (connection != NULL);
3631 CONNECTION_LOCK (connection);
3633 status = _dbus_connection_flush_unlocked (connection);
3635 HAVE_LOCK_CHECK (connection);
3636 /* Unlocks and calls out to user code */
3637 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3639 _dbus_verbose ("end\n");
3643 * This function implements dbus_connection_read_write_dispatch() and
3644 * dbus_connection_read_write() (they pass a different value for the
3645 * dispatch parameter).
3647 * @param connection the connection
3648 * @param timeout_milliseconds max time to block or -1 for infinite
3649 * @param dispatch dispatch new messages or leave them on the incoming queue
3650 * @returns #TRUE if the disconnect message has not been processed
3653 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3654 int timeout_milliseconds,
3655 dbus_bool_t dispatch)
3657 DBusDispatchStatus dstatus;
3658 dbus_bool_t progress_possible;
3660 /* Need to grab a ref here in case we're a private connection and
3661 * the user drops the last ref in a handler we call; see bug
3662 * https://bugs.freedesktop.org/show_bug.cgi?id=15635
3664 dbus_connection_ref (connection);
3665 dstatus = dbus_connection_get_dispatch_status (connection);
3667 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3669 _dbus_verbose ("doing dispatch\n");
3670 dbus_connection_dispatch (connection);
3671 CONNECTION_LOCK (connection);
3673 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3675 _dbus_verbose ("pausing for memory\n");
3676 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3677 CONNECTION_LOCK (connection);
3681 CONNECTION_LOCK (connection);
3682 if (_dbus_connection_get_is_connected_unlocked (connection))
3684 _dbus_verbose ("doing iteration\n");
3685 _dbus_connection_do_iteration_unlocked (connection,
3687 DBUS_ITERATION_DO_READING |
3688 DBUS_ITERATION_DO_WRITING |
3689 DBUS_ITERATION_BLOCK,
3690 timeout_milliseconds);
3694 HAVE_LOCK_CHECK (connection);
3695 /* If we can dispatch, we can make progress until the Disconnected message
3696 * has been processed; if we can only read/write, we can make progress
3697 * as long as the transport is open.
3700 progress_possible = connection->n_incoming != 0 ||
3701 connection->disconnect_message_link != NULL;
3703 progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3705 CONNECTION_UNLOCK (connection);
3707 dbus_connection_unref (connection);
3709 return progress_possible; /* TRUE if we can make more progress */
3714 * This function is intended for use with applications that don't want
3715 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3716 * example usage would be:
3719 * while (dbus_connection_read_write_dispatch (connection, -1))
3720 * ; // empty loop body
3723 * In this usage you would normally have set up a filter function to look
3724 * at each message as it is dispatched. The loop terminates when the last
3725 * message from the connection (the disconnected signal) is processed.
3727 * If there are messages to dispatch, this function will
3728 * dbus_connection_dispatch() once, and return. If there are no
3729 * messages to dispatch, this function will block until it can read or
3730 * write, then read or write, then return.
3732 * The way to think of this function is that it either makes some sort
3733 * of progress, or it blocks. Note that, while it is blocked on I/O, it
3734 * cannot be interrupted (even by other threads), which makes this function
3735 * unsuitable for applications that do more than just react to received
3738 * The return value indicates whether the disconnect message has been
3739 * processed, NOT whether the connection is connected. This is
3740 * important because even after disconnecting, you want to process any
3741 * messages you received prior to the disconnect.
3743 * @param connection the connection
3744 * @param timeout_milliseconds max time to block or -1 for infinite
3745 * @returns #TRUE if the disconnect message has not been processed
3748 dbus_connection_read_write_dispatch (DBusConnection *connection,
3749 int timeout_milliseconds)
3751 _dbus_return_val_if_fail (connection != NULL, FALSE);
3752 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3753 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3757 * This function is intended for use with applications that don't want to
3758 * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3759 * dbus_connection_read_write_dispatch().
3761 * As long as the connection is open, this function will block until it can
3762 * read or write, then read or write, then return #TRUE.
3764 * If the connection is closed, the function returns #FALSE.
3766 * The return value indicates whether reading or writing is still
3767 * possible, i.e. whether the connection is connected.
3769 * Note that even after disconnection, messages may remain in the
3770 * incoming queue that need to be
3771 * processed. dbus_connection_read_write_dispatch() dispatches
3772 * incoming messages for you; with dbus_connection_read_write() you
3773 * have to arrange to drain the incoming queue yourself.
3775 * @param connection the connection
3776 * @param timeout_milliseconds max time to block or -1 for infinite
3777 * @returns #TRUE if still connected
3780 dbus_connection_read_write (DBusConnection *connection,
3781 int timeout_milliseconds)
3783 _dbus_return_val_if_fail (connection != NULL, FALSE);
3784 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3785 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3788 /* We need to call this anytime we pop the head of the queue, and then
3789 * update_dispatch_status_and_unlock needs to be called afterward
3790 * which will "process" the disconnected message and set
3791 * disconnected_message_processed.
3794 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3795 DBusMessage *head_of_queue)
3797 HAVE_LOCK_CHECK (connection);
3799 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3800 if (connection->disconnect_message_link == NULL &&
3801 dbus_message_is_signal (head_of_queue,
3802 DBUS_INTERFACE_LOCAL,
3805 connection->disconnected_message_arrived = TRUE;
3810 * Returns the first-received message from the incoming message queue,
3811 * leaving it in the queue. If the queue is empty, returns #NULL.
3813 * The caller does not own a reference to the returned message, and
3814 * must either return it using dbus_connection_return_message() or
3815 * keep it after calling dbus_connection_steal_borrowed_message(). No
3816 * one can get at the message while its borrowed, so return it as
3817 * quickly as possible and don't keep a reference to it after
3818 * returning it. If you need to keep the message, make a copy of it.
3820 * dbus_connection_dispatch() will block if called while a borrowed
3821 * message is outstanding; only one piece of code can be playing with
3822 * the incoming queue at a time. This function will block if called
3823 * during a dbus_connection_dispatch().
3825 * @param connection the connection.
3826 * @returns next message in the incoming queue.
3829 dbus_connection_borrow_message (DBusConnection *connection)
3831 DBusDispatchStatus status;
3832 DBusMessage *message;
3834 _dbus_return_val_if_fail (connection != NULL, NULL);
3836 _dbus_verbose ("start\n");
3838 /* this is called for the side effect that it queues
3839 * up any messages from the transport
3841 status = dbus_connection_get_dispatch_status (connection);
3842 if (status != DBUS_DISPATCH_DATA_REMAINS)
3845 CONNECTION_LOCK (connection);
3847 _dbus_connection_acquire_dispatch (connection);
3849 /* While a message is outstanding, the dispatch lock is held */
3850 _dbus_assert (connection->message_borrowed == NULL);
3852 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3854 message = connection->message_borrowed;
3856 check_disconnected_message_arrived_unlocked (connection, message);
3858 /* Note that we KEEP the dispatch lock until the message is returned */
3859 if (message == NULL)
3860 _dbus_connection_release_dispatch (connection);
3862 CONNECTION_UNLOCK (connection);
3864 _dbus_message_trace_ref (message, -1, -1, "dbus_connection_borrow_message");
3866 /* We don't update dispatch status until it's returned or stolen */
3872 * Used to return a message after peeking at it using
3873 * dbus_connection_borrow_message(). Only called if
3874 * message from dbus_connection_borrow_message() was non-#NULL.
3876 * @param connection the connection
3877 * @param message the message from dbus_connection_borrow_message()
3880 dbus_connection_return_message (DBusConnection *connection,
3881 DBusMessage *message)
3883 DBusDispatchStatus status;
3885 _dbus_return_if_fail (connection != NULL);
3886 _dbus_return_if_fail (message != NULL);
3887 _dbus_return_if_fail (message == connection->message_borrowed);
3888 _dbus_return_if_fail (connection->dispatch_acquired);
3890 CONNECTION_LOCK (connection);
3892 _dbus_assert (message == connection->message_borrowed);
3894 connection->message_borrowed = NULL;
3896 _dbus_connection_release_dispatch (connection);
3898 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3899 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3901 _dbus_message_trace_ref (message, -1, -1, "dbus_connection_return_message");
3905 * Used to keep a message after peeking at it using
3906 * dbus_connection_borrow_message(). Before using this function, see
3907 * the caveats/warnings in the documentation for
3908 * dbus_connection_pop_message().
3910 * @param connection the connection
3911 * @param message the message from dbus_connection_borrow_message()
3914 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3915 DBusMessage *message)
3917 DBusMessage *pop_message;
3918 DBusDispatchStatus status;
3920 _dbus_return_if_fail (connection != NULL);
3921 _dbus_return_if_fail (message != NULL);
3922 _dbus_return_if_fail (message == connection->message_borrowed);
3923 _dbus_return_if_fail (connection->dispatch_acquired);
3925 CONNECTION_LOCK (connection);
3927 _dbus_assert (message == connection->message_borrowed);
3929 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3930 _dbus_assert (message == pop_message);
3931 (void) pop_message; /* unused unless asserting */
3933 connection->n_incoming -= 1;
3935 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3936 message, connection->n_incoming);
3938 connection->message_borrowed = NULL;
3940 _dbus_connection_release_dispatch (connection);
3942 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3943 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3944 _dbus_message_trace_ref (message, -1, -1,
3945 "dbus_connection_steal_borrowed_message");
3948 /* See dbus_connection_pop_message, but requires the caller to own
3949 * the lock before calling. May drop the lock while running.
3952 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3954 HAVE_LOCK_CHECK (connection);
3956 _dbus_assert (connection->message_borrowed == NULL);
3958 if (connection->n_incoming > 0)
3962 link = _dbus_list_pop_first_link (&connection->incoming_messages);
3963 connection->n_incoming -= 1;
3965 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from incoming queue %p, %d incoming\n",
3967 dbus_message_type_to_string (dbus_message_get_type (link->data)),
3968 dbus_message_get_path (link->data) ?
3969 dbus_message_get_path (link->data) :
3971 dbus_message_get_interface (link->data) ?
3972 dbus_message_get_interface (link->data) :
3974 dbus_message_get_member (link->data) ?
3975 dbus_message_get_member (link->data) :
3977 dbus_message_get_signature (link->data),
3978 connection, connection->n_incoming);
3980 _dbus_message_trace_ref (link->data, -1, -1,
3981 "_dbus_connection_pop_message_link_unlocked");
3983 check_disconnected_message_arrived_unlocked (connection, link->data);
3991 /* See dbus_connection_pop_message, but requires the caller to own
3992 * the lock before calling. May drop the lock while running.
3995 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3999 HAVE_LOCK_CHECK (connection);
4001 link = _dbus_connection_pop_message_link_unlocked (connection);
4005 DBusMessage *message;
4007 message = link->data;
4009 _dbus_list_free_link (link);
4018 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
4019 DBusList *message_link)
4021 HAVE_LOCK_CHECK (connection);
4023 _dbus_assert (message_link != NULL);
4024 /* You can't borrow a message while a link is outstanding */
4025 _dbus_assert (connection->message_borrowed == NULL);
4026 /* We had to have the dispatch lock across the pop/putback */
4027 _dbus_assert (connection->dispatch_acquired);
4029 _dbus_list_prepend_link (&connection->incoming_messages,
4031 connection->n_incoming += 1;
4033 _dbus_verbose ("Message %p (%s %s %s '%s') put back into queue %p, %d incoming\n",
4035 dbus_message_type_to_string (dbus_message_get_type (message_link->data)),
4036 dbus_message_get_interface (message_link->data) ?
4037 dbus_message_get_interface (message_link->data) :
4039 dbus_message_get_member (message_link->data) ?
4040 dbus_message_get_member (message_link->data) :
4042 dbus_message_get_signature (message_link->data),
4043 connection, connection->n_incoming);
4045 _dbus_message_trace_ref (message_link->data, -1, -1,
4046 "_dbus_connection_putback_message_link_unlocked");
4050 * Returns the first-received message from the incoming message queue,
4051 * removing it from the queue. The caller owns a reference to the
4052 * returned message. If the queue is empty, returns #NULL.
4054 * This function bypasses any message handlers that are registered,
4055 * and so using it is usually wrong. Instead, let the main loop invoke
4056 * dbus_connection_dispatch(). Popping messages manually is only
4057 * useful in very simple programs that don't share a #DBusConnection
4058 * with any libraries or other modules.
4060 * There is a lock that covers all ways of accessing the incoming message
4061 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
4062 * dbus_connection_borrow_message(), etc. will all block while one of the others
4063 * in the group is running.
4065 * @param connection the connection.
4066 * @returns next message in the incoming queue.
4069 dbus_connection_pop_message (DBusConnection *connection)
4071 DBusMessage *message;
4072 DBusDispatchStatus status;
4074 _dbus_verbose ("start\n");
4076 /* this is called for the side effect that it queues
4077 * up any messages from the transport
4079 status = dbus_connection_get_dispatch_status (connection);
4080 if (status != DBUS_DISPATCH_DATA_REMAINS)
4083 CONNECTION_LOCK (connection);
4084 _dbus_connection_acquire_dispatch (connection);
4085 HAVE_LOCK_CHECK (connection);
4087 message = _dbus_connection_pop_message_unlocked (connection);
4089 _dbus_verbose ("Returning popped message %p\n", message);
4091 _dbus_connection_release_dispatch (connection);
4093 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4094 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4100 * Acquire the dispatcher. This is a separate lock so the main
4101 * connection lock can be dropped to call out to application dispatch
4104 * @param connection the connection.
4107 _dbus_connection_acquire_dispatch (DBusConnection *connection)
4109 HAVE_LOCK_CHECK (connection);
4111 _dbus_connection_ref_unlocked (connection);
4112 CONNECTION_UNLOCK (connection);
4114 _dbus_verbose ("locking dispatch_mutex\n");
4115 _dbus_cmutex_lock (connection->dispatch_mutex);
4117 while (connection->dispatch_acquired)
4119 _dbus_verbose ("waiting for dispatch to be acquirable\n");
4120 _dbus_condvar_wait (connection->dispatch_cond,
4121 connection->dispatch_mutex);
4124 _dbus_assert (!connection->dispatch_acquired);
4126 connection->dispatch_acquired = TRUE;
4128 _dbus_verbose ("unlocking dispatch_mutex\n");
4129 _dbus_cmutex_unlock (connection->dispatch_mutex);
4131 CONNECTION_LOCK (connection);
4132 _dbus_connection_unref_unlocked (connection);
4136 * Release the dispatcher when you're done with it. Only call
4137 * after you've acquired the dispatcher. Wakes up at most one
4138 * thread currently waiting to acquire the dispatcher.
4140 * @param connection the connection.
4143 _dbus_connection_release_dispatch (DBusConnection *connection)
4145 HAVE_LOCK_CHECK (connection);
4147 _dbus_verbose ("locking dispatch_mutex\n");
4148 _dbus_cmutex_lock (connection->dispatch_mutex);
4150 _dbus_assert (connection->dispatch_acquired);
4152 connection->dispatch_acquired = FALSE;
4153 _dbus_condvar_wake_one (connection->dispatch_cond);
4155 _dbus_verbose ("unlocking dispatch_mutex\n");
4156 _dbus_cmutex_unlock (connection->dispatch_mutex);
4160 _dbus_connection_failed_pop (DBusConnection *connection,
4161 DBusList *message_link)
4163 _dbus_list_prepend_link (&connection->incoming_messages,
4165 connection->n_incoming += 1;
4168 /* Note this may be called multiple times since we don't track whether we already did it */
4170 notify_disconnected_unlocked (DBusConnection *connection)
4172 HAVE_LOCK_CHECK (connection);
4174 /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
4175 * connection from dbus_bus_get(). We make the same guarantee for
4176 * dbus_connection_open() but in a different way since we don't want to
4177 * unref right here; we instead check for connectedness before returning
4178 * the connection from the hash.
4180 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
4182 /* Dump the outgoing queue, we aren't going to be able to
4183 * send it now, and we'd like accessors like
4184 * dbus_connection_get_outgoing_size() to be accurate.
4186 if (connection->n_outgoing > 0)
4190 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
4191 connection->n_outgoing);
4193 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
4195 _dbus_connection_message_sent_unlocked (connection, link->data);
4200 /* Note this may be called multiple times since we don't track whether we already did it */
4201 static DBusDispatchStatus
4202 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
4204 HAVE_LOCK_CHECK (connection);
4206 if (connection->disconnect_message_link != NULL)
4208 _dbus_verbose ("Sending disconnect message\n");
4210 /* If we have pending calls, queue their timeouts - we want the Disconnected
4211 * to be the last message, after these timeouts.
4213 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
4215 /* We haven't sent the disconnect message already,
4216 * and all real messages have been queued up.
4218 _dbus_connection_queue_synthesized_message_link (connection,
4219 connection->disconnect_message_link);
4220 connection->disconnect_message_link = NULL;
4222 return DBUS_DISPATCH_DATA_REMAINS;
4225 return DBUS_DISPATCH_COMPLETE;
4228 static DBusDispatchStatus
4229 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
4231 HAVE_LOCK_CHECK (connection);
4233 if (connection->n_incoming > 0)
4234 return DBUS_DISPATCH_DATA_REMAINS;
4235 else if (!_dbus_transport_queue_messages (connection->transport))
4236 return DBUS_DISPATCH_NEED_MEMORY;
4239 DBusDispatchStatus status;
4240 dbus_bool_t is_connected;
4242 status = _dbus_transport_get_dispatch_status (connection->transport);
4243 is_connected = _dbus_transport_get_is_connected (connection->transport);
4245 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
4246 DISPATCH_STATUS_NAME (status), is_connected);
4250 /* It's possible this would be better done by having an explicit
4251 * notification from _dbus_transport_disconnect() that would
4252 * synchronously do this, instead of waiting for the next dispatch
4253 * status check. However, probably not good to change until it causes
4256 notify_disconnected_unlocked (connection);
4258 /* I'm not sure this is needed; the idea is that we want to
4259 * queue the Disconnected only after we've read all the
4260 * messages, but if we're disconnected maybe we are guaranteed
4261 * to have read them all ?
4263 if (status == DBUS_DISPATCH_COMPLETE)
4264 status = notify_disconnected_and_dispatch_complete_unlocked (connection);
4267 if (status != DBUS_DISPATCH_COMPLETE)
4269 else if (connection->n_incoming > 0)
4270 return DBUS_DISPATCH_DATA_REMAINS;
4272 return DBUS_DISPATCH_COMPLETE;
4277 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
4278 DBusDispatchStatus new_status)
4280 dbus_bool_t changed;
4281 DBusDispatchStatusFunction function;
4284 HAVE_LOCK_CHECK (connection);
4286 _dbus_connection_ref_unlocked (connection);
4288 changed = new_status != connection->last_dispatch_status;
4290 connection->last_dispatch_status = new_status;
4292 function = connection->dispatch_status_function;
4293 data = connection->dispatch_status_data;
4295 if (connection->disconnected_message_arrived &&
4296 !connection->disconnected_message_processed)
4298 connection->disconnected_message_processed = TRUE;
4300 /* this does an unref, but we have a ref
4301 * so we should not run the finalizer here
4304 connection_forget_shared_unlocked (connection);
4306 if (connection->exit_on_disconnect)
4308 CONNECTION_UNLOCK (connection);
4310 _dbus_verbose ("Exiting on Disconnected signal\n");
4312 _dbus_assert_not_reached ("Call to exit() returned");
4316 /* We drop the lock */
4317 CONNECTION_UNLOCK (connection);
4319 if (changed && function)
4321 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
4322 connection, new_status,
4323 DISPATCH_STATUS_NAME (new_status));
4324 (* function) (connection, new_status, data);
4327 dbus_connection_unref (connection);
4331 * Gets the current state of the incoming message queue.
4332 * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
4333 * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
4334 * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
4335 * there could be data, but we can't know for sure without more
4338 * To process the incoming message queue, use dbus_connection_dispatch()
4339 * or (in rare cases) dbus_connection_pop_message().
4341 * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
4342 * have messages in the queue, or we have raw bytes buffered up
4343 * that need to be parsed. When these bytes are parsed, they
4344 * may not add up to an entire message. Thus, it's possible
4345 * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
4346 * have a message yet.
4348 * In particular this happens on initial connection, because all sorts
4349 * of authentication protocol stuff has to be parsed before the
4350 * first message arrives.
4352 * @param connection the connection.
4353 * @returns current dispatch status
4356 dbus_connection_get_dispatch_status (DBusConnection *connection)
4358 DBusDispatchStatus status;
4360 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4362 _dbus_verbose ("start\n");
4364 CONNECTION_LOCK (connection);
4366 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4368 CONNECTION_UNLOCK (connection);
4374 * Filter funtion for handling the Peer standard interface.
4376 static DBusHandlerResult
4377 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
4378 DBusMessage *message)
4380 dbus_bool_t sent = FALSE;
4381 DBusMessage *ret = NULL;
4382 DBusList *expire_link;
4384 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
4386 /* This means we're letting the bus route this message */
4387 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4390 if (!dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4392 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4395 /* Preallocate a linked-list link, so that if we need to dispose of a
4396 * message, we can attach it to the expired list */
4397 expire_link = _dbus_list_alloc_link (NULL);
4400 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4402 if (dbus_message_is_method_call (message,
4403 DBUS_INTERFACE_PEER,
4406 ret = dbus_message_new_method_return (message);
4410 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4412 else if (dbus_message_is_method_call (message,
4413 DBUS_INTERFACE_PEER,
4418 ret = dbus_message_new_method_return (message);
4422 _dbus_string_init (&uuid);
4423 if (_dbus_get_local_machine_uuid_encoded (&uuid))
4425 const char *v_STRING = _dbus_string_get_const_data (&uuid);
4426 if (dbus_message_append_args (ret,
4427 DBUS_TYPE_STRING, &v_STRING,
4430 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4433 _dbus_string_free (&uuid);
4437 /* We need to bounce anything else with this interface, otherwise apps
4438 * could start extending the interface and when we added extensions
4439 * here to DBusConnection we'd break those apps.
4441 ret = dbus_message_new_error (message,
4442 DBUS_ERROR_UNKNOWN_METHOD,
4443 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4447 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4453 _dbus_list_free_link (expire_link);
4457 /* It'll be safe to unref the reply when we unlock */
4458 expire_link->data = ret;
4459 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4463 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4465 return DBUS_HANDLER_RESULT_HANDLED;
4469 * Processes all builtin filter functions
4471 * If the spec specifies a standard interface
4472 * they should be processed from this method
4474 static DBusHandlerResult
4475 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4476 DBusMessage *message)
4478 /* We just run one filter for now but have the option to run more
4479 if the spec calls for it in the future */
4481 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4485 * Processes any incoming data.
4487 * If there's incoming raw data that has not yet been parsed, it is
4488 * parsed, which may or may not result in adding messages to the
4491 * The incoming data buffer is filled when the connection reads from
4492 * its underlying transport (such as a socket). Reading usually
4493 * happens in dbus_watch_handle() or dbus_connection_read_write().
4495 * If there are complete messages in the incoming queue,
4496 * dbus_connection_dispatch() removes one message from the queue and
4497 * processes it. Processing has three steps.
4499 * First, any method replies are passed to #DBusPendingCall or
4500 * dbus_connection_send_with_reply_and_block() in order to
4501 * complete the pending method call.
4503 * Second, any filters registered with dbus_connection_add_filter()
4504 * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4505 * then processing stops after that filter.
4507 * Third, if the message is a method call it is forwarded to
4508 * any registered object path handlers added with
4509 * dbus_connection_register_object_path() or
4510 * dbus_connection_register_fallback().
4512 * A single call to dbus_connection_dispatch() will process at most
4513 * one message; it will not clear the entire message queue.
4515 * Be careful about calling dbus_connection_dispatch() from inside a
4516 * message handler, i.e. calling dbus_connection_dispatch()
4517 * recursively. If threads have been initialized with a recursive
4518 * mutex function, then this will not deadlock; however, it can
4519 * certainly confuse your application.
4521 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4523 * @param connection the connection
4524 * @returns dispatch status, see dbus_connection_get_dispatch_status()
4527 dbus_connection_dispatch (DBusConnection *connection)
4529 DBusMessage *message;
4530 DBusList *link, *filter_list_copy, *message_link;
4531 DBusHandlerResult result;
4532 DBusPendingCall *pending;
4533 dbus_int32_t reply_serial;
4534 DBusDispatchStatus status;
4535 dbus_bool_t found_object;
4537 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4539 _dbus_verbose ("\n");
4541 CONNECTION_LOCK (connection);
4542 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4543 if (status != DBUS_DISPATCH_DATA_REMAINS)
4545 /* unlocks and calls out to user code */
4546 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4550 /* We need to ref the connection since the callback could potentially
4551 * drop the last ref to it
4553 _dbus_connection_ref_unlocked (connection);
4555 _dbus_connection_acquire_dispatch (connection);
4556 HAVE_LOCK_CHECK (connection);
4558 message_link = _dbus_connection_pop_message_link_unlocked (connection);
4559 if (message_link == NULL)
4561 /* another thread dispatched our stuff */
4563 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4565 _dbus_connection_release_dispatch (connection);
4567 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4569 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4571 dbus_connection_unref (connection);
4576 message = message_link->data;
4578 _dbus_verbose (" dispatching message %p (%s %s %s '%s')\n",
4580 dbus_message_type_to_string (dbus_message_get_type (message)),
4581 dbus_message_get_interface (message) ?
4582 dbus_message_get_interface (message) :
4584 dbus_message_get_member (message) ?
4585 dbus_message_get_member (message) :
4587 dbus_message_get_signature (message));
4589 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4591 /* Pending call handling must be first, because if you do
4592 * dbus_connection_send_with_reply_and_block() or
4593 * dbus_pending_call_block() then no handlers/filters will be run on
4594 * the reply. We want consistent semantics in the case where we
4595 * dbus_connection_dispatch() the reply.
4598 reply_serial = dbus_message_get_reply_serial (message);
4599 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4603 _dbus_verbose ("Dispatching a pending reply\n");
4604 complete_pending_call_and_unlock (connection, pending, message);
4605 pending = NULL; /* it's probably unref'd */
4607 CONNECTION_LOCK (connection);
4608 _dbus_verbose ("pending call completed in dispatch\n");
4609 result = DBUS_HANDLER_RESULT_HANDLED;
4613 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4614 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4617 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4619 _dbus_connection_release_dispatch (connection);
4620 HAVE_LOCK_CHECK (connection);
4622 _dbus_connection_failed_pop (connection, message_link);
4624 /* unlocks and calls user code */
4625 _dbus_connection_update_dispatch_status_and_unlock (connection,
4626 DBUS_DISPATCH_NEED_MEMORY);
4627 dbus_connection_unref (connection);
4629 return DBUS_DISPATCH_NEED_MEMORY;
4632 _dbus_list_foreach (&filter_list_copy,
4633 (DBusForeachFunction)_dbus_message_filter_ref,
4636 /* We're still protected from dispatch() reentrancy here
4637 * since we acquired the dispatcher
4639 CONNECTION_UNLOCK (connection);
4641 link = _dbus_list_get_first_link (&filter_list_copy);
4642 while (link != NULL)
4644 DBusMessageFilter *filter = link->data;
4645 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4647 if (filter->function == NULL)
4649 _dbus_verbose (" filter was removed in a callback function\n");
4654 _dbus_verbose (" running filter on message %p\n", message);
4655 result = (* filter->function) (connection, message, filter->user_data);
4657 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4663 _dbus_list_foreach (&filter_list_copy,
4664 (DBusForeachFunction)_dbus_message_filter_unref,
4666 _dbus_list_clear (&filter_list_copy);
4668 CONNECTION_LOCK (connection);
4670 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4672 _dbus_verbose ("No memory\n");
4675 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4677 _dbus_verbose ("filter handled message in dispatch\n");
4681 /* We're still protected from dispatch() reentrancy here
4682 * since we acquired the dispatcher
4684 _dbus_verbose (" running object path dispatch on message %p (%s %s %s '%s')\n",
4686 dbus_message_type_to_string (dbus_message_get_type (message)),
4687 dbus_message_get_interface (message) ?
4688 dbus_message_get_interface (message) :
4690 dbus_message_get_member (message) ?
4691 dbus_message_get_member (message) :
4693 dbus_message_get_signature (message));
4695 HAVE_LOCK_CHECK (connection);
4696 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4700 CONNECTION_LOCK (connection);
4702 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4704 _dbus_verbose ("object tree handled message in dispatch\n");
4708 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4712 DBusPreallocatedSend *preallocated;
4713 DBusList *expire_link;
4715 _dbus_verbose (" sending error %s\n",
4716 DBUS_ERROR_UNKNOWN_METHOD);
4718 if (!_dbus_string_init (&str))
4720 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4721 _dbus_verbose ("no memory for error string in dispatch\n");
4725 if (!_dbus_string_append_printf (&str,
4726 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4727 dbus_message_get_member (message),
4728 dbus_message_get_signature (message),
4729 dbus_message_get_interface (message)))
4731 _dbus_string_free (&str);
4732 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4733 _dbus_verbose ("no memory for error string in dispatch\n");
4737 reply = dbus_message_new_error (message,
4738 found_object ? DBUS_ERROR_UNKNOWN_METHOD : DBUS_ERROR_UNKNOWN_OBJECT,
4739 _dbus_string_get_const_data (&str));
4740 _dbus_string_free (&str);
4744 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4745 _dbus_verbose ("no memory for error reply in dispatch\n");
4749 expire_link = _dbus_list_alloc_link (reply);
4751 if (expire_link == NULL)
4753 dbus_message_unref (reply);
4754 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4755 _dbus_verbose ("no memory for error send in dispatch\n");
4759 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4761 if (preallocated == NULL)
4763 _dbus_list_free_link (expire_link);
4764 /* It's OK that this is finalized, because it hasn't been seen by
4765 * anything that could attach user callbacks */
4766 dbus_message_unref (reply);
4767 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4768 _dbus_verbose ("no memory for error send in dispatch\n");
4772 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4774 /* reply will be freed when we release the lock */
4775 _dbus_list_prepend_link (&connection->expired_messages, expire_link);
4777 result = DBUS_HANDLER_RESULT_HANDLED;
4780 _dbus_verbose (" done dispatching %p (%s %s %s '%s') on connection %p\n", message,
4781 dbus_message_type_to_string (dbus_message_get_type (message)),
4782 dbus_message_get_interface (message) ?
4783 dbus_message_get_interface (message) :
4785 dbus_message_get_member (message) ?
4786 dbus_message_get_member (message) :
4788 dbus_message_get_signature (message),
4792 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4794 _dbus_verbose ("out of memory\n");
4796 /* Put message back, and we'll start over.
4797 * Yes this means handlers must be idempotent if they
4798 * don't return HANDLED; c'est la vie.
4800 _dbus_connection_putback_message_link_unlocked (connection,
4802 /* now we don't want to free them */
4803 message_link = NULL;
4808 _dbus_verbose (" ... done dispatching\n");
4811 _dbus_connection_release_dispatch (connection);
4812 HAVE_LOCK_CHECK (connection);
4814 if (message != NULL)
4816 /* We don't want this message to count in maximum message limits when
4817 * computing the dispatch status, below. We have to drop the lock
4818 * temporarily, because finalizing a message can trigger callbacks.
4820 * We have a reference to the connection, and we don't use any cached
4821 * pointers to the connection's internals below this point, so it should
4822 * be safe to drop the lock and take it back. */
4823 CONNECTION_UNLOCK (connection);
4824 dbus_message_unref (message);
4825 CONNECTION_LOCK (connection);
4828 if (message_link != NULL)
4829 _dbus_list_free_link (message_link);
4831 _dbus_verbose ("before final status update\n");
4832 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4834 /* unlocks and calls user code */
4835 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4837 dbus_connection_unref (connection);
4843 * Sets the watch functions for the connection. These functions are
4844 * responsible for making the application's main loop aware of file
4845 * descriptors that need to be monitored for events, using select() or
4846 * poll(). When using Qt, typically the DBusAddWatchFunction would
4847 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4848 * could call g_io_add_watch(), or could be used as part of a more
4849 * elaborate GSource. Note that when a watch is added, it may
4852 * The DBusWatchToggledFunction notifies the application that the
4853 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4854 * to check this. A disabled watch should have no effect, and enabled
4855 * watch should be added to the main loop. This feature is used
4856 * instead of simply adding/removing the watch because
4857 * enabling/disabling can be done without memory allocation. The
4858 * toggled function may be NULL if a main loop re-queries
4859 * dbus_watch_get_enabled() every time anyway.
4861 * The DBusWatch can be queried for the file descriptor to watch using
4862 * dbus_watch_get_unix_fd() or dbus_watch_get_socket(), and for the
4863 * events to watch for using dbus_watch_get_flags(). The flags
4864 * returned by dbus_watch_get_flags() will only contain
4865 * DBUS_WATCH_READABLE and DBUS_WATCH_WRITABLE, never
4866 * DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR; all watches implicitly
4867 * include a watch for hangups, errors, and other exceptional
4870 * Once a file descriptor becomes readable or writable, or an exception
4871 * occurs, dbus_watch_handle() should be called to
4872 * notify the connection of the file descriptor's condition.
4874 * dbus_watch_handle() cannot be called during the
4875 * DBusAddWatchFunction, as the connection will not be ready to handle
4878 * It is not allowed to reference a DBusWatch after it has been passed
4879 * to remove_function.
4881 * If #FALSE is returned due to lack of memory, the failure may be due
4882 * to a #FALSE return from the new add_function. If so, the
4883 * add_function may have been called successfully one or more times,
4884 * but the remove_function will also have been called to remove any
4885 * successful adds. i.e. if #FALSE is returned the net result
4886 * should be that dbus_connection_set_watch_functions() has no effect,
4887 * but the add_function and remove_function may have been called.
4889 * @note The thread lock on DBusConnection is held while
4890 * watch functions are invoked, so inside these functions you
4891 * may not invoke any methods on DBusConnection or it will deadlock.
4892 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/tread.html#8144
4893 * if you encounter this issue and want to attempt writing a patch.
4895 * @param connection the connection.
4896 * @param add_function function to begin monitoring a new descriptor.
4897 * @param remove_function function to stop monitoring a descriptor.
4898 * @param toggled_function function to notify of enable/disable
4899 * @param data data to pass to add_function and remove_function.
4900 * @param free_data_function function to be called to free the data.
4901 * @returns #FALSE on failure (no memory)
4904 dbus_connection_set_watch_functions (DBusConnection *connection,
4905 DBusAddWatchFunction add_function,
4906 DBusRemoveWatchFunction remove_function,
4907 DBusWatchToggledFunction toggled_function,
4909 DBusFreeFunction free_data_function)
4913 _dbus_return_val_if_fail (connection != NULL, FALSE);
4915 CONNECTION_LOCK (connection);
4917 retval = _dbus_watch_list_set_functions (connection->watches,
4918 add_function, remove_function,
4920 data, free_data_function);
4922 CONNECTION_UNLOCK (connection);
4928 * Sets the timeout functions for the connection. These functions are
4929 * responsible for making the application's main loop aware of timeouts.
4930 * When using Qt, typically the DBusAddTimeoutFunction would create a
4931 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4934 * The DBusTimeoutToggledFunction notifies the application that the
4935 * timeout has been enabled or disabled. Call
4936 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4937 * have no effect, and enabled timeout should be added to the main
4938 * loop. This feature is used instead of simply adding/removing the
4939 * timeout because enabling/disabling can be done without memory
4940 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4941 * to enable and disable. The toggled function may be NULL if a main
4942 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4943 * Whenever a timeout is toggled, its interval may change.
4945 * The DBusTimeout can be queried for the timer interval using
4946 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4947 * repeatedly, each time the interval elapses, starting after it has
4948 * elapsed once. The timeout stops firing when it is removed with the
4949 * given remove_function. The timer interval may change whenever the
4950 * timeout is added, removed, or toggled.
4952 * @note The thread lock on DBusConnection is held while
4953 * timeout functions are invoked, so inside these functions you
4954 * may not invoke any methods on DBusConnection or it will deadlock.
4955 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
4956 * if you encounter this issue and want to attempt writing a patch.
4958 * @param connection the connection.
4959 * @param add_function function to add a timeout.
4960 * @param remove_function function to remove a timeout.
4961 * @param toggled_function function to notify of enable/disable
4962 * @param data data to pass to add_function and remove_function.
4963 * @param free_data_function function to be called to free the data.
4964 * @returns #FALSE on failure (no memory)
4967 dbus_connection_set_timeout_functions (DBusConnection *connection,
4968 DBusAddTimeoutFunction add_function,
4969 DBusRemoveTimeoutFunction remove_function,
4970 DBusTimeoutToggledFunction toggled_function,
4972 DBusFreeFunction free_data_function)
4976 _dbus_return_val_if_fail (connection != NULL, FALSE);
4978 CONNECTION_LOCK (connection);
4980 retval = _dbus_timeout_list_set_functions (connection->timeouts,
4981 add_function, remove_function,
4983 data, free_data_function);
4985 CONNECTION_UNLOCK (connection);
4991 * Sets the mainloop wakeup function for the connection. This function
4992 * is responsible for waking up the main loop (if its sleeping in
4993 * another thread) when some some change has happened to the
4994 * connection that the mainloop needs to reconsider (e.g. a message
4995 * has been queued for writing). When using Qt, this typically
4996 * results in a call to QEventLoop::wakeUp(). When using GLib, it
4997 * would call g_main_context_wakeup().
4999 * @param connection the connection.
5000 * @param wakeup_main_function function to wake up the mainloop
5001 * @param data data to pass wakeup_main_function
5002 * @param free_data_function function to be called to free the data.
5005 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
5006 DBusWakeupMainFunction wakeup_main_function,
5008 DBusFreeFunction free_data_function)
5011 DBusFreeFunction old_free_data;
5013 _dbus_return_if_fail (connection != NULL);
5015 CONNECTION_LOCK (connection);
5016 old_data = connection->wakeup_main_data;
5017 old_free_data = connection->free_wakeup_main_data;
5019 connection->wakeup_main_function = wakeup_main_function;
5020 connection->wakeup_main_data = data;
5021 connection->free_wakeup_main_data = free_data_function;
5023 CONNECTION_UNLOCK (connection);
5025 /* Callback outside the lock */
5027 (*old_free_data) (old_data);
5031 * Set a function to be invoked when the dispatch status changes.
5032 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
5033 * dbus_connection_dispatch() needs to be called to process incoming
5034 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
5035 * from inside the DBusDispatchStatusFunction. Indeed, almost
5036 * any reentrancy in this function is a bad idea. Instead,
5037 * the DBusDispatchStatusFunction should simply save an indication
5038 * that messages should be dispatched later, when the main loop
5041 * If you don't set a dispatch status function, you have to be sure to
5042 * dispatch on every iteration of your main loop, especially if
5043 * dbus_watch_handle() or dbus_timeout_handle() were called.
5045 * @param connection the connection
5046 * @param function function to call on dispatch status changes
5047 * @param data data for function
5048 * @param free_data_function free the function data
5051 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
5052 DBusDispatchStatusFunction function,
5054 DBusFreeFunction free_data_function)
5057 DBusFreeFunction old_free_data;
5059 _dbus_return_if_fail (connection != NULL);
5061 CONNECTION_LOCK (connection);
5062 old_data = connection->dispatch_status_data;
5063 old_free_data = connection->free_dispatch_status_data;
5065 connection->dispatch_status_function = function;
5066 connection->dispatch_status_data = data;
5067 connection->free_dispatch_status_data = free_data_function;
5069 CONNECTION_UNLOCK (connection);
5071 /* Callback outside the lock */
5073 (*old_free_data) (old_data);
5077 * Get the UNIX file descriptor of the connection, if any. This can
5078 * be used for SELinux access control checks with getpeercon() for
5079 * example. DO NOT read or write to the file descriptor, or try to
5080 * select() on it; use DBusWatch for main loop integration. Not all
5081 * connections will have a file descriptor. So for adding descriptors
5082 * to the main loop, use dbus_watch_get_unix_fd() and so forth.
5084 * If the connection is socket-based, you can also use
5085 * dbus_connection_get_socket(), which will work on Windows too.
5086 * This function always fails on Windows.
5088 * Right now the returned descriptor is always a socket, but
5089 * that is not guaranteed.
5091 * @param connection the connection
5092 * @param fd return location for the file descriptor.
5093 * @returns #TRUE if fd is successfully obtained.
5096 dbus_connection_get_unix_fd (DBusConnection *connection,
5099 _dbus_return_val_if_fail (connection != NULL, FALSE);
5100 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5103 /* FIXME do this on a lower level */
5107 return dbus_connection_get_socket(connection, fd);
5111 * Gets the underlying Windows or UNIX socket file descriptor
5112 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
5113 * select() on it; use DBusWatch for main loop integration. Not all
5114 * connections will have a socket. So for adding descriptors
5115 * to the main loop, use dbus_watch_get_socket() and so forth.
5117 * If the connection is not socket-based, this function will return FALSE,
5118 * even if the connection does have a file descriptor of some kind.
5119 * i.e. this function always returns specifically a socket file descriptor.
5121 * @param connection the connection
5122 * @param fd return location for the file descriptor.
5123 * @returns #TRUE if fd is successfully obtained.
5126 dbus_connection_get_socket(DBusConnection *connection,
5131 _dbus_return_val_if_fail (connection != NULL, FALSE);
5132 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5134 CONNECTION_LOCK (connection);
5136 retval = _dbus_transport_get_socket_fd (connection->transport,
5139 CONNECTION_UNLOCK (connection);
5146 * Gets the UNIX user ID of the connection if known. Returns #TRUE if
5147 * the uid is filled in. Always returns #FALSE on non-UNIX platforms
5148 * for now, though in theory someone could hook Windows to NIS or
5149 * something. Always returns #FALSE prior to authenticating the
5152 * The UID is only read by servers from clients; clients can't usually
5153 * get the UID of servers, because servers do not authenticate to
5154 * clients. The returned UID is the UID the connection authenticated
5157 * The message bus is a server and the apps connecting to the bus
5160 * You can ask the bus to tell you the UID of another connection though
5161 * if you like; this is done with dbus_bus_get_unix_user().
5163 * @param connection the connection
5164 * @param uid return location for the user ID
5165 * @returns #TRUE if uid is filled in with a valid user ID
5168 dbus_connection_get_unix_user (DBusConnection *connection,
5173 _dbus_return_val_if_fail (connection != NULL, FALSE);
5174 _dbus_return_val_if_fail (uid != NULL, FALSE);
5176 CONNECTION_LOCK (connection);
5178 if (!_dbus_transport_get_is_authenticated (connection->transport))
5181 result = _dbus_transport_get_unix_user (connection->transport,
5185 _dbus_assert (!result);
5188 CONNECTION_UNLOCK (connection);
5194 * Gets the process ID of the connection if any.
5195 * Returns #TRUE if the pid is filled in.
5196 * Always returns #FALSE prior to authenticating the
5199 * @param connection the connection
5200 * @param pid return location for the process ID
5201 * @returns #TRUE if uid is filled in with a valid process ID
5204 dbus_connection_get_unix_process_id (DBusConnection *connection,
5209 _dbus_return_val_if_fail (connection != NULL, FALSE);
5210 _dbus_return_val_if_fail (pid != NULL, FALSE);
5212 CONNECTION_LOCK (connection);
5214 if (!_dbus_transport_get_is_authenticated (connection->transport))
5217 result = _dbus_transport_get_unix_process_id (connection->transport,
5220 CONNECTION_UNLOCK (connection);
5226 * Gets the ADT audit data of the connection if any.
5227 * Returns #TRUE if the structure pointer is returned.
5228 * Always returns #FALSE prior to authenticating the
5231 * @param connection the connection
5232 * @param data return location for audit data
5233 * @returns #TRUE if audit data is filled in with a valid ucred pointer
5236 dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
5238 dbus_int32_t *data_size)
5242 _dbus_return_val_if_fail (connection != NULL, FALSE);
5243 _dbus_return_val_if_fail (data != NULL, FALSE);
5244 _dbus_return_val_if_fail (data_size != NULL, FALSE);
5246 CONNECTION_LOCK (connection);
5248 if (!_dbus_transport_get_is_authenticated (connection->transport))
5251 result = _dbus_transport_get_adt_audit_session_data (connection->transport,
5254 CONNECTION_UNLOCK (connection);
5260 * Sets a predicate function used to determine whether a given user ID
5261 * is allowed to connect. When an incoming connection has
5262 * authenticated with a particular user ID, this function is called;
5263 * if it returns #TRUE, the connection is allowed to proceed,
5264 * otherwise the connection is disconnected.
5266 * If the function is set to #NULL (as it is by default), then
5267 * only the same UID as the server process will be allowed to
5268 * connect. Also, root is always allowed to connect.
5270 * On Windows, the function will be set and its free_data_function will
5271 * be invoked when the connection is freed or a new function is set.
5272 * However, the function will never be called, because there are
5273 * no UNIX user ids to pass to it, or at least none of the existing
5274 * auth protocols would allow authenticating as a UNIX user on Windows.
5276 * @param connection the connection
5277 * @param function the predicate
5278 * @param data data to pass to the predicate
5279 * @param free_data_function function to free the data
5282 dbus_connection_set_unix_user_function (DBusConnection *connection,
5283 DBusAllowUnixUserFunction function,
5285 DBusFreeFunction free_data_function)
5287 void *old_data = NULL;
5288 DBusFreeFunction old_free_function = NULL;
5290 _dbus_return_if_fail (connection != NULL);
5292 CONNECTION_LOCK (connection);
5293 _dbus_transport_set_unix_user_function (connection->transport,
5294 function, data, free_data_function,
5295 &old_data, &old_free_function);
5296 CONNECTION_UNLOCK (connection);
5298 if (old_free_function != NULL)
5299 (* old_free_function) (old_data);
5303 * Gets the Windows user SID of the connection if known. Returns
5304 * #TRUE if the ID is filled in. Always returns #FALSE on non-Windows
5305 * platforms for now, though in theory someone could hook UNIX to
5306 * Active Directory or something. Always returns #FALSE prior to
5307 * authenticating the connection.
5309 * The user is only read by servers from clients; clients can't usually
5310 * get the user of servers, because servers do not authenticate to
5311 * clients. The returned user is the user the connection authenticated
5314 * The message bus is a server and the apps connecting to the bus
5317 * The returned user string has to be freed with dbus_free().
5319 * The return value indicates whether the user SID is available;
5320 * if it's available but we don't have the memory to copy it,
5321 * then the return value is #TRUE and #NULL is given as the SID.
5323 * @todo We would like to be able to say "You can ask the bus to tell
5324 * you the user of another connection though if you like; this is done
5325 * with dbus_bus_get_windows_user()." But this has to be implemented
5326 * in bus/driver.c and dbus/dbus-bus.c, and is pointless anyway
5327 * since on Windows we only use the session bus for now.
5329 * @param connection the connection
5330 * @param windows_sid_p return location for an allocated copy of the user ID, or #NULL if no memory
5331 * @returns #TRUE if user is available (returned value may be #NULL anyway if no memory)
5334 dbus_connection_get_windows_user (DBusConnection *connection,
5335 char **windows_sid_p)
5339 _dbus_return_val_if_fail (connection != NULL, FALSE);
5340 _dbus_return_val_if_fail (windows_sid_p != NULL, FALSE);
5342 CONNECTION_LOCK (connection);
5344 if (!_dbus_transport_get_is_authenticated (connection->transport))
5347 result = _dbus_transport_get_windows_user (connection->transport,
5351 _dbus_assert (!result);
5354 CONNECTION_UNLOCK (connection);
5360 * Sets a predicate function used to determine whether a given user ID
5361 * is allowed to connect. When an incoming connection has
5362 * authenticated with a particular user ID, this function is called;
5363 * if it returns #TRUE, the connection is allowed to proceed,
5364 * otherwise the connection is disconnected.
5366 * If the function is set to #NULL (as it is by default), then
5367 * only the same user owning the server process will be allowed to
5370 * On UNIX, the function will be set and its free_data_function will
5371 * be invoked when the connection is freed or a new function is set.
5372 * However, the function will never be called, because there is no
5373 * way right now to authenticate as a Windows user on UNIX.
5375 * @param connection the connection
5376 * @param function the predicate
5377 * @param data data to pass to the predicate
5378 * @param free_data_function function to free the data
5381 dbus_connection_set_windows_user_function (DBusConnection *connection,
5382 DBusAllowWindowsUserFunction function,
5384 DBusFreeFunction free_data_function)
5386 void *old_data = NULL;
5387 DBusFreeFunction old_free_function = NULL;
5389 _dbus_return_if_fail (connection != NULL);
5391 CONNECTION_LOCK (connection);
5392 _dbus_transport_set_windows_user_function (connection->transport,
5393 function, data, free_data_function,
5394 &old_data, &old_free_function);
5395 CONNECTION_UNLOCK (connection);
5397 if (old_free_function != NULL)
5398 (* old_free_function) (old_data);
5402 * This function must be called on the server side of a connection when the
5403 * connection is first seen in the #DBusNewConnectionFunction. If set to
5404 * #TRUE (the default is #FALSE), then the connection can proceed even if
5405 * the client does not authenticate as some user identity, i.e. clients
5406 * can connect anonymously.
5408 * This setting interacts with the available authorization mechanisms
5409 * (see dbus_server_set_auth_mechanisms()). Namely, an auth mechanism
5410 * such as ANONYMOUS that supports anonymous auth must be included in
5411 * the list of available mechanisms for anonymous login to work.
5413 * This setting also changes the default rule for connections
5414 * authorized as a user; normally, if a connection authorizes as
5415 * a user identity, it is permitted if the user identity is
5416 * root or the user identity matches the user identity of the server
5417 * process. If anonymous connections are allowed, however,
5418 * then any user identity is allowed.
5420 * You can override the rules for connections authorized as a
5421 * user identity with dbus_connection_set_unix_user_function()
5422 * and dbus_connection_set_windows_user_function().
5424 * @param connection the connection
5425 * @param value whether to allow authentication as an anonymous user
5428 dbus_connection_set_allow_anonymous (DBusConnection *connection,
5431 _dbus_return_if_fail (connection != NULL);
5433 CONNECTION_LOCK (connection);
5434 _dbus_transport_set_allow_anonymous (connection->transport, value);
5435 CONNECTION_UNLOCK (connection);
5440 * Normally #DBusConnection automatically handles all messages to the
5441 * org.freedesktop.DBus.Peer interface. However, the message bus wants
5442 * to be able to route methods on that interface through the bus and
5443 * to other applications. If routing peer messages is enabled, then
5444 * messages with the org.freedesktop.DBus.Peer interface that also
5445 * have a bus destination name set will not be automatically
5446 * handled by the #DBusConnection and instead will be dispatched
5447 * normally to the application.
5449 * If a normal application sets this flag, it can break things badly.
5450 * So don't set this unless you are the message bus.
5452 * @param connection the connection
5453 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
5456 dbus_connection_set_route_peer_messages (DBusConnection *connection,
5459 _dbus_return_if_fail (connection != NULL);
5461 CONNECTION_LOCK (connection);
5462 connection->route_peer_messages = TRUE;
5463 CONNECTION_UNLOCK (connection);
5467 * Adds a message filter. Filters are handlers that are run on all
5468 * incoming messages, prior to the objects registered with
5469 * dbus_connection_register_object_path(). Filters are run in the
5470 * order that they were added. The same handler can be added as a
5471 * filter more than once, in which case it will be run more than once.
5472 * Filters added during a filter callback won't be run on the message
5475 * @todo we don't run filters on messages while blocking without
5476 * entering the main loop, since filters are run as part of
5477 * dbus_connection_dispatch(). This is probably a feature, as filters
5478 * could create arbitrary reentrancy. But kind of sucks if you're
5479 * trying to filter METHOD_RETURN for some reason.
5481 * @param connection the connection
5482 * @param function function to handle messages
5483 * @param user_data user data to pass to the function
5484 * @param free_data_function function to use for freeing user data
5485 * @returns #TRUE on success, #FALSE if not enough memory.
5488 dbus_connection_add_filter (DBusConnection *connection,
5489 DBusHandleMessageFunction function,
5491 DBusFreeFunction free_data_function)
5493 DBusMessageFilter *filter;
5495 _dbus_return_val_if_fail (connection != NULL, FALSE);
5496 _dbus_return_val_if_fail (function != NULL, FALSE);
5498 filter = dbus_new0 (DBusMessageFilter, 1);
5502 _dbus_atomic_inc (&filter->refcount);
5504 CONNECTION_LOCK (connection);
5506 if (!_dbus_list_append (&connection->filter_list,
5509 _dbus_message_filter_unref (filter);
5510 CONNECTION_UNLOCK (connection);
5514 /* Fill in filter after all memory allocated,
5515 * so we don't run the free_user_data_function
5516 * if the add_filter() fails
5519 filter->function = function;
5520 filter->user_data = user_data;
5521 filter->free_user_data_function = free_data_function;
5523 CONNECTION_UNLOCK (connection);
5528 * Removes a previously-added message filter. It is a programming
5529 * error to call this function for a handler that has not been added
5530 * as a filter. If the given handler was added more than once, only
5531 * one instance of it will be removed (the most recently-added
5534 * @param connection the connection
5535 * @param function the handler to remove
5536 * @param user_data user data for the handler to remove
5540 dbus_connection_remove_filter (DBusConnection *connection,
5541 DBusHandleMessageFunction function,
5545 DBusMessageFilter *filter;
5547 _dbus_return_if_fail (connection != NULL);
5548 _dbus_return_if_fail (function != NULL);
5550 CONNECTION_LOCK (connection);
5554 link = _dbus_list_get_last_link (&connection->filter_list);
5555 while (link != NULL)
5557 filter = link->data;
5559 if (filter->function == function &&
5560 filter->user_data == user_data)
5562 _dbus_list_remove_link (&connection->filter_list, link);
5563 filter->function = NULL;
5568 link = _dbus_list_get_prev_link (&connection->filter_list, link);
5572 CONNECTION_UNLOCK (connection);
5574 #ifndef DBUS_DISABLE_CHECKS
5577 _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5578 function, user_data);
5583 /* Call application code */
5584 if (filter->free_user_data_function)
5585 (* filter->free_user_data_function) (filter->user_data);
5587 filter->free_user_data_function = NULL;
5588 filter->user_data = NULL;
5590 _dbus_message_filter_unref (filter);
5594 * Registers a handler for a given path or subsection in the object
5595 * hierarchy. The given vtable handles messages sent to exactly the
5596 * given path or also for paths bellow that, depending on fallback
5599 * @param connection the connection
5600 * @param fallback whether to handle messages also for "subdirectory"
5601 * @param path a '/' delimited string of path elements
5602 * @param vtable the virtual table
5603 * @param user_data data to pass to functions in the vtable
5604 * @param error address where an error can be returned
5605 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5606 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5609 _dbus_connection_register_object_path (DBusConnection *connection,
5610 dbus_bool_t fallback,
5612 const DBusObjectPathVTable *vtable,
5616 char **decomposed_path;
5619 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5622 CONNECTION_LOCK (connection);
5624 retval = _dbus_object_tree_register (connection->objects,
5626 (const char **) decomposed_path, vtable,
5629 CONNECTION_UNLOCK (connection);
5631 dbus_free_string_array (decomposed_path);
5637 * Registers a handler for a given path in the object hierarchy.
5638 * The given vtable handles messages sent to exactly the given path.
5640 * @param connection the connection
5641 * @param path a '/' delimited string of path elements
5642 * @param vtable the virtual table
5643 * @param user_data data to pass to functions in the vtable
5644 * @param error address where an error can be returned
5645 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5646 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5649 dbus_connection_try_register_object_path (DBusConnection *connection,
5651 const DBusObjectPathVTable *vtable,
5655 _dbus_return_val_if_fail (connection != NULL, FALSE);
5656 _dbus_return_val_if_fail (path != NULL, FALSE);
5657 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5658 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5660 return _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, error);
5664 * Registers a handler for a given path in the object hierarchy.
5665 * The given vtable handles messages sent to exactly the given path.
5667 * It is a bug to call this function for object paths which already
5668 * have a handler. Use dbus_connection_try_register_object_path() if this
5669 * might be the case.
5671 * @param connection the connection
5672 * @param path a '/' delimited string of path elements
5673 * @param vtable the virtual table
5674 * @param user_data data to pass to functions in the vtable
5675 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5676 * #DBUS_ERROR_OBJECT_PATH_IN_USE) ocurred
5679 dbus_connection_register_object_path (DBusConnection *connection,
5681 const DBusObjectPathVTable *vtable,
5685 DBusError error = DBUS_ERROR_INIT;
5687 _dbus_return_val_if_fail (connection != NULL, FALSE);
5688 _dbus_return_val_if_fail (path != NULL, FALSE);
5689 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5690 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5692 retval = _dbus_connection_register_object_path (connection, FALSE, path, vtable, user_data, &error);
5694 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5696 _dbus_warn ("%s\n", error.message);
5697 dbus_error_free (&error);
5705 * Registers a fallback handler for a given subsection of the object
5706 * hierarchy. The given vtable handles messages at or below the given
5707 * path. You can use this to establish a default message handling
5708 * policy for a whole "subdirectory."
5710 * @param connection the connection
5711 * @param path a '/' delimited string of path elements
5712 * @param vtable the virtual table
5713 * @param user_data data to pass to functions in the vtable
5714 * @param error address where an error can be returned
5715 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5716 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5719 dbus_connection_try_register_fallback (DBusConnection *connection,
5721 const DBusObjectPathVTable *vtable,
5725 _dbus_return_val_if_fail (connection != NULL, FALSE);
5726 _dbus_return_val_if_fail (path != NULL, FALSE);
5727 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5728 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5730 return _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, error);
5734 * Registers a fallback handler for a given subsection of the object
5735 * hierarchy. The given vtable handles messages at or below the given
5736 * path. You can use this to establish a default message handling
5737 * policy for a whole "subdirectory."
5739 * It is a bug to call this function for object paths which already
5740 * have a handler. Use dbus_connection_try_register_fallback() if this
5741 * might be the case.
5743 * @param connection the connection
5744 * @param path a '/' delimited string of path elements
5745 * @param vtable the virtual table
5746 * @param user_data data to pass to functions in the vtable
5747 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5748 * #DBUS_ERROR_OBJECT_PATH_IN_USE) occured
5751 dbus_connection_register_fallback (DBusConnection *connection,
5753 const DBusObjectPathVTable *vtable,
5757 DBusError error = DBUS_ERROR_INIT;
5759 _dbus_return_val_if_fail (connection != NULL, FALSE);
5760 _dbus_return_val_if_fail (path != NULL, FALSE);
5761 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5762 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5764 retval = _dbus_connection_register_object_path (connection, TRUE, path, vtable, user_data, &error);
5766 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5768 _dbus_warn ("%s\n", error.message);
5769 dbus_error_free (&error);
5777 * Unregisters the handler registered with exactly the given path.
5778 * It's a bug to call this function for a path that isn't registered.
5779 * Can unregister both fallback paths and object paths.
5781 * @param connection the connection
5782 * @param path a '/' delimited string of path elements
5783 * @returns #FALSE if not enough memory
5786 dbus_connection_unregister_object_path (DBusConnection *connection,
5789 char **decomposed_path;
5791 _dbus_return_val_if_fail (connection != NULL, FALSE);
5792 _dbus_return_val_if_fail (path != NULL, FALSE);
5793 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5795 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5798 CONNECTION_LOCK (connection);
5800 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5802 dbus_free_string_array (decomposed_path);
5808 * Gets the user data passed to dbus_connection_register_object_path()
5809 * or dbus_connection_register_fallback(). If nothing was registered
5810 * at this path, the data is filled in with #NULL.
5812 * @param connection the connection
5813 * @param path the path you registered with
5814 * @param data_p location to store the user data, or #NULL
5815 * @returns #FALSE if not enough memory
5818 dbus_connection_get_object_path_data (DBusConnection *connection,
5822 char **decomposed_path;
5824 _dbus_return_val_if_fail (connection != NULL, FALSE);
5825 _dbus_return_val_if_fail (path != NULL, FALSE);
5826 _dbus_return_val_if_fail (data_p != NULL, FALSE);
5830 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5833 CONNECTION_LOCK (connection);
5835 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5837 CONNECTION_UNLOCK (connection);
5839 dbus_free_string_array (decomposed_path);
5845 * Lists the registered fallback handlers and object path handlers at
5846 * the given parent_path. The returned array should be freed with
5847 * dbus_free_string_array().
5849 * @param connection the connection
5850 * @param parent_path the path to list the child handlers of
5851 * @param child_entries returns #NULL-terminated array of children
5852 * @returns #FALSE if no memory to allocate the child entries
5855 dbus_connection_list_registered (DBusConnection *connection,
5856 const char *parent_path,
5857 char ***child_entries)
5859 char **decomposed_path;
5861 _dbus_return_val_if_fail (connection != NULL, FALSE);
5862 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5863 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5864 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5866 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5869 CONNECTION_LOCK (connection);
5871 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5872 (const char **) decomposed_path,
5874 dbus_free_string_array (decomposed_path);
5879 static DBusDataSlotAllocator slot_allocator =
5880 _DBUS_DATA_SLOT_ALLOCATOR_INIT (_DBUS_LOCK_NAME (connection_slots));
5883 * Allocates an integer ID to be used for storing application-specific
5884 * data on any DBusConnection. The allocated ID may then be used
5885 * with dbus_connection_set_data() and dbus_connection_get_data().
5886 * The passed-in slot must be initialized to -1, and is filled in
5887 * with the slot ID. If the passed-in slot is not -1, it's assumed
5888 * to be already allocated, and its refcount is incremented.
5890 * The allocated slot is global, i.e. all DBusConnection objects will
5891 * have a slot with the given integer ID reserved.
5893 * @param slot_p address of a global variable storing the slot
5894 * @returns #FALSE on failure (no memory)
5897 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5899 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5904 * Deallocates a global ID for connection data slots.
5905 * dbus_connection_get_data() and dbus_connection_set_data() may no
5906 * longer be used with this slot. Existing data stored on existing
5907 * DBusConnection objects will be freed when the connection is
5908 * finalized, but may not be retrieved (and may only be replaced if
5909 * someone else reallocates the slot). When the refcount on the
5910 * passed-in slot reaches 0, it is set to -1.
5912 * @param slot_p address storing the slot to deallocate
5915 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5917 _dbus_return_if_fail (*slot_p >= 0);
5919 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5923 * Stores a pointer on a DBusConnection, along
5924 * with an optional function to be used for freeing
5925 * the data when the data is set again, or when
5926 * the connection is finalized. The slot number
5927 * must have been allocated with dbus_connection_allocate_data_slot().
5929 * @note This function does not take the
5930 * main thread lock on DBusConnection, which allows it to be
5931 * used from inside watch and timeout functions. (See the
5932 * note in docs for dbus_connection_set_watch_functions().)
5933 * A side effect of this is that you need to know there's
5934 * a reference held on the connection while invoking
5935 * dbus_connection_set_data(), or the connection could be
5936 * finalized during dbus_connection_set_data().
5938 * @param connection the connection
5939 * @param slot the slot number
5940 * @param data the data to store
5941 * @param free_data_func finalizer function for the data
5942 * @returns #TRUE if there was enough memory to store the data
5945 dbus_connection_set_data (DBusConnection *connection,
5948 DBusFreeFunction free_data_func)
5950 DBusFreeFunction old_free_func;
5954 _dbus_return_val_if_fail (connection != NULL, FALSE);
5955 _dbus_return_val_if_fail (slot >= 0, FALSE);
5957 SLOTS_LOCK (connection);
5959 retval = _dbus_data_slot_list_set (&slot_allocator,
5960 &connection->slot_list,
5961 slot, data, free_data_func,
5962 &old_free_func, &old_data);
5964 SLOTS_UNLOCK (connection);
5968 /* Do the actual free outside the connection lock */
5970 (* old_free_func) (old_data);
5977 * Retrieves data previously set with dbus_connection_set_data().
5978 * The slot must still be allocated (must not have been freed).
5980 * @note This function does not take the
5981 * main thread lock on DBusConnection, which allows it to be
5982 * used from inside watch and timeout functions. (See the
5983 * note in docs for dbus_connection_set_watch_functions().)
5984 * A side effect of this is that you need to know there's
5985 * a reference held on the connection while invoking
5986 * dbus_connection_get_data(), or the connection could be
5987 * finalized during dbus_connection_get_data().
5989 * @param connection the connection
5990 * @param slot the slot to get data from
5991 * @returns the data, or #NULL if not found
5994 dbus_connection_get_data (DBusConnection *connection,
5999 _dbus_return_val_if_fail (connection != NULL, NULL);
6000 _dbus_return_val_if_fail (slot >= 0, NULL);
6002 SLOTS_LOCK (connection);
6004 res = _dbus_data_slot_list_get (&slot_allocator,
6005 &connection->slot_list,
6008 SLOTS_UNLOCK (connection);
6014 * This function sets a global flag for whether dbus_connection_new()
6015 * will set SIGPIPE behavior to SIG_IGN.
6017 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
6020 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
6022 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
6026 * Specifies the maximum size message this connection is allowed to
6027 * receive. Larger messages will result in disconnecting the
6030 * @param connection a #DBusConnection
6031 * @param size maximum message size the connection can receive, in bytes
6034 dbus_connection_set_max_message_size (DBusConnection *connection,
6037 _dbus_return_if_fail (connection != NULL);
6039 CONNECTION_LOCK (connection);
6040 _dbus_transport_set_max_message_size (connection->transport,
6042 CONNECTION_UNLOCK (connection);
6046 * Gets the value set by dbus_connection_set_max_message_size().
6048 * @param connection the connection
6049 * @returns the max size of a single message
6052 dbus_connection_get_max_message_size (DBusConnection *connection)
6056 _dbus_return_val_if_fail (connection != NULL, 0);
6058 CONNECTION_LOCK (connection);
6059 res = _dbus_transport_get_max_message_size (connection->transport);
6060 CONNECTION_UNLOCK (connection);
6065 * Specifies the maximum number of unix fds a message on this
6066 * connection is allowed to receive. Messages with more unix fds will
6067 * result in disconnecting the connection.
6069 * @param connection a #DBusConnection
6070 * @param size maximum message unix fds the connection can receive
6073 dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
6076 _dbus_return_if_fail (connection != NULL);
6078 CONNECTION_LOCK (connection);
6079 _dbus_transport_set_max_message_unix_fds (connection->transport,
6081 CONNECTION_UNLOCK (connection);
6085 * Gets the value set by dbus_connection_set_max_message_unix_fds().
6087 * @param connection the connection
6088 * @returns the max numer of unix fds of a single message
6091 dbus_connection_get_max_message_unix_fds (DBusConnection *connection)
6095 _dbus_return_val_if_fail (connection != NULL, 0);
6097 CONNECTION_LOCK (connection);
6098 res = _dbus_transport_get_max_message_unix_fds (connection->transport);
6099 CONNECTION_UNLOCK (connection);
6104 * Sets the maximum total number of bytes that can be used for all messages
6105 * received on this connection. Messages count toward the maximum until
6106 * they are finalized. When the maximum is reached, the connection will
6107 * not read more data until some messages are finalized.
6109 * The semantics of the maximum are: if outstanding messages are
6110 * already above the maximum, additional messages will not be read.
6111 * The semantics are not: if the next message would cause us to exceed
6112 * the maximum, we don't read it. The reason is that we don't know the
6113 * size of a message until after we read it.
6115 * Thus, the max live messages size can actually be exceeded
6116 * by up to the maximum size of a single message.
6118 * Also, if we read say 1024 bytes off the wire in a single read(),
6119 * and that contains a half-dozen small messages, we may exceed the
6120 * size max by that amount. But this should be inconsequential.
6122 * This does imply that we can't call read() with a buffer larger
6123 * than we're willing to exceed this limit by.
6125 * @param connection the connection
6126 * @param size the maximum size in bytes of all outstanding messages
6129 dbus_connection_set_max_received_size (DBusConnection *connection,
6132 _dbus_return_if_fail (connection != NULL);
6134 CONNECTION_LOCK (connection);
6135 _dbus_transport_set_max_received_size (connection->transport,
6137 CONNECTION_UNLOCK (connection);
6141 * Gets the value set by dbus_connection_set_max_received_size().
6143 * @param connection the connection
6144 * @returns the max size of all live messages
6147 dbus_connection_get_max_received_size (DBusConnection *connection)
6151 _dbus_return_val_if_fail (connection != NULL, 0);
6153 CONNECTION_LOCK (connection);
6154 res = _dbus_transport_get_max_received_size (connection->transport);
6155 CONNECTION_UNLOCK (connection);
6160 * Sets the maximum total number of unix fds that can be used for all messages
6161 * received on this connection. Messages count toward the maximum until
6162 * they are finalized. When the maximum is reached, the connection will
6163 * not read more data until some messages are finalized.
6165 * The semantics are analogous to those of dbus_connection_set_max_received_size().
6167 * @param connection the connection
6168 * @param size the maximum size in bytes of all outstanding messages
6171 dbus_connection_set_max_received_unix_fds (DBusConnection *connection,
6174 _dbus_return_if_fail (connection != NULL);
6176 CONNECTION_LOCK (connection);
6177 _dbus_transport_set_max_received_unix_fds (connection->transport,
6179 CONNECTION_UNLOCK (connection);
6183 * Gets the value set by dbus_connection_set_max_received_unix_fds().
6185 * @param connection the connection
6186 * @returns the max unix fds of all live messages
6189 dbus_connection_get_max_received_unix_fds (DBusConnection *connection)
6193 _dbus_return_val_if_fail (connection != NULL, 0);
6195 CONNECTION_LOCK (connection);
6196 res = _dbus_transport_get_max_received_unix_fds (connection->transport);
6197 CONNECTION_UNLOCK (connection);
6202 * Gets the approximate size in bytes of all messages in the outgoing
6203 * message queue. The size is approximate in that you shouldn't use
6204 * it to decide how many bytes to read off the network or anything
6205 * of that nature, as optimizations may choose to tell small white lies
6206 * to avoid performance overhead.
6208 * @param connection the connection
6209 * @returns the number of bytes that have been queued up but not sent
6212 dbus_connection_get_outgoing_size (DBusConnection *connection)
6216 _dbus_return_val_if_fail (connection != NULL, 0);
6218 CONNECTION_LOCK (connection);
6219 res = _dbus_counter_get_size_value (connection->outgoing_counter);
6220 CONNECTION_UNLOCK (connection);
6224 #ifdef DBUS_ENABLE_STATS
6226 _dbus_connection_get_stats (DBusConnection *connection,
6227 dbus_uint32_t *in_messages,
6228 dbus_uint32_t *in_bytes,
6229 dbus_uint32_t *in_fds,
6230 dbus_uint32_t *in_peak_bytes,
6231 dbus_uint32_t *in_peak_fds,
6232 dbus_uint32_t *out_messages,
6233 dbus_uint32_t *out_bytes,
6234 dbus_uint32_t *out_fds,
6235 dbus_uint32_t *out_peak_bytes,
6236 dbus_uint32_t *out_peak_fds)
6238 CONNECTION_LOCK (connection);
6240 if (in_messages != NULL)
6241 *in_messages = connection->n_incoming;
6243 _dbus_transport_get_stats (connection->transport,
6244 in_bytes, in_fds, in_peak_bytes, in_peak_fds);
6246 if (out_messages != NULL)
6247 *out_messages = connection->n_outgoing;
6249 if (out_bytes != NULL)
6250 *out_bytes = _dbus_counter_get_size_value (connection->outgoing_counter);
6252 if (out_fds != NULL)
6253 *out_fds = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6255 if (out_peak_bytes != NULL)
6256 *out_peak_bytes = _dbus_counter_get_peak_size_value (connection->outgoing_counter);
6258 if (out_peak_fds != NULL)
6259 *out_peak_fds = _dbus_counter_get_peak_unix_fd_value (connection->outgoing_counter);
6261 CONNECTION_UNLOCK (connection);
6263 #endif /* DBUS_ENABLE_STATS */
6266 * Gets the approximate number of uni fds of all messages in the
6267 * outgoing message queue.
6269 * @param connection the connection
6270 * @returns the number of unix fds that have been queued up but not sent
6273 dbus_connection_get_outgoing_unix_fds (DBusConnection *connection)
6277 _dbus_return_val_if_fail (connection != NULL, 0);
6279 CONNECTION_LOCK (connection);
6280 res = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6281 CONNECTION_UNLOCK (connection);
6285 #ifdef DBUS_BUILD_TESTS
6287 * Returns the address of the transport object of this connection
6289 * @param connection the connection
6290 * @returns the address string
6293 _dbus_connection_get_address (DBusConnection *connection)
6295 return _dbus_transport_get_address (connection->transport);