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-pending-call.h"
42 #include "dbus-object-tree.h"
43 #include "dbus-threads-internal.h"
45 #include "dbus-marshal-basic.h"
47 #ifdef DBUS_DISABLE_CHECKS
48 #define TOOK_LOCK_CHECK(connection)
49 #define RELEASING_LOCK_CHECK(connection)
50 #define HAVE_LOCK_CHECK(connection)
52 #define TOOK_LOCK_CHECK(connection) do { \
53 _dbus_assert (!(connection)->have_connection_lock); \
54 (connection)->have_connection_lock = TRUE; \
56 #define RELEASING_LOCK_CHECK(connection) do { \
57 _dbus_assert ((connection)->have_connection_lock); \
58 (connection)->have_connection_lock = FALSE; \
60 #define HAVE_LOCK_CHECK(connection) _dbus_assert ((connection)->have_connection_lock)
61 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
66 #define CONNECTION_LOCK(connection) do { \
67 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
68 _dbus_mutex_lock ((connection)->mutex); \
69 TOOK_LOCK_CHECK (connection); \
72 #define CONNECTION_UNLOCK(connection) do { \
73 if (TRACE_LOCKS) { _dbus_verbose ("UNLOCK\n"); } \
74 RELEASING_LOCK_CHECK (connection); \
75 _dbus_mutex_unlock ((connection)->mutex); \
78 #define SLOTS_LOCK(connection) do { \
79 _dbus_mutex_lock ((connection)->slot_mutex); \
82 #define SLOTS_UNLOCK(connection) do { \
83 _dbus_mutex_unlock ((connection)->slot_mutex); \
86 #define DISPATCH_STATUS_NAME(s) \
87 ((s) == DBUS_DISPATCH_COMPLETE ? "complete" : \
88 (s) == DBUS_DISPATCH_DATA_REMAINS ? "data remains" : \
89 (s) == DBUS_DISPATCH_NEED_MEMORY ? "need memory" : \
93 * @defgroup DBusConnection DBusConnection
95 * @brief Connection to another application
97 * A DBusConnection represents a connection to another
98 * application. Messages can be sent and received via this connection.
99 * The other application may be a message bus; for convenience, the
100 * function dbus_bus_get() is provided to automatically open a
101 * connection to the well-known message buses.
103 * In brief a DBusConnection is a message queue associated with some
104 * message transport mechanism such as a socket. The connection
105 * maintains a queue of incoming messages and a queue of outgoing
108 * Several functions use the following terms:
110 * <li><b>read</b> means to fill the incoming message queue by reading from the socket</li>
111 * <li><b>write</b> means to drain the outgoing queue by writing to the socket</li>
112 * <li><b>dispatch</b> means to drain the incoming queue by invoking application-provided message handlers</li>
115 * The function dbus_connection_read_write_dispatch() for example does all
116 * three of these things, offering a simple alternative to a main loop.
118 * In an application with a main loop, the read/write/dispatch
119 * operations are usually separate.
121 * The connection provides #DBusWatch and #DBusTimeout objects to
122 * the main loop. These are used to know when reading, writing, or
123 * dispatching should be performed.
125 * Incoming messages are processed
126 * by calling dbus_connection_dispatch(). dbus_connection_dispatch()
127 * runs any handlers registered for the topmost message in the message
128 * queue, then discards the message, then returns.
130 * dbus_connection_get_dispatch_status() indicates whether
131 * messages are currently in the queue that need dispatching.
132 * dbus_connection_set_dispatch_status_function() allows
133 * you to set a function to be used to monitor the dispatch status.
135 * If you're using GLib or Qt add-on libraries for D-Bus, there are
136 * special convenience APIs in those libraries that hide
137 * all the details of dispatch and watch/timeout monitoring.
138 * For example, dbus_connection_setup_with_g_main().
140 * If you aren't using these add-on libraries, but want to process
141 * messages asynchronously, you must manually call
142 * dbus_connection_set_dispatch_status_function(),
143 * dbus_connection_set_watch_functions(),
144 * dbus_connection_set_timeout_functions() providing appropriate
145 * functions to integrate the connection with your application's main
146 * loop. This can be tricky to get right; main loops are not simple.
148 * If you don't need to be asynchronous, you can ignore #DBusWatch,
149 * #DBusTimeout, and dbus_connection_dispatch(). Instead,
150 * dbus_connection_read_write_dispatch() can be used.
152 * Or, in <em>very</em> simple applications,
153 * dbus_connection_pop_message() may be all you need, allowing you to
154 * avoid setting up any handler functions (see
155 * dbus_connection_add_filter(),
156 * dbus_connection_register_object_path() for more on handlers).
158 * When you use dbus_connection_send() or one of its variants to send
159 * a message, the message is added to the outgoing queue. It's
160 * actually written to the network later; either in
161 * dbus_watch_handle() invoked by your main loop, or in
162 * dbus_connection_flush() which blocks until it can write out the
163 * entire outgoing queue. The GLib/Qt add-on libraries again
164 * handle the details here for you by setting up watch functions.
166 * When a connection is disconnected, you are guaranteed to get a
167 * signal "Disconnected" from the interface
168 * #DBUS_INTERFACE_LOCAL, path
171 * You may not drop the last reference to a #DBusConnection
172 * until that connection has been disconnected.
174 * You may dispatch the unprocessed incoming message queue even if the
175 * connection is disconnected. However, "Disconnected" will always be
176 * the last message in the queue (obviously no messages are received
177 * after disconnection).
179 * After calling dbus_threads_init(), #DBusConnection has thread
180 * locks and drops them when invoking user callbacks, so in general is
181 * transparently threadsafe. However, #DBusMessage does NOT have
182 * thread locks; you must not send the same message to multiple
183 * #DBusConnection if those connections will be used from different threads,
186 * Also, if you dispatch or pop messages from multiple threads, it
187 * may work in the sense that it won't crash, but it's tough to imagine
188 * sane results; it will be completely unpredictable which messages
189 * go to which threads.
191 * It's recommended to dispatch from a single thread.
193 * The most useful function to call from multiple threads at once
194 * is dbus_connection_send_with_reply_and_block(). That is,
195 * multiple threads can make method calls at the same time.
197 * If you aren't using threads, you can use a main loop and
198 * dbus_pending_call_set_notify() to achieve a similar result.
202 * @defgroup DBusConnectionInternals DBusConnection implementation details
203 * @ingroup DBusInternals
204 * @brief Implementation details of DBusConnection
210 * Internal struct representing a message filter function
212 typedef struct DBusMessageFilter DBusMessageFilter;
215 * Internal struct representing a message filter function
217 struct DBusMessageFilter
219 DBusAtomic refcount; /**< Reference count */
220 DBusHandleMessageFunction function; /**< Function to call to filter */
221 void *user_data; /**< User data for the function */
222 DBusFreeFunction free_user_data_function; /**< Function to free the user data */
227 * Internals of DBusPreallocatedSend
229 struct DBusPreallocatedSend
231 DBusConnection *connection; /**< Connection we'd send the message to */
232 DBusList *queue_link; /**< Preallocated link in the queue */
233 DBusList *counter_link; /**< Preallocated link in the resource counter */
236 #ifdef HAVE_DECL_MSG_NOSIGNAL
237 static dbus_bool_t _dbus_modify_sigpipe = FALSE;
239 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
243 * Implementation details of DBusConnection. All fields are private.
245 struct DBusConnection
247 DBusAtomic refcount; /**< Reference count. */
249 DBusMutex *mutex; /**< Lock on the entire DBusConnection */
251 DBusMutex *dispatch_mutex; /**< Protects dispatch_acquired */
252 DBusCondVar *dispatch_cond; /**< Notify when dispatch_acquired is available */
253 DBusMutex *io_path_mutex; /**< Protects io_path_acquired */
254 DBusCondVar *io_path_cond; /**< Notify when io_path_acquired is available */
256 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
257 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
259 DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
260 * dispatch_acquired will be set by the borrower
263 int n_outgoing; /**< Length of outgoing queue. */
264 int n_incoming; /**< Length of incoming queue. */
266 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
268 DBusTransport *transport; /**< Object that sends/receives messages over network. */
269 DBusWatchList *watches; /**< Stores active watches. */
270 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
272 DBusList *filter_list; /**< List of filters. */
274 DBusMutex *slot_mutex; /**< Lock on slot_list so overall connection lock need not be taken */
275 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
277 DBusHashTable *pending_replies; /**< Hash of message serials to #DBusPendingCall. */
279 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
280 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
282 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
283 void *wakeup_main_data; /**< Application data for wakeup_main_function */
284 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
286 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
287 void *dispatch_status_data; /**< Application data for dispatch_status_function */
288 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
290 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
292 DBusList *link_cache; /**< A cache of linked list links to prevent contention
293 * for the global linked list mempool lock
295 DBusObjectTree *objects; /**< Object path handlers registered with this connection */
297 char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
299 /* These two MUST be bools and not bitfields, because they are protected by a separate lock
300 * from connection->mutex and all bitfields in a word have to be read/written together.
301 * So you can't have a different lock for different bitfields in the same word.
303 dbus_bool_t dispatch_acquired; /**< Someone has dispatch path (can drain incoming queue) */
304 dbus_bool_t io_path_acquired; /**< Someone has transport io path (can use the transport to read/write messages) */
306 unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
308 unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
310 unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
312 unsigned int disconnected_message_arrived : 1; /**< We popped or are dispatching the disconnected message.
313 * if the disconnect_message_link is NULL then we queued it, but
314 * this flag is whether it got to the head of the queue.
316 unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
317 * such as closing the connection.
320 #ifndef DBUS_DISABLE_CHECKS
321 unsigned int have_connection_lock : 1; /**< Used to check locking */
324 #ifndef DBUS_DISABLE_CHECKS
325 int generation; /**< _dbus_current_generation that should correspond to this connection */
329 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
330 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
331 DBusDispatchStatus new_status);
332 static void _dbus_connection_last_unref (DBusConnection *connection);
333 static void _dbus_connection_acquire_dispatch (DBusConnection *connection);
334 static void _dbus_connection_release_dispatch (DBusConnection *connection);
335 static DBusDispatchStatus _dbus_connection_flush_unlocked (DBusConnection *connection);
336 static void _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection);
337 static dbus_bool_t _dbus_connection_get_is_connected_unlocked (DBusConnection *connection);
338 static dbus_bool_t _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
339 dbus_uint32_t client_serial);
341 static DBusMessageFilter *
342 _dbus_message_filter_ref (DBusMessageFilter *filter)
344 _dbus_assert (filter->refcount.value > 0);
345 _dbus_atomic_inc (&filter->refcount);
351 _dbus_message_filter_unref (DBusMessageFilter *filter)
353 _dbus_assert (filter->refcount.value > 0);
355 if (_dbus_atomic_dec (&filter->refcount) == 1)
357 if (filter->free_user_data_function)
358 (* filter->free_user_data_function) (filter->user_data);
365 * Acquires the connection lock.
367 * @param connection the connection.
370 _dbus_connection_lock (DBusConnection *connection)
372 CONNECTION_LOCK (connection);
376 * Releases the connection lock.
378 * @param connection the connection.
381 _dbus_connection_unlock (DBusConnection *connection)
383 CONNECTION_UNLOCK (connection);
387 * Wakes up the main loop if it is sleeping
388 * Needed if we're e.g. queueing outgoing messages
389 * on a thread while the mainloop sleeps.
391 * @param connection the connection.
394 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
396 if (connection->wakeup_main_function)
397 (*connection->wakeup_main_function) (connection->wakeup_main_data);
400 #ifdef DBUS_BUILD_TESTS
401 /* For now this function isn't used */
403 * Adds a message to the incoming message queue, returning #FALSE
404 * if there's insufficient memory to queue the message.
405 * Does not take over refcount of the message.
407 * @param connection the connection.
408 * @param message the message to queue.
409 * @returns #TRUE on success.
412 _dbus_connection_queue_received_message (DBusConnection *connection,
413 DBusMessage *message)
417 link = _dbus_list_alloc_link (message);
421 dbus_message_ref (message);
422 _dbus_connection_queue_received_message_link (connection, link);
428 * Gets the locks so we can examine them
430 * @param connection the connection.
431 * @param mutex_loc return for the location of the main mutex pointer
432 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
433 * @param io_path_mutex_loc return location of the io_path mutex pointer
434 * @param dispatch_cond_loc return location of the dispatch conditional
436 * @param io_path_cond_loc return location of the io_path conditional
440 _dbus_connection_test_get_locks (DBusConnection *connection,
441 DBusMutex **mutex_loc,
442 DBusMutex **dispatch_mutex_loc,
443 DBusMutex **io_path_mutex_loc,
444 DBusCondVar **dispatch_cond_loc,
445 DBusCondVar **io_path_cond_loc)
447 *mutex_loc = connection->mutex;
448 *dispatch_mutex_loc = connection->dispatch_mutex;
449 *io_path_mutex_loc = connection->io_path_mutex;
450 *dispatch_cond_loc = connection->dispatch_cond;
451 *io_path_cond_loc = connection->io_path_cond;
456 * Adds a message-containing list link to the incoming message queue,
457 * taking ownership of the link and the message's current refcount.
458 * Cannot fail due to lack of memory.
460 * @param connection the connection.
461 * @param link the message link to queue.
464 _dbus_connection_queue_received_message_link (DBusConnection *connection,
467 DBusPendingCall *pending;
468 dbus_uint32_t reply_serial;
469 DBusMessage *message;
471 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
473 _dbus_list_append_link (&connection->incoming_messages,
475 message = link->data;
477 /* If this is a reply we're waiting on, remove timeout for it */
478 reply_serial = dbus_message_get_reply_serial (message);
479 if (reply_serial != 0)
481 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
485 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
486 _dbus_connection_remove_timeout_unlocked (connection,
487 _dbus_pending_call_get_timeout_unlocked (pending));
489 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
495 connection->n_incoming += 1;
497 _dbus_connection_wakeup_mainloop (connection);
499 _dbus_verbose ("Message %p (%s %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
501 dbus_message_type_to_string (dbus_message_get_type (message)),
502 dbus_message_get_path (message) ?
503 dbus_message_get_path (message) :
505 dbus_message_get_interface (message) ?
506 dbus_message_get_interface (message) :
508 dbus_message_get_member (message) ?
509 dbus_message_get_member (message) :
511 dbus_message_get_signature (message),
512 dbus_message_get_reply_serial (message),
514 connection->n_incoming);}
517 * Adds a link + message to the incoming message queue.
518 * Can't fail. Takes ownership of both link and message.
520 * @param connection the connection.
521 * @param link the list node and message to queue.
525 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
528 HAVE_LOCK_CHECK (connection);
530 _dbus_list_append_link (&connection->incoming_messages, link);
532 connection->n_incoming += 1;
534 _dbus_connection_wakeup_mainloop (connection);
536 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
537 link->data, connection, connection->n_incoming);
542 * Checks whether there are messages in the outgoing message queue.
543 * Called with connection lock held.
545 * @param connection the connection.
546 * @returns #TRUE if the outgoing queue is non-empty.
549 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
551 HAVE_LOCK_CHECK (connection);
552 return connection->outgoing_messages != NULL;
556 * Checks whether there are messages in the outgoing message queue.
557 * Use dbus_connection_flush() to block until all outgoing
558 * messages have been written to the underlying transport
559 * (such as a socket).
561 * @param connection the connection.
562 * @returns #TRUE if the outgoing queue is non-empty.
565 dbus_connection_has_messages_to_send (DBusConnection *connection)
569 _dbus_return_val_if_fail (connection != NULL, FALSE);
571 CONNECTION_LOCK (connection);
572 v = _dbus_connection_has_messages_to_send_unlocked (connection);
573 CONNECTION_UNLOCK (connection);
579 * Gets the next outgoing message. The message remains in the
580 * queue, and the caller does not own a reference to it.
582 * @param connection the connection.
583 * @returns the message to be sent.
586 _dbus_connection_get_message_to_send (DBusConnection *connection)
588 HAVE_LOCK_CHECK (connection);
590 return _dbus_list_get_last (&connection->outgoing_messages);
594 * Notifies the connection that a message has been sent, so the
595 * message can be removed from the outgoing queue.
596 * Called with the connection lock held.
598 * @param connection the connection.
599 * @param message the message that was sent.
602 _dbus_connection_message_sent (DBusConnection *connection,
603 DBusMessage *message)
607 HAVE_LOCK_CHECK (connection);
609 /* This can be called before we even complete authentication, since
610 * it's called on disconnect to clean up the outgoing queue.
611 * It's also called as we successfully send each message.
614 link = _dbus_list_get_last_link (&connection->outgoing_messages);
615 _dbus_assert (link != NULL);
616 _dbus_assert (link->data == message);
618 /* Save this link in the link cache */
619 _dbus_list_unlink (&connection->outgoing_messages,
621 _dbus_list_prepend_link (&connection->link_cache, link);
623 connection->n_outgoing -= 1;
625 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
627 dbus_message_type_to_string (dbus_message_get_type (message)),
628 dbus_message_get_path (message) ?
629 dbus_message_get_path (message) :
631 dbus_message_get_interface (message) ?
632 dbus_message_get_interface (message) :
634 dbus_message_get_member (message) ?
635 dbus_message_get_member (message) :
637 dbus_message_get_signature (message),
638 connection, connection->n_outgoing);
640 /* Save this link in the link cache also */
641 _dbus_message_remove_counter (message, connection->outgoing_counter,
643 _dbus_list_prepend_link (&connection->link_cache, link);
645 dbus_message_unref (message);
648 /** Function to be called in protected_change_watch() with refcount held */
649 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
651 /** Function to be called in protected_change_watch() with refcount held */
652 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
654 /** Function to be called in protected_change_watch() with refcount held */
655 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
657 dbus_bool_t enabled);
660 protected_change_watch (DBusConnection *connection,
662 DBusWatchAddFunction add_function,
663 DBusWatchRemoveFunction remove_function,
664 DBusWatchToggleFunction toggle_function,
669 HAVE_LOCK_CHECK (connection);
671 /* The original purpose of protected_change_watch() was to hold a
672 * ref on the connection while dropping the connection lock, then
673 * calling out to the app. This was a broken hack that did not
674 * work, since the connection was in a hosed state (no WatchList
675 * field) while calling out.
677 * So for now we'll just keep the lock while calling out. This means
678 * apps are not allowed to call DBusConnection methods inside a
679 * watch function or they will deadlock.
681 * The "real fix" is to use the _and_unlock() pattern found
682 * elsewhere in the code, to defer calling out to the app until
683 * we're about to drop locks and return flow of control to the app
686 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
689 if (connection->watches)
692 retval = (* add_function) (connection->watches, watch);
693 else if (remove_function)
696 (* remove_function) (connection->watches, watch);
701 (* toggle_function) (connection->watches, watch, enabled);
711 * Adds a watch using the connection's DBusAddWatchFunction if
712 * available. Otherwise records the watch to be added when said
713 * function is available. Also re-adds the watch if the
714 * DBusAddWatchFunction changes. May fail due to lack of memory.
715 * Connection lock should be held when calling this.
717 * @param connection the connection.
718 * @param watch the watch to add.
719 * @returns #TRUE on success.
722 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
725 return protected_change_watch (connection, watch,
726 _dbus_watch_list_add_watch,
731 * Removes a watch using the connection's DBusRemoveWatchFunction
732 * if available. It's an error to call this function on a watch
733 * that was not previously added.
734 * Connection lock should be held when calling this.
736 * @param connection the connection.
737 * @param watch the watch to remove.
740 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
743 protected_change_watch (connection, watch,
745 _dbus_watch_list_remove_watch,
750 * Toggles a watch and notifies app via connection's
751 * DBusWatchToggledFunction if available. It's an error to call this
752 * function on a watch that was not previously added.
753 * Connection lock should be held when calling this.
755 * @param connection the connection.
756 * @param watch the watch to toggle.
757 * @param enabled whether to enable or disable
760 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
764 _dbus_assert (watch != NULL);
766 protected_change_watch (connection, watch,
768 _dbus_watch_list_toggle_watch,
772 /** Function to be called in protected_change_timeout() with refcount held */
773 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
774 DBusTimeout *timeout);
775 /** Function to be called in protected_change_timeout() with refcount held */
776 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
777 DBusTimeout *timeout);
778 /** Function to be called in protected_change_timeout() with refcount held */
779 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
780 DBusTimeout *timeout,
781 dbus_bool_t enabled);
784 protected_change_timeout (DBusConnection *connection,
785 DBusTimeout *timeout,
786 DBusTimeoutAddFunction add_function,
787 DBusTimeoutRemoveFunction remove_function,
788 DBusTimeoutToggleFunction toggle_function,
793 HAVE_LOCK_CHECK (connection);
795 /* The original purpose of protected_change_timeout() was to hold a
796 * ref on the connection while dropping the connection lock, then
797 * calling out to the app. This was a broken hack that did not
798 * work, since the connection was in a hosed state (no TimeoutList
799 * field) while calling out.
801 * So for now we'll just keep the lock while calling out. This means
802 * apps are not allowed to call DBusConnection methods inside a
803 * timeout function or they will deadlock.
805 * The "real fix" is to use the _and_unlock() pattern found
806 * elsewhere in the code, to defer calling out to the app until
807 * we're about to drop locks and return flow of control to the app
810 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
813 if (connection->timeouts)
816 retval = (* add_function) (connection->timeouts, timeout);
817 else if (remove_function)
820 (* remove_function) (connection->timeouts, timeout);
825 (* toggle_function) (connection->timeouts, timeout, enabled);
834 * Adds a timeout using the connection's DBusAddTimeoutFunction if
835 * available. Otherwise records the timeout to be added when said
836 * function is available. Also re-adds the timeout if the
837 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
838 * The timeout will fire repeatedly until removed.
839 * Connection lock should be held when calling this.
841 * @param connection the connection.
842 * @param timeout the timeout to add.
843 * @returns #TRUE on success.
846 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
847 DBusTimeout *timeout)
849 return protected_change_timeout (connection, timeout,
850 _dbus_timeout_list_add_timeout,
855 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
856 * if available. It's an error to call this function on a timeout
857 * that was not previously added.
858 * Connection lock should be held when calling this.
860 * @param connection the connection.
861 * @param timeout the timeout to remove.
864 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
865 DBusTimeout *timeout)
867 protected_change_timeout (connection, timeout,
869 _dbus_timeout_list_remove_timeout,
874 * Toggles a timeout and notifies app via connection's
875 * DBusTimeoutToggledFunction if available. It's an error to call this
876 * function on a timeout that was not previously added.
877 * Connection lock should be held when calling this.
879 * @param connection the connection.
880 * @param timeout the timeout to toggle.
881 * @param enabled whether to enable or disable
884 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
885 DBusTimeout *timeout,
888 protected_change_timeout (connection, timeout,
890 _dbus_timeout_list_toggle_timeout,
895 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
896 DBusPendingCall *pending)
898 dbus_uint32_t reply_serial;
899 DBusTimeout *timeout;
901 HAVE_LOCK_CHECK (connection);
903 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
905 _dbus_assert (reply_serial != 0);
907 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
911 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
914 if (!_dbus_hash_table_insert_int (connection->pending_replies,
918 _dbus_connection_remove_timeout_unlocked (connection, timeout);
920 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
921 HAVE_LOCK_CHECK (connection);
925 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
929 if (!_dbus_hash_table_insert_int (connection->pending_replies,
933 HAVE_LOCK_CHECK (connection);
938 _dbus_pending_call_ref_unlocked (pending);
940 HAVE_LOCK_CHECK (connection);
946 free_pending_call_on_hash_removal (void *data)
948 DBusPendingCall *pending;
949 DBusConnection *connection;
956 connection = _dbus_pending_call_get_connection_unlocked (pending);
958 HAVE_LOCK_CHECK (connection);
960 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
962 _dbus_connection_remove_timeout_unlocked (connection,
963 _dbus_pending_call_get_timeout_unlocked (pending));
965 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
968 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
969 * here, but the pending call finalizer could in principle call out to
970 * application code so we pretty much have to... some larger code reorg
973 _dbus_connection_ref_unlocked (connection);
974 _dbus_pending_call_unref_and_unlock (pending);
975 CONNECTION_LOCK (connection);
976 _dbus_connection_unref_unlocked (connection);
980 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
981 DBusPendingCall *pending)
983 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
986 _dbus_hash_table_remove_int (connection->pending_replies,
987 _dbus_pending_call_get_reply_serial_unlocked (pending));
991 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
992 DBusPendingCall *pending)
994 /* The idea here is to avoid finalizing the pending call
995 * with the lock held, since there's a destroy notifier
996 * in pending call that goes out to application code.
998 * There's an extra unlock inside the hash table
999 * "free pending call" function FIXME...
1001 _dbus_pending_call_ref_unlocked (pending);
1002 _dbus_hash_table_remove_int (connection->pending_replies,
1003 _dbus_pending_call_get_reply_serial_unlocked (pending));
1005 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
1006 _dbus_connection_remove_timeout_unlocked (connection,
1007 _dbus_pending_call_get_timeout_unlocked (pending));
1009 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
1011 _dbus_pending_call_unref_and_unlock (pending);
1015 * Removes a pending call from the connection, such that
1016 * the pending reply will be ignored. May drop the last
1017 * reference to the pending call.
1019 * @param connection the connection
1020 * @param pending the pending call
1023 _dbus_connection_remove_pending_call (DBusConnection *connection,
1024 DBusPendingCall *pending)
1026 CONNECTION_LOCK (connection);
1027 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
1031 * Acquire the transporter I/O path. This must be done before
1032 * doing any I/O in the transporter. May sleep and drop the
1033 * IO path mutex while waiting for the I/O path.
1035 * @param connection the connection.
1036 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1037 * @returns TRUE if the I/O path was acquired.
1040 _dbus_connection_acquire_io_path (DBusConnection *connection,
1041 int timeout_milliseconds)
1043 dbus_bool_t we_acquired;
1045 HAVE_LOCK_CHECK (connection);
1047 /* We don't want the connection to vanish */
1048 _dbus_connection_ref_unlocked (connection);
1050 /* We will only touch io_path_acquired which is protected by our mutex */
1051 CONNECTION_UNLOCK (connection);
1053 _dbus_verbose ("locking io_path_mutex\n");
1054 _dbus_mutex_lock (connection->io_path_mutex);
1056 _dbus_verbose ("start connection->io_path_acquired = %d timeout = %d\n",
1057 connection->io_path_acquired, timeout_milliseconds);
1059 we_acquired = FALSE;
1061 if (connection->io_path_acquired)
1063 if (timeout_milliseconds != -1)
1065 _dbus_verbose ("waiting %d for IO path to be acquirable\n",
1066 timeout_milliseconds);
1068 if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1069 connection->io_path_mutex,
1070 timeout_milliseconds))
1072 /* We timed out before anyone signaled. */
1073 /* (writing the loop to handle the !timedout case by
1074 * waiting longer if needed is a pain since dbus
1075 * wraps pthread_cond_timedwait to take a relative
1076 * time instead of absolute, something kind of stupid
1077 * on our part. for now it doesn't matter, we will just
1078 * end up back here eventually.)
1084 while (connection->io_path_acquired)
1086 _dbus_verbose ("waiting for IO path to be acquirable\n");
1087 _dbus_condvar_wait (connection->io_path_cond,
1088 connection->io_path_mutex);
1093 if (!connection->io_path_acquired)
1096 connection->io_path_acquired = TRUE;
1099 _dbus_verbose ("end connection->io_path_acquired = %d we_acquired = %d\n",
1100 connection->io_path_acquired, we_acquired);
1102 _dbus_verbose ("unlocking io_path_mutex\n");
1103 _dbus_mutex_unlock (connection->io_path_mutex);
1105 CONNECTION_LOCK (connection);
1107 HAVE_LOCK_CHECK (connection);
1109 _dbus_connection_unref_unlocked (connection);
1115 * Release the I/O path when you're done with it. Only call
1116 * after you've acquired the I/O. Wakes up at most one thread
1117 * currently waiting to acquire the I/O path.
1119 * @param connection the connection.
1122 _dbus_connection_release_io_path (DBusConnection *connection)
1124 HAVE_LOCK_CHECK (connection);
1126 _dbus_verbose ("locking io_path_mutex\n");
1127 _dbus_mutex_lock (connection->io_path_mutex);
1129 _dbus_assert (connection->io_path_acquired);
1131 _dbus_verbose ("start connection->io_path_acquired = %d\n",
1132 connection->io_path_acquired);
1134 connection->io_path_acquired = FALSE;
1135 _dbus_condvar_wake_one (connection->io_path_cond);
1137 _dbus_verbose ("unlocking io_path_mutex\n");
1138 _dbus_mutex_unlock (connection->io_path_mutex);
1142 * Queues incoming messages and sends outgoing messages for this
1143 * connection, optionally blocking in the process. Each call to
1144 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1145 * time and then read or write data if possible.
1147 * The purpose of this function is to be able to flush outgoing
1148 * messages or queue up incoming messages without returning
1149 * control to the application and causing reentrancy weirdness.
1151 * The flags parameter allows you to specify whether to
1152 * read incoming messages, write outgoing messages, or both,
1153 * and whether to block if no immediate action is possible.
1155 * The timeout_milliseconds parameter does nothing unless the
1156 * iteration is blocking.
1158 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1159 * wasn't specified, then it's impossible to block, even if
1160 * you specify DBUS_ITERATION_BLOCK; in that case the function
1161 * returns immediately.
1163 * If pending is not NULL then a check is made if the pending call
1164 * is completed after the io path has been required. If the call
1165 * has been completed nothing is done. This must be done since
1166 * the _dbus_connection_acquire_io_path releases the connection
1169 * Called with connection lock held.
1171 * @param connection the connection.
1172 * @param pending the pending call that should be checked or NULL
1173 * @param flags iteration flags.
1174 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1177 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1178 DBusPendingCall *pending,
1180 int timeout_milliseconds)
1182 _dbus_verbose ("start\n");
1184 HAVE_LOCK_CHECK (connection);
1186 if (connection->n_outgoing == 0)
1187 flags &= ~DBUS_ITERATION_DO_WRITING;
1189 if (_dbus_connection_acquire_io_path (connection,
1190 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1192 HAVE_LOCK_CHECK (connection);
1194 if ( (pending != NULL) && _dbus_pending_call_get_completed_unlocked(pending))
1196 _dbus_verbose ("pending call completed while acquiring I/O path");
1198 else if ( (pending != NULL) &&
1199 _dbus_connection_peek_for_reply_unlocked (connection,
1200 _dbus_pending_call_get_reply_serial_unlocked (pending)))
1202 _dbus_verbose ("pending call completed while acquiring I/O path (reply found in queue)");
1206 _dbus_transport_do_iteration (connection->transport,
1207 flags, timeout_milliseconds);
1210 _dbus_connection_release_io_path (connection);
1213 HAVE_LOCK_CHECK (connection);
1215 _dbus_verbose ("end\n");
1219 * Creates a new connection for the given transport. A transport
1220 * represents a message stream that uses some concrete mechanism, such
1221 * as UNIX domain sockets. May return #NULL if insufficient
1222 * memory exists to create the connection.
1224 * @param transport the transport.
1225 * @returns the new connection, or #NULL on failure.
1228 _dbus_connection_new_for_transport (DBusTransport *transport)
1230 DBusConnection *connection;
1231 DBusWatchList *watch_list;
1232 DBusTimeoutList *timeout_list;
1233 DBusHashTable *pending_replies;
1234 DBusList *disconnect_link;
1235 DBusMessage *disconnect_message;
1236 DBusCounter *outgoing_counter;
1237 DBusObjectTree *objects;
1241 pending_replies = NULL;
1242 timeout_list = NULL;
1243 disconnect_link = NULL;
1244 disconnect_message = NULL;
1245 outgoing_counter = NULL;
1248 watch_list = _dbus_watch_list_new ();
1249 if (watch_list == NULL)
1252 timeout_list = _dbus_timeout_list_new ();
1253 if (timeout_list == NULL)
1257 _dbus_hash_table_new (DBUS_HASH_INT,
1259 (DBusFreeFunction)free_pending_call_on_hash_removal);
1260 if (pending_replies == NULL)
1263 connection = dbus_new0 (DBusConnection, 1);
1264 if (connection == NULL)
1267 _dbus_mutex_new_at_location (&connection->mutex);
1268 if (connection->mutex == NULL)
1271 _dbus_mutex_new_at_location (&connection->io_path_mutex);
1272 if (connection->io_path_mutex == NULL)
1275 _dbus_mutex_new_at_location (&connection->dispatch_mutex);
1276 if (connection->dispatch_mutex == NULL)
1279 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1280 if (connection->dispatch_cond == NULL)
1283 _dbus_condvar_new_at_location (&connection->io_path_cond);
1284 if (connection->io_path_cond == NULL)
1287 _dbus_mutex_new_at_location (&connection->slot_mutex);
1288 if (connection->slot_mutex == NULL)
1291 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1292 DBUS_INTERFACE_LOCAL,
1295 if (disconnect_message == NULL)
1298 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1299 if (disconnect_link == NULL)
1302 outgoing_counter = _dbus_counter_new ();
1303 if (outgoing_counter == NULL)
1306 objects = _dbus_object_tree_new (connection);
1307 if (objects == NULL)
1310 if (_dbus_modify_sigpipe)
1311 _dbus_disable_sigpipe ();
1313 connection->refcount.value = 1;
1314 connection->transport = transport;
1315 connection->watches = watch_list;
1316 connection->timeouts = timeout_list;
1317 connection->pending_replies = pending_replies;
1318 connection->outgoing_counter = outgoing_counter;
1319 connection->filter_list = NULL;
1320 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1321 connection->objects = objects;
1322 connection->exit_on_disconnect = FALSE;
1323 connection->shareable = FALSE;
1324 connection->route_peer_messages = FALSE;
1325 connection->disconnected_message_arrived = FALSE;
1326 connection->disconnected_message_processed = FALSE;
1328 #ifndef DBUS_DISABLE_CHECKS
1329 connection->generation = _dbus_current_generation;
1332 _dbus_data_slot_list_init (&connection->slot_list);
1334 connection->client_serial = 1;
1336 connection->disconnect_message_link = disconnect_link;
1338 CONNECTION_LOCK (connection);
1340 if (!_dbus_transport_set_connection (transport, connection))
1342 CONNECTION_UNLOCK (connection);
1347 _dbus_transport_ref (transport);
1349 CONNECTION_UNLOCK (connection);
1354 if (disconnect_message != NULL)
1355 dbus_message_unref (disconnect_message);
1357 if (disconnect_link != NULL)
1358 _dbus_list_free_link (disconnect_link);
1360 if (connection != NULL)
1362 _dbus_condvar_free_at_location (&connection->io_path_cond);
1363 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1364 _dbus_mutex_free_at_location (&connection->mutex);
1365 _dbus_mutex_free_at_location (&connection->io_path_mutex);
1366 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
1367 _dbus_mutex_free_at_location (&connection->slot_mutex);
1368 dbus_free (connection);
1370 if (pending_replies)
1371 _dbus_hash_table_unref (pending_replies);
1374 _dbus_watch_list_free (watch_list);
1377 _dbus_timeout_list_free (timeout_list);
1379 if (outgoing_counter)
1380 _dbus_counter_unref (outgoing_counter);
1383 _dbus_object_tree_unref (objects);
1389 * Increments the reference count of a DBusConnection.
1390 * Requires that the caller already holds the connection lock.
1392 * @param connection the connection.
1393 * @returns the connection.
1396 _dbus_connection_ref_unlocked (DBusConnection *connection)
1398 _dbus_assert (connection != NULL);
1399 _dbus_assert (connection->generation == _dbus_current_generation);
1401 HAVE_LOCK_CHECK (connection);
1403 #ifdef DBUS_HAVE_ATOMIC_INT
1404 _dbus_atomic_inc (&connection->refcount);
1406 _dbus_assert (connection->refcount.value > 0);
1407 connection->refcount.value += 1;
1414 * Decrements the reference count of a DBusConnection.
1415 * Requires that the caller already holds the connection lock.
1417 * @param connection the connection.
1420 _dbus_connection_unref_unlocked (DBusConnection *connection)
1422 dbus_bool_t last_unref;
1424 HAVE_LOCK_CHECK (connection);
1426 _dbus_assert (connection != NULL);
1428 /* The connection lock is better than the global
1429 * lock in the atomic increment fallback
1432 #ifdef DBUS_HAVE_ATOMIC_INT
1433 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1435 _dbus_assert (connection->refcount.value > 0);
1437 connection->refcount.value -= 1;
1438 last_unref = (connection->refcount.value == 0);
1440 printf ("unref_unlocked() connection %p count = %d\n", connection, connection->refcount.value);
1445 _dbus_connection_last_unref (connection);
1448 static dbus_uint32_t
1449 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1451 dbus_uint32_t serial;
1453 serial = connection->client_serial++;
1455 if (connection->client_serial == 0)
1456 connection->client_serial = 1;
1462 * A callback for use with dbus_watch_new() to create a DBusWatch.
1464 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1465 * and the virtual handle_watch in DBusTransport if we got rid of it.
1466 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1469 * @param watch the watch.
1470 * @param condition the current condition of the file descriptors being watched.
1471 * @param data must be a pointer to a #DBusConnection
1472 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1475 _dbus_connection_handle_watch (DBusWatch *watch,
1476 unsigned int condition,
1479 DBusConnection *connection;
1481 DBusDispatchStatus status;
1485 _dbus_verbose ("start\n");
1487 CONNECTION_LOCK (connection);
1489 if (!_dbus_connection_acquire_io_path (connection, 1))
1491 /* another thread is handling the message */
1492 CONNECTION_UNLOCK (connection);
1496 HAVE_LOCK_CHECK (connection);
1497 retval = _dbus_transport_handle_watch (connection->transport,
1500 _dbus_connection_release_io_path (connection);
1502 HAVE_LOCK_CHECK (connection);
1504 _dbus_verbose ("middle\n");
1506 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1508 /* this calls out to user code */
1509 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1511 _dbus_verbose ("end\n");
1516 _DBUS_DEFINE_GLOBAL_LOCK (shared_connections);
1517 static DBusHashTable *shared_connections = NULL;
1518 static DBusList *shared_connections_no_guid = NULL;
1521 close_connection_on_shutdown (DBusConnection *connection)
1523 DBusMessage *message;
1525 dbus_connection_ref (connection);
1526 _dbus_connection_close_possibly_shared (connection);
1528 /* Churn through to the Disconnected message */
1529 while ((message = dbus_connection_pop_message (connection)))
1531 dbus_message_unref (message);
1533 dbus_connection_unref (connection);
1537 shared_connections_shutdown (void *data)
1541 _DBUS_LOCK (shared_connections);
1543 /* This is a little bit unpleasant... better ideas? */
1544 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1546 DBusConnection *connection;
1549 _dbus_hash_iter_init (shared_connections, &iter);
1550 _dbus_hash_iter_next (&iter);
1552 connection = _dbus_hash_iter_get_value (&iter);
1554 _DBUS_UNLOCK (shared_connections);
1555 close_connection_on_shutdown (connection);
1556 _DBUS_LOCK (shared_connections);
1558 /* The connection should now be dead and not in our hash ... */
1559 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1562 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1564 _dbus_hash_table_unref (shared_connections);
1565 shared_connections = NULL;
1567 if (shared_connections_no_guid != NULL)
1569 DBusConnection *connection;
1570 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1571 while (connection != NULL)
1573 _DBUS_UNLOCK (shared_connections);
1574 close_connection_on_shutdown (connection);
1575 _DBUS_LOCK (shared_connections);
1576 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1580 shared_connections_no_guid = NULL;
1582 _DBUS_UNLOCK (shared_connections);
1586 connection_lookup_shared (DBusAddressEntry *entry,
1587 DBusConnection **result)
1589 _dbus_verbose ("checking for existing connection\n");
1593 _DBUS_LOCK (shared_connections);
1595 if (shared_connections == NULL)
1597 _dbus_verbose ("creating shared_connections hash table\n");
1599 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1602 if (shared_connections == NULL)
1604 _DBUS_UNLOCK (shared_connections);
1608 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1610 _dbus_hash_table_unref (shared_connections);
1611 shared_connections = NULL;
1612 _DBUS_UNLOCK (shared_connections);
1616 _dbus_verbose (" successfully created shared_connections\n");
1618 _DBUS_UNLOCK (shared_connections);
1619 return TRUE; /* no point looking up in the hash we just made */
1625 guid = dbus_address_entry_get_value (entry, "guid");
1629 DBusConnection *connection;
1631 connection = _dbus_hash_table_lookup_string (shared_connections,
1636 /* The DBusConnection can't be finalized without taking
1637 * the shared_connections lock to remove it from the
1638 * hash. So it's safe to ref the connection here.
1639 * However, it may be disconnected if the Disconnected
1640 * message hasn't been processed yet, in which case we
1641 * want to pretend it isn't in the hash and avoid
1644 * The idea is to avoid ever returning a disconnected connection
1645 * from dbus_connection_open(). We could just synchronously
1646 * drop our shared ref to the connection on connection disconnect,
1647 * and then assert here that the connection is connected, but
1648 * that causes reentrancy headaches.
1650 CONNECTION_LOCK (connection);
1651 if (_dbus_connection_get_is_connected_unlocked (connection))
1653 _dbus_connection_ref_unlocked (connection);
1654 *result = connection;
1655 _dbus_verbose ("looked up existing connection to server guid %s\n",
1660 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1663 CONNECTION_UNLOCK (connection);
1667 _DBUS_UNLOCK (shared_connections);
1673 connection_record_shared_unlocked (DBusConnection *connection,
1677 char *guid_in_connection;
1679 HAVE_LOCK_CHECK (connection);
1680 _dbus_assert (connection->server_guid == NULL);
1681 _dbus_assert (connection->shareable);
1683 /* get a hard ref on this connection, even if
1684 * we won't in fact store it in the hash, we still
1685 * need to hold a ref on it until it's disconnected.
1687 _dbus_connection_ref_unlocked (connection);
1691 _DBUS_LOCK (shared_connections);
1693 if (!_dbus_list_prepend (&shared_connections_no_guid, connection))
1695 _DBUS_UNLOCK (shared_connections);
1699 _DBUS_UNLOCK (shared_connections);
1700 return TRUE; /* don't store in the hash */
1703 /* A separate copy of the key is required in the hash table, because
1704 * we don't have a lock on the connection when we are doing a hash
1708 guid_key = _dbus_strdup (guid);
1709 if (guid_key == NULL)
1712 guid_in_connection = _dbus_strdup (guid);
1713 if (guid_in_connection == NULL)
1715 dbus_free (guid_key);
1719 _DBUS_LOCK (shared_connections);
1720 _dbus_assert (shared_connections != NULL);
1722 if (!_dbus_hash_table_insert_string (shared_connections,
1723 guid_key, connection))
1725 dbus_free (guid_key);
1726 dbus_free (guid_in_connection);
1727 _DBUS_UNLOCK (shared_connections);
1731 connection->server_guid = guid_in_connection;
1733 _dbus_verbose ("stored connection to %s to be shared\n",
1734 connection->server_guid);
1736 _DBUS_UNLOCK (shared_connections);
1738 _dbus_assert (connection->server_guid != NULL);
1744 connection_forget_shared_unlocked (DBusConnection *connection)
1746 HAVE_LOCK_CHECK (connection);
1748 if (!connection->shareable)
1751 _DBUS_LOCK (shared_connections);
1753 if (connection->server_guid != NULL)
1755 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1756 connection->server_guid);
1758 if (!_dbus_hash_table_remove_string (shared_connections,
1759 connection->server_guid))
1760 _dbus_assert_not_reached ("connection was not in the shared table");
1762 dbus_free (connection->server_guid);
1763 connection->server_guid = NULL;
1767 _dbus_list_remove (&shared_connections_no_guid, connection);
1770 _DBUS_UNLOCK (shared_connections);
1772 /* remove our reference held on all shareable connections */
1773 _dbus_connection_unref_unlocked (connection);
1776 static DBusConnection*
1777 connection_try_from_address_entry (DBusAddressEntry *entry,
1780 DBusTransport *transport;
1781 DBusConnection *connection;
1783 transport = _dbus_transport_open (entry, error);
1785 if (transport == NULL)
1787 _DBUS_ASSERT_ERROR_IS_SET (error);
1791 connection = _dbus_connection_new_for_transport (transport);
1793 _dbus_transport_unref (transport);
1795 if (connection == NULL)
1797 _DBUS_SET_OOM (error);
1801 #ifndef DBUS_DISABLE_CHECKS
1802 _dbus_assert (!connection->have_connection_lock);
1808 * If the shared parameter is true, then any existing connection will
1809 * be used (and if a new connection is created, it will be available
1810 * for use by others). If the shared parameter is false, a new
1811 * connection will always be created, and the new connection will
1812 * never be returned to other callers.
1814 * @param address the address
1815 * @param shared whether the connection is shared or private
1816 * @param error error return
1817 * @returns the connection or #NULL on error
1819 static DBusConnection*
1820 _dbus_connection_open_internal (const char *address,
1824 DBusConnection *connection;
1825 DBusAddressEntry **entries;
1826 DBusError tmp_error = DBUS_ERROR_INIT;
1827 DBusError first_error = DBUS_ERROR_INIT;
1830 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1832 _dbus_verbose ("opening %s connection to: %s\n",
1833 shared ? "shared" : "private", address);
1835 if (!dbus_parse_address (address, &entries, &len, error))
1838 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1842 for (i = 0; i < len; i++)
1846 if (!connection_lookup_shared (entries[i], &connection))
1847 _DBUS_SET_OOM (&tmp_error);
1850 if (connection == NULL)
1852 connection = connection_try_from_address_entry (entries[i],
1855 if (connection != NULL && shared)
1859 connection->shareable = TRUE;
1861 /* guid may be NULL */
1862 guid = dbus_address_entry_get_value (entries[i], "guid");
1864 CONNECTION_LOCK (connection);
1866 if (!connection_record_shared_unlocked (connection, guid))
1868 _DBUS_SET_OOM (&tmp_error);
1869 _dbus_connection_close_possibly_shared_and_unlock (connection);
1870 dbus_connection_unref (connection);
1874 CONNECTION_UNLOCK (connection);
1881 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1884 dbus_move_error (&tmp_error, &first_error);
1886 dbus_error_free (&tmp_error);
1889 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1890 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1892 if (connection == NULL)
1894 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1895 dbus_move_error (&first_error, error);
1898 dbus_error_free (&first_error);
1900 dbus_address_entries_free (entries);
1905 * Closes a shared OR private connection, while dbus_connection_close() can
1906 * only be used on private connections. Should only be called by the
1907 * dbus code that owns the connection - an owner must be known,
1908 * the open/close state is like malloc/free, not like ref/unref.
1910 * @param connection the connection
1913 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1915 _dbus_assert (connection != NULL);
1916 _dbus_assert (connection->generation == _dbus_current_generation);
1918 CONNECTION_LOCK (connection);
1919 _dbus_connection_close_possibly_shared_and_unlock (connection);
1922 static DBusPreallocatedSend*
1923 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1925 DBusPreallocatedSend *preallocated;
1927 HAVE_LOCK_CHECK (connection);
1929 _dbus_assert (connection != NULL);
1931 preallocated = dbus_new (DBusPreallocatedSend, 1);
1932 if (preallocated == NULL)
1935 if (connection->link_cache != NULL)
1937 preallocated->queue_link =
1938 _dbus_list_pop_first_link (&connection->link_cache);
1939 preallocated->queue_link->data = NULL;
1943 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1944 if (preallocated->queue_link == NULL)
1948 if (connection->link_cache != NULL)
1950 preallocated->counter_link =
1951 _dbus_list_pop_first_link (&connection->link_cache);
1952 preallocated->counter_link->data = connection->outgoing_counter;
1956 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1957 if (preallocated->counter_link == NULL)
1961 _dbus_counter_ref (preallocated->counter_link->data);
1963 preallocated->connection = connection;
1965 return preallocated;
1968 _dbus_list_free_link (preallocated->queue_link);
1970 dbus_free (preallocated);
1975 /* Called with lock held, does not update dispatch status */
1977 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
1978 DBusPreallocatedSend *preallocated,
1979 DBusMessage *message,
1980 dbus_uint32_t *client_serial)
1982 dbus_uint32_t serial;
1984 preallocated->queue_link->data = message;
1985 _dbus_list_prepend_link (&connection->outgoing_messages,
1986 preallocated->queue_link);
1988 _dbus_message_add_counter_link (message,
1989 preallocated->counter_link);
1991 dbus_free (preallocated);
1992 preallocated = NULL;
1994 dbus_message_ref (message);
1996 connection->n_outgoing += 1;
1998 _dbus_verbose ("Message %p (%s %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
2000 dbus_message_type_to_string (dbus_message_get_type (message)),
2001 dbus_message_get_path (message) ?
2002 dbus_message_get_path (message) :
2004 dbus_message_get_interface (message) ?
2005 dbus_message_get_interface (message) :
2007 dbus_message_get_member (message) ?
2008 dbus_message_get_member (message) :
2010 dbus_message_get_signature (message),
2011 dbus_message_get_destination (message) ?
2012 dbus_message_get_destination (message) :
2015 connection->n_outgoing);
2017 if (dbus_message_get_serial (message) == 0)
2019 serial = _dbus_connection_get_next_client_serial (connection);
2020 dbus_message_set_serial (message, serial);
2022 *client_serial = serial;
2027 *client_serial = dbus_message_get_serial (message);
2030 _dbus_verbose ("Message %p serial is %u\n",
2031 message, dbus_message_get_serial (message));
2033 dbus_message_lock (message);
2035 /* Now we need to run an iteration to hopefully just write the messages
2036 * out immediately, and otherwise get them queued up
2038 _dbus_connection_do_iteration_unlocked (connection,
2040 DBUS_ITERATION_DO_WRITING,
2043 /* If stuff is still queued up, be sure we wake up the main loop */
2044 if (connection->n_outgoing > 0)
2045 _dbus_connection_wakeup_mainloop (connection);
2049 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2050 DBusPreallocatedSend *preallocated,
2051 DBusMessage *message,
2052 dbus_uint32_t *client_serial)
2054 DBusDispatchStatus status;
2056 HAVE_LOCK_CHECK (connection);
2058 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2060 message, client_serial);
2062 _dbus_verbose ("middle\n");
2063 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2065 /* this calls out to user code */
2066 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2070 * Like dbus_connection_send(), but assumes the connection
2071 * is already locked on function entry, and unlocks before returning.
2073 * @param connection the connection
2074 * @param message the message to send
2075 * @param client_serial return location for client serial of sent message
2076 * @returns #FALSE on out-of-memory
2079 _dbus_connection_send_and_unlock (DBusConnection *connection,
2080 DBusMessage *message,
2081 dbus_uint32_t *client_serial)
2083 DBusPreallocatedSend *preallocated;
2085 _dbus_assert (connection != NULL);
2086 _dbus_assert (message != NULL);
2088 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2089 if (preallocated == NULL)
2091 CONNECTION_UNLOCK (connection);
2095 _dbus_connection_send_preallocated_and_unlock (connection,
2103 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2104 * If the new connection function does not ref the connection, we want to close it.
2106 * A bit of a hack, probably the new connection function should have returned a value
2107 * for whether to close, or should have had to close the connection itself if it
2110 * But, this works OK as long as the new connection function doesn't do anything
2111 * crazy like keep the connection around without ref'ing it.
2113 * We have to lock the connection across refcount check and close in case
2114 * the new connection function spawns a thread that closes and unrefs.
2115 * In that case, if the app thread
2116 * closes and unrefs first, we'll harmlessly close again; if the app thread
2117 * still has the ref, we'll close and then the app will close harmlessly.
2118 * If the app unrefs without closing, the app is broken since if the
2119 * app refs from the new connection function it is supposed to also close.
2121 * If we didn't atomically check the refcount and close with the lock held
2122 * though, we could screw this up.
2124 * @param connection the connection
2127 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2129 CONNECTION_LOCK (connection);
2131 _dbus_assert (connection->refcount.value > 0);
2133 if (connection->refcount.value == 1)
2134 _dbus_connection_close_possibly_shared_and_unlock (connection);
2136 CONNECTION_UNLOCK (connection);
2141 * When a function that blocks has been called with a timeout, and we
2142 * run out of memory, the time to wait for memory is based on the
2143 * timeout. If the caller was willing to block a long time we wait a
2144 * relatively long time for memory, if they were only willing to block
2145 * briefly then we retry for memory at a rapid rate.
2147 * @timeout_milliseconds the timeout requested for blocking
2150 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2152 if (timeout_milliseconds == -1)
2153 _dbus_sleep_milliseconds (1000);
2154 else if (timeout_milliseconds < 100)
2155 ; /* just busy loop */
2156 else if (timeout_milliseconds <= 1000)
2157 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2159 _dbus_sleep_milliseconds (1000);
2162 static DBusMessage *
2163 generate_local_error_message (dbus_uint32_t serial,
2167 DBusMessage *message;
2168 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2172 if (!dbus_message_set_error_name (message, error_name))
2174 dbus_message_unref (message);
2179 dbus_message_set_no_reply (message, TRUE);
2181 if (!dbus_message_set_reply_serial (message,
2184 dbus_message_unref (message);
2189 if (error_msg != NULL)
2191 DBusMessageIter iter;
2193 dbus_message_iter_init_append (message, &iter);
2194 if (!dbus_message_iter_append_basic (&iter,
2198 dbus_message_unref (message);
2209 * Peek the incoming queue to see if we got reply for a specific serial
2212 _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
2213 dbus_uint32_t client_serial)
2216 HAVE_LOCK_CHECK (connection);
2218 link = _dbus_list_get_first_link (&connection->incoming_messages);
2220 while (link != NULL)
2222 DBusMessage *reply = link->data;
2224 if (dbus_message_get_reply_serial (reply) == client_serial)
2226 _dbus_verbose ("%s reply to %d found in queue\n", _DBUS_FUNCTION_NAME, client_serial);
2229 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2235 /* This is slightly strange since we can pop a message here without
2236 * the dispatch lock.
2239 check_for_reply_unlocked (DBusConnection *connection,
2240 dbus_uint32_t client_serial)
2244 HAVE_LOCK_CHECK (connection);
2246 link = _dbus_list_get_first_link (&connection->incoming_messages);
2248 while (link != NULL)
2250 DBusMessage *reply = link->data;
2252 if (dbus_message_get_reply_serial (reply) == client_serial)
2254 _dbus_list_remove_link (&connection->incoming_messages, link);
2255 connection->n_incoming -= 1;
2258 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2265 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2267 /* We can't iterate over the hash in the normal way since we'll be
2268 * dropping the lock for each item. So we restart the
2269 * iter each time as we drain the hash table.
2272 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2274 DBusPendingCall *pending;
2277 _dbus_hash_iter_init (connection->pending_replies, &iter);
2278 _dbus_hash_iter_next (&iter);
2280 pending = _dbus_hash_iter_get_value (&iter);
2281 _dbus_pending_call_ref_unlocked (pending);
2283 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2286 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
2287 _dbus_connection_remove_timeout_unlocked (connection,
2288 _dbus_pending_call_get_timeout_unlocked (pending));
2289 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2290 _dbus_hash_iter_remove_entry (&iter);
2292 _dbus_pending_call_unref_and_unlock (pending);
2293 CONNECTION_LOCK (connection);
2295 HAVE_LOCK_CHECK (connection);
2299 complete_pending_call_and_unlock (DBusConnection *connection,
2300 DBusPendingCall *pending,
2301 DBusMessage *message)
2303 _dbus_pending_call_set_reply_unlocked (pending, message);
2304 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2305 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2307 /* Must be called unlocked since it invokes app callback */
2308 _dbus_pending_call_complete (pending);
2309 dbus_pending_call_unref (pending);
2313 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2314 DBusPendingCall *pending)
2317 DBusDispatchStatus status;
2319 reply = check_for_reply_unlocked (connection,
2320 _dbus_pending_call_get_reply_serial_unlocked (pending));
2323 _dbus_verbose ("checked for reply\n");
2325 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2327 complete_pending_call_and_unlock (connection, pending, reply);
2328 dbus_message_unref (reply);
2330 CONNECTION_LOCK (connection);
2331 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2332 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2333 dbus_pending_call_unref (pending);
2342 * Blocks until a pending call times out or gets a reply.
2344 * Does not re-enter the main loop or run filter/path-registered
2345 * callbacks. The reply to the message will not be seen by
2348 * Returns immediately if pending call already got a reply.
2350 * @todo could use performance improvements (it keeps scanning
2351 * the whole message queue for example)
2353 * @param pending the pending call we block for a reply on
2356 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2358 long start_tv_sec, start_tv_usec;
2359 long tv_sec, tv_usec;
2360 DBusDispatchStatus status;
2361 DBusConnection *connection;
2362 dbus_uint32_t client_serial;
2363 DBusTimeout *timeout;
2364 int timeout_milliseconds, elapsed_milliseconds;
2366 _dbus_assert (pending != NULL);
2368 if (dbus_pending_call_get_completed (pending))
2371 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2373 connection = _dbus_pending_call_get_connection_and_lock (pending);
2375 /* Flush message queue - note, can affect dispatch status */
2376 _dbus_connection_flush_unlocked (connection);
2378 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2380 /* note that timeout_milliseconds is limited to a smallish value
2381 * in _dbus_pending_call_new() so overflows aren't possible
2384 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
2385 _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
2388 timeout_milliseconds = dbus_timeout_get_interval (timeout);
2390 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec\n",
2391 timeout_milliseconds,
2393 start_tv_sec, start_tv_usec);
2397 timeout_milliseconds = -1;
2399 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block for reply serial %u\n", client_serial);
2402 /* check to see if we already got the data off the socket */
2403 /* from another blocked pending call */
2404 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2407 /* Now we wait... */
2408 /* always block at least once as we know we don't have the reply yet */
2409 _dbus_connection_do_iteration_unlocked (connection,
2411 DBUS_ITERATION_DO_READING |
2412 DBUS_ITERATION_BLOCK,
2413 timeout_milliseconds);
2417 _dbus_verbose ("top of recheck\n");
2419 HAVE_LOCK_CHECK (connection);
2421 /* queue messages and get status */
2423 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2425 /* the get_completed() is in case a dispatch() while we were blocking
2426 * got the reply instead of us.
2428 if (_dbus_pending_call_get_completed_unlocked (pending))
2430 _dbus_verbose ("Pending call completed by dispatch\n");
2431 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2432 dbus_pending_call_unref (pending);
2436 if (status == DBUS_DISPATCH_DATA_REMAINS)
2438 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2442 _dbus_get_current_time (&tv_sec, &tv_usec);
2443 elapsed_milliseconds = (tv_sec - start_tv_sec) * 1000 +
2444 (tv_usec - start_tv_usec) / 1000;
2446 if (!_dbus_connection_get_is_connected_unlocked (connection))
2448 DBusMessage *error_msg;
2450 error_msg = generate_local_error_message (client_serial,
2451 DBUS_ERROR_DISCONNECTED,
2452 "Connection was disconnected before a reply was received");
2454 /* on OOM error_msg is set to NULL */
2455 complete_pending_call_and_unlock (connection, pending, error_msg);
2456 dbus_pending_call_unref (pending);
2459 else if (connection->disconnect_message_link == NULL)
2460 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2461 else if (timeout == NULL)
2463 if (status == DBUS_DISPATCH_NEED_MEMORY)
2465 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2466 * we may already have a reply in the buffer and just can't process
2469 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2471 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2475 /* block again, we don't have the reply buffered yet. */
2476 _dbus_connection_do_iteration_unlocked (connection,
2478 DBUS_ITERATION_DO_READING |
2479 DBUS_ITERATION_BLOCK,
2480 timeout_milliseconds - elapsed_milliseconds);
2483 goto recheck_status;
2485 else if (tv_sec < start_tv_sec)
2486 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2487 else if (elapsed_milliseconds < timeout_milliseconds)
2489 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds - elapsed_milliseconds);
2491 if (status == DBUS_DISPATCH_NEED_MEMORY)
2493 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2494 * we may already have a reply in the buffer and just can't process
2497 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2499 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2503 /* block again, we don't have the reply buffered yet. */
2504 _dbus_connection_do_iteration_unlocked (connection,
2506 DBUS_ITERATION_DO_READING |
2507 DBUS_ITERATION_BLOCK,
2508 timeout_milliseconds - elapsed_milliseconds);
2511 goto recheck_status;
2514 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %d milliseconds and got no reply\n",
2515 elapsed_milliseconds);
2517 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2519 /* unlock and call user code */
2520 complete_pending_call_and_unlock (connection, pending, NULL);
2522 /* update user code on dispatch status */
2523 CONNECTION_LOCK (connection);
2524 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2525 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2526 dbus_pending_call_unref (pending);
2532 * @addtogroup DBusConnection
2538 * Gets a connection to a remote address. If a connection to the given
2539 * address already exists, returns the existing connection with its
2540 * reference count incremented. Otherwise, returns a new connection
2541 * and saves the new connection for possible re-use if a future call
2542 * to dbus_connection_open() asks to connect to the same server.
2544 * Use dbus_connection_open_private() to get a dedicated connection
2545 * not shared with other callers of dbus_connection_open().
2547 * If the open fails, the function returns #NULL, and provides a
2548 * reason for the failure in the error parameter. Pass #NULL for the
2549 * error parameter if you aren't interested in the reason for
2552 * Because this connection is shared, no user of the connection
2553 * may call dbus_connection_close(). However, when you are done with the
2554 * connection you should call dbus_connection_unref().
2556 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2557 * unless you have good reason; connections are expensive enough
2558 * that it's wasteful to create lots of connections to the same
2561 * @param address the address.
2562 * @param error address where an error can be returned.
2563 * @returns new connection, or #NULL on failure.
2566 dbus_connection_open (const char *address,
2569 DBusConnection *connection;
2571 _dbus_return_val_if_fail (address != NULL, NULL);
2572 _dbus_return_val_if_error_is_set (error, NULL);
2574 connection = _dbus_connection_open_internal (address,
2582 * Opens a new, dedicated connection to a remote address. Unlike
2583 * dbus_connection_open(), always creates a new connection.
2584 * This connection will not be saved or recycled by libdbus.
2586 * If the open fails, the function returns #NULL, and provides a
2587 * reason for the failure in the error parameter. Pass #NULL for the
2588 * error parameter if you aren't interested in the reason for
2591 * When you are done with this connection, you must
2592 * dbus_connection_close() to disconnect it,
2593 * and dbus_connection_unref() to free the connection object.
2595 * (The dbus_connection_close() can be skipped if the
2596 * connection is already known to be disconnected, for example
2597 * if you are inside a handler for the Disconnected signal.)
2599 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2600 * unless you have good reason; connections are expensive enough
2601 * that it's wasteful to create lots of connections to the same
2604 * @param address the address.
2605 * @param error address where an error can be returned.
2606 * @returns new connection, or #NULL on failure.
2609 dbus_connection_open_private (const char *address,
2612 DBusConnection *connection;
2614 _dbus_return_val_if_fail (address != NULL, NULL);
2615 _dbus_return_val_if_error_is_set (error, NULL);
2617 connection = _dbus_connection_open_internal (address,
2625 * Increments the reference count of a DBusConnection.
2627 * @param connection the connection.
2628 * @returns the connection.
2631 dbus_connection_ref (DBusConnection *connection)
2633 _dbus_return_val_if_fail (connection != NULL, NULL);
2634 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2636 /* The connection lock is better than the global
2637 * lock in the atomic increment fallback
2639 * (FIXME but for now we always use the atomic version,
2640 * to avoid taking the connection lock, due to
2641 * the mess with set_timeout_functions()/set_watch_functions()
2642 * calling out to the app without dropping locks)
2646 _dbus_atomic_inc (&connection->refcount);
2648 CONNECTION_LOCK (connection);
2649 _dbus_assert (connection->refcount.value > 0);
2651 connection->refcount.value += 1;
2652 CONNECTION_UNLOCK (connection);
2659 free_outgoing_message (void *element,
2662 DBusMessage *message = element;
2663 DBusConnection *connection = data;
2665 _dbus_message_remove_counter (message,
2666 connection->outgoing_counter,
2668 dbus_message_unref (message);
2671 /* This is run without the mutex held, but after the last reference
2672 * to the connection has been dropped we should have no thread-related
2676 _dbus_connection_last_unref (DBusConnection *connection)
2680 _dbus_verbose ("Finalizing connection %p\n", connection);
2682 _dbus_assert (connection->refcount.value == 0);
2684 /* You have to disconnect the connection before unref:ing it. Otherwise
2685 * you won't get the disconnected message.
2687 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2688 _dbus_assert (connection->server_guid == NULL);
2690 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2691 _dbus_object_tree_free_all_unlocked (connection->objects);
2693 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2694 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2695 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2697 _dbus_watch_list_free (connection->watches);
2698 connection->watches = NULL;
2700 _dbus_timeout_list_free (connection->timeouts);
2701 connection->timeouts = NULL;
2703 _dbus_data_slot_list_free (&connection->slot_list);
2705 link = _dbus_list_get_first_link (&connection->filter_list);
2706 while (link != NULL)
2708 DBusMessageFilter *filter = link->data;
2709 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2711 filter->function = NULL;
2712 _dbus_message_filter_unref (filter); /* calls app callback */
2717 _dbus_list_clear (&connection->filter_list);
2719 /* ---- Done with stuff that invokes application callbacks */
2721 _dbus_object_tree_unref (connection->objects);
2723 _dbus_hash_table_unref (connection->pending_replies);
2724 connection->pending_replies = NULL;
2726 _dbus_list_clear (&connection->filter_list);
2728 _dbus_list_foreach (&connection->outgoing_messages,
2729 free_outgoing_message,
2731 _dbus_list_clear (&connection->outgoing_messages);
2733 _dbus_list_foreach (&connection->incoming_messages,
2734 (DBusForeachFunction) dbus_message_unref,
2736 _dbus_list_clear (&connection->incoming_messages);
2738 _dbus_counter_unref (connection->outgoing_counter);
2740 _dbus_transport_unref (connection->transport);
2742 if (connection->disconnect_message_link)
2744 DBusMessage *message = connection->disconnect_message_link->data;
2745 dbus_message_unref (message);
2746 _dbus_list_free_link (connection->disconnect_message_link);
2749 _dbus_list_clear (&connection->link_cache);
2751 _dbus_condvar_free_at_location (&connection->dispatch_cond);
2752 _dbus_condvar_free_at_location (&connection->io_path_cond);
2754 _dbus_mutex_free_at_location (&connection->io_path_mutex);
2755 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
2757 _dbus_mutex_free_at_location (&connection->slot_mutex);
2759 _dbus_mutex_free_at_location (&connection->mutex);
2761 dbus_free (connection);
2765 * Decrements the reference count of a DBusConnection, and finalizes
2766 * it if the count reaches zero.
2768 * Note: it is a bug to drop the last reference to a connection that
2769 * is still connected.
2771 * For shared connections, libdbus will own a reference
2772 * as long as the connection is connected, so you can know that either
2773 * you don't have the last reference, or it's OK to drop the last reference.
2774 * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2775 * return shared connections.
2777 * For private connections, the creator of the connection must arrange for
2778 * dbus_connection_close() to be called prior to dropping the last reference.
2779 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2781 * @param connection the connection.
2784 dbus_connection_unref (DBusConnection *connection)
2786 dbus_bool_t last_unref;
2788 _dbus_return_if_fail (connection != NULL);
2789 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2791 /* The connection lock is better than the global
2792 * lock in the atomic increment fallback
2794 * (FIXME but for now we always use the atomic version,
2795 * to avoid taking the connection lock, due to
2796 * the mess with set_timeout_functions()/set_watch_functions()
2797 * calling out to the app without dropping locks)
2801 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
2803 CONNECTION_LOCK (connection);
2805 _dbus_assert (connection->refcount.value > 0);
2807 connection->refcount.value -= 1;
2808 last_unref = (connection->refcount.value == 0);
2811 printf ("unref() connection %p count = %d\n", connection, connection->refcount.value);
2814 CONNECTION_UNLOCK (connection);
2819 #ifndef DBUS_DISABLE_CHECKS
2820 if (_dbus_transport_get_is_connected (connection->transport))
2822 _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",
2823 connection->shareable ?
2824 "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2825 "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2829 _dbus_connection_last_unref (connection);
2834 * Note that the transport can disconnect itself (other end drops us)
2835 * and in that case this function never runs. So this function must
2836 * not do anything more than disconnect the transport and update the
2839 * If the transport self-disconnects, then we assume someone will
2840 * dispatch the connection to cause the dispatch status update.
2843 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2845 DBusDispatchStatus status;
2847 HAVE_LOCK_CHECK (connection);
2849 _dbus_verbose ("Disconnecting %p\n", connection);
2851 /* We need to ref because update_dispatch_status_and_unlock will unref
2852 * the connection if it was shared and libdbus was the only remaining
2855 _dbus_connection_ref_unlocked (connection);
2857 _dbus_transport_disconnect (connection->transport);
2859 /* This has the side effect of queuing the disconnect message link
2860 * (unless we don't have enough memory, possibly, so don't assert it).
2861 * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2862 * should never again return the newly-disconnected connection.
2864 * However, we only unref the shared connection and exit_on_disconnect when
2865 * the disconnect message reaches the head of the message queue,
2866 * NOT when it's first queued.
2868 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2870 /* This calls out to user code */
2871 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2873 /* Could also call out to user code */
2874 dbus_connection_unref (connection);
2878 * Closes a private connection, so no further data can be sent or received.
2879 * This disconnects the transport (such as a socket) underlying the
2882 * Attempts to send messages after closing a connection are safe, but will result in
2883 * error replies generated locally in libdbus.
2885 * This function does not affect the connection's reference count. It's
2886 * safe to close a connection more than once; all calls after the
2887 * first do nothing. It's impossible to "reopen" a connection, a
2888 * new connection must be created. This function may result in a call
2889 * to the DBusDispatchStatusFunction set with
2890 * dbus_connection_set_dispatch_status_function(), as the disconnect
2891 * message it generates needs to be dispatched.
2893 * If a connection is dropped by the remote application, it will
2896 * You must close a connection prior to releasing the last reference to
2897 * the connection. If you dbus_connection_unref() for the last time
2898 * without closing the connection, the results are undefined; it
2899 * is a bug in your program and libdbus will try to print a warning.
2901 * You may not close a shared connection. Connections created with
2902 * dbus_connection_open() or dbus_bus_get() are shared.
2903 * These connections are owned by libdbus, and applications should
2904 * only unref them, never close them. Applications can know it is
2905 * safe to unref these connections because libdbus will be holding a
2906 * reference as long as the connection is open. Thus, either the
2907 * connection is closed and it is OK to drop the last reference,
2908 * or the connection is open and the app knows it does not have the
2911 * Connections created with dbus_connection_open_private() or
2912 * dbus_bus_get_private() are not kept track of or referenced by
2913 * libdbus. The creator of these connections is responsible for
2914 * calling dbus_connection_close() prior to releasing the last
2915 * reference, if the connection is not already disconnected.
2917 * @param connection the private (unshared) connection to close
2920 dbus_connection_close (DBusConnection *connection)
2922 _dbus_return_if_fail (connection != NULL);
2923 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2925 CONNECTION_LOCK (connection);
2927 #ifndef DBUS_DISABLE_CHECKS
2928 if (connection->shareable)
2930 CONNECTION_UNLOCK (connection);
2932 _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2937 _dbus_connection_close_possibly_shared_and_unlock (connection);
2941 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2943 HAVE_LOCK_CHECK (connection);
2944 return _dbus_transport_get_is_connected (connection->transport);
2948 * Gets whether the connection is currently open. A connection may
2949 * become disconnected when the remote application closes its end, or
2950 * exits; a connection may also be disconnected with
2951 * dbus_connection_close().
2953 * There are not separate states for "closed" and "disconnected," the two
2954 * terms are synonymous. This function should really be called
2955 * get_is_open() but for historical reasons is not.
2957 * @param connection the connection.
2958 * @returns #TRUE if the connection is still alive.
2961 dbus_connection_get_is_connected (DBusConnection *connection)
2965 _dbus_return_val_if_fail (connection != NULL, FALSE);
2967 CONNECTION_LOCK (connection);
2968 res = _dbus_connection_get_is_connected_unlocked (connection);
2969 CONNECTION_UNLOCK (connection);
2975 * Gets whether the connection was authenticated. (Note that
2976 * if the connection was authenticated then disconnected,
2977 * this function still returns #TRUE)
2979 * @param connection the connection
2980 * @returns #TRUE if the connection was ever authenticated
2983 dbus_connection_get_is_authenticated (DBusConnection *connection)
2987 _dbus_return_val_if_fail (connection != NULL, FALSE);
2989 CONNECTION_LOCK (connection);
2990 res = _dbus_transport_get_is_authenticated (connection->transport);
2991 CONNECTION_UNLOCK (connection);
2997 * Gets whether the connection is not authenticated as a specific
2998 * user. If the connection is not authenticated, this function
2999 * returns #TRUE, and if it is authenticated but as an anonymous user,
3000 * it returns #TRUE. If it is authenticated as a specific user, then
3001 * this returns #FALSE. (Note that if the connection was authenticated
3002 * as anonymous then disconnected, this function still returns #TRUE.)
3004 * If the connection is not anonymous, you can use
3005 * dbus_connection_get_unix_user() and
3006 * dbus_connection_get_windows_user() to see who it's authorized as.
3008 * If you want to prevent non-anonymous authorization, use
3009 * dbus_server_set_auth_mechanisms() to remove the mechanisms that
3010 * allow proving user identity (i.e. only allow the ANONYMOUS
3013 * @param connection the connection
3014 * @returns #TRUE if not authenticated or authenticated as anonymous
3017 dbus_connection_get_is_anonymous (DBusConnection *connection)
3021 _dbus_return_val_if_fail (connection != NULL, FALSE);
3023 CONNECTION_LOCK (connection);
3024 res = _dbus_transport_get_is_anonymous (connection->transport);
3025 CONNECTION_UNLOCK (connection);
3031 * Gets the ID of the server address we are authenticated to, if this
3032 * connection is on the client side. If the connection is on the
3033 * server side, this will always return #NULL - use dbus_server_get_id()
3034 * to get the ID of your own server, if you are the server side.
3036 * If a client-side connection is not authenticated yet, the ID may be
3037 * available if it was included in the server address, but may not be
3038 * available. The only way to be sure the server ID is available
3039 * is to wait for authentication to complete.
3041 * In general, each mode of connecting to a given server will have
3042 * its own ID. So for example, if the session bus daemon is listening
3043 * on UNIX domain sockets and on TCP, then each of those modalities
3044 * will have its own server ID.
3046 * If you want an ID that identifies an entire session bus, look at
3047 * dbus_bus_get_id() instead (which is just a convenience wrapper
3048 * around the org.freedesktop.DBus.GetId method invoked on the bus).
3050 * You can also get a machine ID; see dbus_get_local_machine_id() to
3051 * get the machine you are on. There isn't a convenience wrapper, but
3052 * you can invoke org.freedesktop.DBus.Peer.GetMachineId on any peer
3053 * to get the machine ID on the other end.
3055 * The D-Bus specification describes the server ID and other IDs in a
3058 * @param connection the connection
3059 * @returns the server ID or #NULL if no memory or the connection is server-side
3062 dbus_connection_get_server_id (DBusConnection *connection)
3066 _dbus_return_val_if_fail (connection != NULL, NULL);
3068 CONNECTION_LOCK (connection);
3069 id = _dbus_strdup (_dbus_transport_get_server_id (connection->transport));
3070 CONNECTION_UNLOCK (connection);
3076 * Tests whether a certain type can be send via the connection. This
3077 * will always return TRUE for all types, with the exception of
3078 * DBUS_TYPE_UNIX_FD. The function will return TRUE for
3079 * DBUS_TYPE_UNIX_FD only on systems that know Unix file descriptors
3080 * and can send them via the chosen transport and when the remote side
3083 * This function can be used to do runtime checking for types that
3084 * might be unknown to the specific D-Bus client implementation
3085 * version, i.e. it will return FALSE for all types this
3086 * implementation does not know.
3088 * @param connection the connection
3089 * @param type the type to check
3090 * @returns TRUE if the type may be send via the connection
3093 dbus_connection_can_send_type(DBusConnection *connection,
3096 _dbus_return_val_if_fail (connection != NULL, FALSE);
3098 if (!_dbus_type_is_valid(type))
3101 if (type != DBUS_TYPE_UNIX_FD)
3104 #ifdef HAVE_UNIX_FD_PASSING
3108 CONNECTION_LOCK(connection);
3109 b = _dbus_transport_can_pass_unix_fd(connection->transport);
3110 CONNECTION_UNLOCK(connection);
3120 * Set whether _exit() should be called when the connection receives a
3121 * disconnect signal. The call to _exit() comes after any handlers for
3122 * the disconnect signal run; handlers can cancel the exit by calling
3125 * By default, exit_on_disconnect is #FALSE; but for message bus
3126 * connections returned from dbus_bus_get() it will be toggled on
3129 * @param connection the connection
3130 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
3133 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
3134 dbus_bool_t exit_on_disconnect)
3136 _dbus_return_if_fail (connection != NULL);
3138 CONNECTION_LOCK (connection);
3139 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
3140 CONNECTION_UNLOCK (connection);
3144 * Preallocates resources needed to send a message, allowing the message
3145 * to be sent without the possibility of memory allocation failure.
3146 * Allows apps to create a future guarantee that they can send
3147 * a message regardless of memory shortages.
3149 * @param connection the connection we're preallocating for.
3150 * @returns the preallocated resources, or #NULL
3152 DBusPreallocatedSend*
3153 dbus_connection_preallocate_send (DBusConnection *connection)
3155 DBusPreallocatedSend *preallocated;
3157 _dbus_return_val_if_fail (connection != NULL, NULL);
3159 CONNECTION_LOCK (connection);
3162 _dbus_connection_preallocate_send_unlocked (connection);
3164 CONNECTION_UNLOCK (connection);
3166 return preallocated;
3170 * Frees preallocated message-sending resources from
3171 * dbus_connection_preallocate_send(). Should only
3172 * be called if the preallocated resources are not used
3173 * to send a message.
3175 * @param connection the connection
3176 * @param preallocated the resources
3179 dbus_connection_free_preallocated_send (DBusConnection *connection,
3180 DBusPreallocatedSend *preallocated)
3182 _dbus_return_if_fail (connection != NULL);
3183 _dbus_return_if_fail (preallocated != NULL);
3184 _dbus_return_if_fail (connection == preallocated->connection);
3186 _dbus_list_free_link (preallocated->queue_link);
3187 _dbus_counter_unref (preallocated->counter_link->data);
3188 _dbus_list_free_link (preallocated->counter_link);
3189 dbus_free (preallocated);
3193 * Sends a message using preallocated resources. This function cannot fail.
3194 * It works identically to dbus_connection_send() in other respects.
3195 * Preallocated resources comes from dbus_connection_preallocate_send().
3196 * This function "consumes" the preallocated resources, they need not
3197 * be freed separately.
3199 * @param connection the connection
3200 * @param preallocated the preallocated resources
3201 * @param message the message to send
3202 * @param client_serial return location for client serial assigned to the message
3205 dbus_connection_send_preallocated (DBusConnection *connection,
3206 DBusPreallocatedSend *preallocated,
3207 DBusMessage *message,
3208 dbus_uint32_t *client_serial)
3210 _dbus_return_if_fail (connection != NULL);
3211 _dbus_return_if_fail (preallocated != NULL);
3212 _dbus_return_if_fail (message != NULL);
3213 _dbus_return_if_fail (preallocated->connection == connection);
3214 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3215 dbus_message_get_member (message) != NULL);
3216 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
3217 (dbus_message_get_interface (message) != NULL &&
3218 dbus_message_get_member (message) != NULL));
3220 CONNECTION_LOCK (connection);
3222 #ifdef HAVE_UNIX_FD_PASSING
3224 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3225 message->n_unix_fds > 0)
3227 /* Refuse to send fds on a connection that cannot handle
3228 them. Unfortunately we cannot return a proper error here, so
3229 the best we can is just return. */
3230 CONNECTION_UNLOCK (connection);
3236 _dbus_connection_send_preallocated_and_unlock (connection,
3238 message, client_serial);
3242 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
3243 DBusMessage *message,
3244 dbus_uint32_t *client_serial)
3246 DBusPreallocatedSend *preallocated;
3248 _dbus_assert (connection != NULL);
3249 _dbus_assert (message != NULL);
3251 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
3252 if (preallocated == NULL)
3255 _dbus_connection_send_preallocated_unlocked_no_update (connection,
3263 * Adds a message to the outgoing message queue. Does not block to
3264 * write the message to the network; that happens asynchronously. To
3265 * force the message to be written, call dbus_connection_flush() however
3266 * it is not necessary to call dbus_connection_flush() by hand; the
3267 * message will be sent the next time the main loop is run.
3268 * dbus_connection_flush() should only be used, for example, if
3269 * the application was expected to exit before running the main loop.
3271 * Because this only queues the message, the only reason it can
3272 * fail is lack of memory. Even if the connection is disconnected,
3273 * no error will be returned. If the function fails due to lack of memory,
3274 * it returns #FALSE. The function will never fail for other reasons; even
3275 * if the connection is disconnected, you can queue an outgoing message,
3276 * though obviously it won't be sent.
3278 * The message serial is used by the remote application to send a
3279 * reply; see dbus_message_get_serial() or the D-Bus specification.
3281 * dbus_message_unref() can be called as soon as this method returns
3282 * as the message queue will hold its own ref until the message is sent.
3284 * @param connection the connection.
3285 * @param message the message to write.
3286 * @param serial return location for message serial, or #NULL if you don't care
3287 * @returns #TRUE on success.
3290 dbus_connection_send (DBusConnection *connection,
3291 DBusMessage *message,
3292 dbus_uint32_t *serial)
3294 _dbus_return_val_if_fail (connection != NULL, FALSE);
3295 _dbus_return_val_if_fail (message != NULL, FALSE);
3297 CONNECTION_LOCK (connection);
3299 #ifdef HAVE_UNIX_FD_PASSING
3301 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3302 message->n_unix_fds > 0)
3304 /* Refuse to send fds on a connection that cannot handle
3305 them. Unfortunately we cannot return a proper error here, so
3306 the best we can is just return. */
3307 CONNECTION_UNLOCK (connection);
3313 return _dbus_connection_send_and_unlock (connection,
3319 reply_handler_timeout (void *data)
3321 DBusConnection *connection;
3322 DBusDispatchStatus status;
3323 DBusPendingCall *pending = data;
3325 connection = _dbus_pending_call_get_connection_and_lock (pending);
3327 _dbus_pending_call_queue_timeout_error_unlocked (pending,
3329 _dbus_connection_remove_timeout_unlocked (connection,
3330 _dbus_pending_call_get_timeout_unlocked (pending));
3331 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
3333 _dbus_verbose ("middle\n");
3334 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3336 /* Unlocks, and calls out to user code */
3337 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3343 * Queues a message to send, as with dbus_connection_send(),
3344 * but also returns a #DBusPendingCall used to receive a reply to the
3345 * message. If no reply is received in the given timeout_milliseconds,
3346 * this function expires the pending reply and generates a synthetic
3347 * error reply (generated in-process, not by the remote application)
3348 * indicating that a timeout occurred.
3350 * A #DBusPendingCall will see a reply message before any filters or
3351 * registered object path handlers. See dbus_connection_dispatch() for
3352 * details on when handlers are run.
3354 * A #DBusPendingCall will always see exactly one reply message,
3355 * unless it's cancelled with dbus_pending_call_cancel().
3357 * If #NULL is passed for the pending_return, the #DBusPendingCall
3358 * will still be generated internally, and used to track
3359 * the message reply timeout. This means a timeout error will
3360 * occur if no reply arrives, unlike with dbus_connection_send().
3362 * If -1 is passed for the timeout, a sane default timeout is used. -1
3363 * is typically the best value for the timeout for this reason, unless
3364 * you want a very short or very long timeout. If INT_MAX is passed for
3365 * the timeout, no timeout will be set and the call will block forever.
3367 * @warning if the connection is disconnected or you try to send Unix
3368 * file descriptors on a connection that does not support them, the
3369 * #DBusPendingCall will be set to #NULL, so be careful with this.
3371 * @param connection the connection
3372 * @param message the message to send
3373 * @param pending_return return location for a #DBusPendingCall
3374 * object, or #NULL if connection is disconnected or when you try to
3375 * send Unix file descriptors on a connection that does not support
3377 * @param timeout_milliseconds timeout in milliseconds, -1 for default or INT_MAX for no timeout
3378 * @returns #FALSE if no memory, #TRUE otherwise.
3382 dbus_connection_send_with_reply (DBusConnection *connection,
3383 DBusMessage *message,
3384 DBusPendingCall **pending_return,
3385 int timeout_milliseconds)
3387 DBusPendingCall *pending;
3388 dbus_int32_t serial = -1;
3389 DBusDispatchStatus status;
3391 _dbus_return_val_if_fail (connection != NULL, FALSE);
3392 _dbus_return_val_if_fail (message != NULL, FALSE);
3393 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3396 *pending_return = NULL;
3398 CONNECTION_LOCK (connection);
3400 #ifdef HAVE_UNIX_FD_PASSING
3402 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3403 message->n_unix_fds > 0)
3405 /* Refuse to send fds on a connection that cannot handle
3406 them. Unfortunately we cannot return a proper error here, so
3407 the best we can do is return TRUE but leave *pending_return
3409 CONNECTION_UNLOCK (connection);
3415 if (!_dbus_connection_get_is_connected_unlocked (connection))
3417 CONNECTION_UNLOCK (connection);
3422 pending = _dbus_pending_call_new_unlocked (connection,
3423 timeout_milliseconds,
3424 reply_handler_timeout);
3426 if (pending == NULL)
3428 CONNECTION_UNLOCK (connection);
3432 /* Assign a serial to the message */
3433 serial = dbus_message_get_serial (message);
3436 serial = _dbus_connection_get_next_client_serial (connection);
3437 dbus_message_set_serial (message, serial);
3440 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3443 /* Insert the serial in the pending replies hash;
3444 * hash takes a refcount on DBusPendingCall.
3445 * Also, add the timeout.
3447 if (!_dbus_connection_attach_pending_call_unlocked (connection,
3451 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3453 _dbus_connection_detach_pending_call_and_unlock (connection,
3455 goto error_unlocked;
3459 *pending_return = pending; /* hand off refcount */
3462 _dbus_connection_detach_pending_call_unlocked (connection, pending);
3463 /* we still have a ref to the pending call in this case, we unref
3464 * after unlocking, below
3468 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3470 /* this calls out to user code */
3471 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3473 if (pending_return == NULL)
3474 dbus_pending_call_unref (pending);
3479 CONNECTION_UNLOCK (connection);
3481 dbus_pending_call_unref (pending);
3486 * Sends a message and blocks a certain time period while waiting for
3487 * a reply. This function does not reenter the main loop,
3488 * i.e. messages other than the reply are queued up but not
3489 * processed. This function is used to invoke method calls on a
3492 * If a normal reply is received, it is returned, and removed from the
3493 * incoming message queue. If it is not received, #NULL is returned
3494 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3495 * received, it is converted to a #DBusError and returned as an error,
3496 * then the reply message is deleted and #NULL is returned. If
3497 * something else goes wrong, result is set to whatever is
3498 * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3499 * #DBUS_ERROR_DISCONNECTED.
3501 * @warning While this function blocks the calling thread will not be
3502 * processing the incoming message queue. This means you can end up
3503 * deadlocked if the application you're talking to needs you to reply
3504 * to a method. To solve this, either avoid the situation, block in a
3505 * separate thread from the main connection-dispatching thread, or use
3506 * dbus_pending_call_set_notify() to avoid blocking.
3508 * @param connection the connection
3509 * @param message the message to send
3510 * @param timeout_milliseconds timeout in milliseconds, -1 for default or INT_MAX for no timeout.
3511 * @param error return location for error message
3512 * @returns the message that is the reply or #NULL with an error code if the
3516 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3517 DBusMessage *message,
3518 int timeout_milliseconds,
3522 DBusPendingCall *pending;
3524 _dbus_return_val_if_fail (connection != NULL, NULL);
3525 _dbus_return_val_if_fail (message != NULL, NULL);
3526 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3527 _dbus_return_val_if_error_is_set (error, NULL);
3529 #ifdef HAVE_UNIX_FD_PASSING
3531 CONNECTION_LOCK (connection);
3532 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3533 message->n_unix_fds > 0)
3535 CONNECTION_UNLOCK (connection);
3536 dbus_set_error(error, DBUS_ERROR_FAILED, "Cannot send file descriptors on this connection.");
3539 CONNECTION_UNLOCK (connection);
3543 if (!dbus_connection_send_with_reply (connection, message,
3544 &pending, timeout_milliseconds))
3546 _DBUS_SET_OOM (error);
3550 if (pending == NULL)
3552 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3556 dbus_pending_call_block (pending);
3558 reply = dbus_pending_call_steal_reply (pending);
3559 dbus_pending_call_unref (pending);
3561 /* call_complete_and_unlock() called from pending_call_block() should
3562 * always fill this in.
3564 _dbus_assert (reply != NULL);
3566 if (dbus_set_error_from_message (error, reply))
3568 dbus_message_unref (reply);
3576 * Blocks until the outgoing message queue is empty.
3577 * Assumes connection lock already held.
3579 * If you call this, you MUST call update_dispatch_status afterword...
3581 * @param connection the connection.
3583 static DBusDispatchStatus
3584 _dbus_connection_flush_unlocked (DBusConnection *connection)
3586 /* We have to specify DBUS_ITERATION_DO_READING here because
3587 * otherwise we could have two apps deadlock if they are both doing
3588 * a flush(), and the kernel buffers fill up. This could change the
3591 DBusDispatchStatus status;
3593 HAVE_LOCK_CHECK (connection);
3595 while (connection->n_outgoing > 0 &&
3596 _dbus_connection_get_is_connected_unlocked (connection))
3598 _dbus_verbose ("doing iteration in\n");
3599 HAVE_LOCK_CHECK (connection);
3600 _dbus_connection_do_iteration_unlocked (connection,
3602 DBUS_ITERATION_DO_READING |
3603 DBUS_ITERATION_DO_WRITING |
3604 DBUS_ITERATION_BLOCK,
3608 HAVE_LOCK_CHECK (connection);
3609 _dbus_verbose ("middle\n");
3610 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3612 HAVE_LOCK_CHECK (connection);
3617 * Blocks until the outgoing message queue is empty.
3619 * @param connection the connection.
3622 dbus_connection_flush (DBusConnection *connection)
3624 /* We have to specify DBUS_ITERATION_DO_READING here because
3625 * otherwise we could have two apps deadlock if they are both doing
3626 * a flush(), and the kernel buffers fill up. This could change the
3629 DBusDispatchStatus status;
3631 _dbus_return_if_fail (connection != NULL);
3633 CONNECTION_LOCK (connection);
3635 status = _dbus_connection_flush_unlocked (connection);
3637 HAVE_LOCK_CHECK (connection);
3638 /* Unlocks and calls out to user code */
3639 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3641 _dbus_verbose ("end\n");
3645 * This function implements dbus_connection_read_write_dispatch() and
3646 * dbus_connection_read_write() (they pass a different value for the
3647 * dispatch parameter).
3649 * @param connection the connection
3650 * @param timeout_milliseconds max time to block or -1 for infinite
3651 * @param dispatch dispatch new messages or leave them on the incoming queue
3652 * @returns #TRUE if the disconnect message has not been processed
3655 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3656 int timeout_milliseconds,
3657 dbus_bool_t dispatch)
3659 DBusDispatchStatus dstatus;
3660 dbus_bool_t progress_possible;
3662 /* Need to grab a ref here in case we're a private connection and
3663 * the user drops the last ref in a handler we call; see bug
3664 * https://bugs.freedesktop.org/show_bug.cgi?id=15635
3666 dbus_connection_ref (connection);
3667 dstatus = dbus_connection_get_dispatch_status (connection);
3669 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3671 _dbus_verbose ("doing dispatch\n");
3672 dbus_connection_dispatch (connection);
3673 CONNECTION_LOCK (connection);
3675 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3677 _dbus_verbose ("pausing for memory\n");
3678 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3679 CONNECTION_LOCK (connection);
3683 CONNECTION_LOCK (connection);
3684 if (_dbus_connection_get_is_connected_unlocked (connection))
3686 _dbus_verbose ("doing iteration\n");
3687 _dbus_connection_do_iteration_unlocked (connection,
3689 DBUS_ITERATION_DO_READING |
3690 DBUS_ITERATION_DO_WRITING |
3691 DBUS_ITERATION_BLOCK,
3692 timeout_milliseconds);
3696 HAVE_LOCK_CHECK (connection);
3697 /* If we can dispatch, we can make progress until the Disconnected message
3698 * has been processed; if we can only read/write, we can make progress
3699 * as long as the transport is open.
3702 progress_possible = connection->n_incoming != 0 ||
3703 connection->disconnect_message_link != NULL;
3705 progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3707 CONNECTION_UNLOCK (connection);
3709 dbus_connection_unref (connection);
3711 return progress_possible; /* TRUE if we can make more progress */
3716 * This function is intended for use with applications that don't want
3717 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3718 * example usage would be:
3721 * while (dbus_connection_read_write_dispatch (connection, -1))
3722 * ; // empty loop body
3725 * In this usage you would normally have set up a filter function to look
3726 * at each message as it is dispatched. The loop terminates when the last
3727 * message from the connection (the disconnected signal) is processed.
3729 * If there are messages to dispatch, this function will
3730 * dbus_connection_dispatch() once, and return. If there are no
3731 * messages to dispatch, this function will block until it can read or
3732 * write, then read or write, then return.
3734 * The way to think of this function is that it either makes some sort
3735 * of progress, or it blocks. Note that, while it is blocked on I/O, it
3736 * cannot be interrupted (even by other threads), which makes this function
3737 * unsuitable for applications that do more than just react to received
3740 * The return value indicates whether the disconnect message has been
3741 * processed, NOT whether the connection is connected. This is
3742 * important because even after disconnecting, you want to process any
3743 * messages you received prior to the disconnect.
3745 * @param connection the connection
3746 * @param timeout_milliseconds max time to block or -1 for infinite
3747 * @returns #TRUE if the disconnect message has not been processed
3750 dbus_connection_read_write_dispatch (DBusConnection *connection,
3751 int timeout_milliseconds)
3753 _dbus_return_val_if_fail (connection != NULL, FALSE);
3754 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3755 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3759 * This function is intended for use with applications that don't want to
3760 * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3761 * dbus_connection_read_write_dispatch().
3763 * As long as the connection is open, this function will block until it can
3764 * read or write, then read or write, then return #TRUE.
3766 * If the connection is closed, the function returns #FALSE.
3768 * The return value indicates whether reading or writing is still
3769 * possible, i.e. whether the connection is connected.
3771 * Note that even after disconnection, messages may remain in the
3772 * incoming queue that need to be
3773 * processed. dbus_connection_read_write_dispatch() dispatches
3774 * incoming messages for you; with dbus_connection_read_write() you
3775 * have to arrange to drain the incoming queue yourself.
3777 * @param connection the connection
3778 * @param timeout_milliseconds max time to block or -1 for infinite
3779 * @returns #TRUE if still connected
3782 dbus_connection_read_write (DBusConnection *connection,
3783 int timeout_milliseconds)
3785 _dbus_return_val_if_fail (connection != NULL, FALSE);
3786 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3787 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3790 /* We need to call this anytime we pop the head of the queue, and then
3791 * update_dispatch_status_and_unlock needs to be called afterward
3792 * which will "process" the disconnected message and set
3793 * disconnected_message_processed.
3796 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3797 DBusMessage *head_of_queue)
3799 HAVE_LOCK_CHECK (connection);
3801 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3802 if (connection->disconnect_message_link == NULL &&
3803 dbus_message_is_signal (head_of_queue,
3804 DBUS_INTERFACE_LOCAL,
3807 connection->disconnected_message_arrived = TRUE;
3812 * Returns the first-received message from the incoming message queue,
3813 * leaving it in the queue. If the queue is empty, returns #NULL.
3815 * The caller does not own a reference to the returned message, and
3816 * must either return it using dbus_connection_return_message() or
3817 * keep it after calling dbus_connection_steal_borrowed_message(). No
3818 * one can get at the message while its borrowed, so return it as
3819 * quickly as possible and don't keep a reference to it after
3820 * returning it. If you need to keep the message, make a copy of it.
3822 * dbus_connection_dispatch() will block if called while a borrowed
3823 * message is outstanding; only one piece of code can be playing with
3824 * the incoming queue at a time. This function will block if called
3825 * during a dbus_connection_dispatch().
3827 * @param connection the connection.
3828 * @returns next message in the incoming queue.
3831 dbus_connection_borrow_message (DBusConnection *connection)
3833 DBusDispatchStatus status;
3834 DBusMessage *message;
3836 _dbus_return_val_if_fail (connection != NULL, NULL);
3838 _dbus_verbose ("start\n");
3840 /* this is called for the side effect that it queues
3841 * up any messages from the transport
3843 status = dbus_connection_get_dispatch_status (connection);
3844 if (status != DBUS_DISPATCH_DATA_REMAINS)
3847 CONNECTION_LOCK (connection);
3849 _dbus_connection_acquire_dispatch (connection);
3851 /* While a message is outstanding, the dispatch lock is held */
3852 _dbus_assert (connection->message_borrowed == NULL);
3854 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3856 message = connection->message_borrowed;
3858 check_disconnected_message_arrived_unlocked (connection, message);
3860 /* Note that we KEEP the dispatch lock until the message is returned */
3861 if (message == NULL)
3862 _dbus_connection_release_dispatch (connection);
3864 CONNECTION_UNLOCK (connection);
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);
3903 * Used to keep a message after peeking at it using
3904 * dbus_connection_borrow_message(). Before using this function, see
3905 * the caveats/warnings in the documentation for
3906 * dbus_connection_pop_message().
3908 * @param connection the connection
3909 * @param message the message from dbus_connection_borrow_message()
3912 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3913 DBusMessage *message)
3915 DBusMessage *pop_message;
3916 DBusDispatchStatus status;
3918 _dbus_return_if_fail (connection != NULL);
3919 _dbus_return_if_fail (message != NULL);
3920 _dbus_return_if_fail (message == connection->message_borrowed);
3921 _dbus_return_if_fail (connection->dispatch_acquired);
3923 CONNECTION_LOCK (connection);
3925 _dbus_assert (message == connection->message_borrowed);
3927 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3928 _dbus_assert (message == pop_message);
3930 connection->n_incoming -= 1;
3932 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3933 message, connection->n_incoming);
3935 connection->message_borrowed = NULL;
3937 _dbus_connection_release_dispatch (connection);
3939 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3940 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3943 /* See dbus_connection_pop_message, but requires the caller to own
3944 * the lock before calling. May drop the lock while running.
3947 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3949 HAVE_LOCK_CHECK (connection);
3951 _dbus_assert (connection->message_borrowed == NULL);
3953 if (connection->n_incoming > 0)
3957 link = _dbus_list_pop_first_link (&connection->incoming_messages);
3958 connection->n_incoming -= 1;
3960 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from incoming queue %p, %d incoming\n",
3962 dbus_message_type_to_string (dbus_message_get_type (link->data)),
3963 dbus_message_get_path (link->data) ?
3964 dbus_message_get_path (link->data) :
3966 dbus_message_get_interface (link->data) ?
3967 dbus_message_get_interface (link->data) :
3969 dbus_message_get_member (link->data) ?
3970 dbus_message_get_member (link->data) :
3972 dbus_message_get_signature (link->data),
3973 connection, connection->n_incoming);
3975 check_disconnected_message_arrived_unlocked (connection, link->data);
3983 /* See dbus_connection_pop_message, but requires the caller to own
3984 * the lock before calling. May drop the lock while running.
3987 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3991 HAVE_LOCK_CHECK (connection);
3993 link = _dbus_connection_pop_message_link_unlocked (connection);
3997 DBusMessage *message;
3999 message = link->data;
4001 _dbus_list_free_link (link);
4010 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
4011 DBusList *message_link)
4013 HAVE_LOCK_CHECK (connection);
4015 _dbus_assert (message_link != NULL);
4016 /* You can't borrow a message while a link is outstanding */
4017 _dbus_assert (connection->message_borrowed == NULL);
4018 /* We had to have the dispatch lock across the pop/putback */
4019 _dbus_assert (connection->dispatch_acquired);
4021 _dbus_list_prepend_link (&connection->incoming_messages,
4023 connection->n_incoming += 1;
4025 _dbus_verbose ("Message %p (%s %s %s '%s') put back into queue %p, %d incoming\n",
4027 dbus_message_type_to_string (dbus_message_get_type (message_link->data)),
4028 dbus_message_get_interface (message_link->data) ?
4029 dbus_message_get_interface (message_link->data) :
4031 dbus_message_get_member (message_link->data) ?
4032 dbus_message_get_member (message_link->data) :
4034 dbus_message_get_signature (message_link->data),
4035 connection, connection->n_incoming);
4039 * Returns the first-received message from the incoming message queue,
4040 * removing it from the queue. The caller owns a reference to the
4041 * returned message. If the queue is empty, returns #NULL.
4043 * This function bypasses any message handlers that are registered,
4044 * and so using it is usually wrong. Instead, let the main loop invoke
4045 * dbus_connection_dispatch(). Popping messages manually is only
4046 * useful in very simple programs that don't share a #DBusConnection
4047 * with any libraries or other modules.
4049 * There is a lock that covers all ways of accessing the incoming message
4050 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
4051 * dbus_connection_borrow_message(), etc. will all block while one of the others
4052 * in the group is running.
4054 * @param connection the connection.
4055 * @returns next message in the incoming queue.
4058 dbus_connection_pop_message (DBusConnection *connection)
4060 DBusMessage *message;
4061 DBusDispatchStatus status;
4063 _dbus_verbose ("start\n");
4065 /* this is called for the side effect that it queues
4066 * up any messages from the transport
4068 status = dbus_connection_get_dispatch_status (connection);
4069 if (status != DBUS_DISPATCH_DATA_REMAINS)
4072 CONNECTION_LOCK (connection);
4073 _dbus_connection_acquire_dispatch (connection);
4074 HAVE_LOCK_CHECK (connection);
4076 message = _dbus_connection_pop_message_unlocked (connection);
4078 _dbus_verbose ("Returning popped message %p\n", message);
4080 _dbus_connection_release_dispatch (connection);
4082 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4083 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4089 * Acquire the dispatcher. This is a separate lock so the main
4090 * connection lock can be dropped to call out to application dispatch
4093 * @param connection the connection.
4096 _dbus_connection_acquire_dispatch (DBusConnection *connection)
4098 HAVE_LOCK_CHECK (connection);
4100 _dbus_connection_ref_unlocked (connection);
4101 CONNECTION_UNLOCK (connection);
4103 _dbus_verbose ("locking dispatch_mutex\n");
4104 _dbus_mutex_lock (connection->dispatch_mutex);
4106 while (connection->dispatch_acquired)
4108 _dbus_verbose ("waiting for dispatch to be acquirable\n");
4109 _dbus_condvar_wait (connection->dispatch_cond,
4110 connection->dispatch_mutex);
4113 _dbus_assert (!connection->dispatch_acquired);
4115 connection->dispatch_acquired = TRUE;
4117 _dbus_verbose ("unlocking dispatch_mutex\n");
4118 _dbus_mutex_unlock (connection->dispatch_mutex);
4120 CONNECTION_LOCK (connection);
4121 _dbus_connection_unref_unlocked (connection);
4125 * Release the dispatcher when you're done with it. Only call
4126 * after you've acquired the dispatcher. Wakes up at most one
4127 * thread currently waiting to acquire the dispatcher.
4129 * @param connection the connection.
4132 _dbus_connection_release_dispatch (DBusConnection *connection)
4134 HAVE_LOCK_CHECK (connection);
4136 _dbus_verbose ("locking dispatch_mutex\n");
4137 _dbus_mutex_lock (connection->dispatch_mutex);
4139 _dbus_assert (connection->dispatch_acquired);
4141 connection->dispatch_acquired = FALSE;
4142 _dbus_condvar_wake_one (connection->dispatch_cond);
4144 _dbus_verbose ("unlocking dispatch_mutex\n");
4145 _dbus_mutex_unlock (connection->dispatch_mutex);
4149 _dbus_connection_failed_pop (DBusConnection *connection,
4150 DBusList *message_link)
4152 _dbus_list_prepend_link (&connection->incoming_messages,
4154 connection->n_incoming += 1;
4157 /* Note this may be called multiple times since we don't track whether we already did it */
4159 notify_disconnected_unlocked (DBusConnection *connection)
4161 HAVE_LOCK_CHECK (connection);
4163 /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
4164 * connection from dbus_bus_get(). We make the same guarantee for
4165 * dbus_connection_open() but in a different way since we don't want to
4166 * unref right here; we instead check for connectedness before returning
4167 * the connection from the hash.
4169 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
4171 /* Dump the outgoing queue, we aren't going to be able to
4172 * send it now, and we'd like accessors like
4173 * dbus_connection_get_outgoing_size() to be accurate.
4175 if (connection->n_outgoing > 0)
4179 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
4180 connection->n_outgoing);
4182 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
4184 _dbus_connection_message_sent (connection, link->data);
4189 /* Note this may be called multiple times since we don't track whether we already did it */
4190 static DBusDispatchStatus
4191 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
4193 HAVE_LOCK_CHECK (connection);
4195 if (connection->disconnect_message_link != NULL)
4197 _dbus_verbose ("Sending disconnect message\n");
4199 /* If we have pending calls, queue their timeouts - we want the Disconnected
4200 * to be the last message, after these timeouts.
4202 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
4204 /* We haven't sent the disconnect message already,
4205 * and all real messages have been queued up.
4207 _dbus_connection_queue_synthesized_message_link (connection,
4208 connection->disconnect_message_link);
4209 connection->disconnect_message_link = NULL;
4211 return DBUS_DISPATCH_DATA_REMAINS;
4214 return DBUS_DISPATCH_COMPLETE;
4217 static DBusDispatchStatus
4218 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
4220 HAVE_LOCK_CHECK (connection);
4222 if (connection->n_incoming > 0)
4223 return DBUS_DISPATCH_DATA_REMAINS;
4224 else if (!_dbus_transport_queue_messages (connection->transport))
4225 return DBUS_DISPATCH_NEED_MEMORY;
4228 DBusDispatchStatus status;
4229 dbus_bool_t is_connected;
4231 status = _dbus_transport_get_dispatch_status (connection->transport);
4232 is_connected = _dbus_transport_get_is_connected (connection->transport);
4234 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
4235 DISPATCH_STATUS_NAME (status), is_connected);
4239 /* It's possible this would be better done by having an explicit
4240 * notification from _dbus_transport_disconnect() that would
4241 * synchronously do this, instead of waiting for the next dispatch
4242 * status check. However, probably not good to change until it causes
4245 notify_disconnected_unlocked (connection);
4247 /* I'm not sure this is needed; the idea is that we want to
4248 * queue the Disconnected only after we've read all the
4249 * messages, but if we're disconnected maybe we are guaranteed
4250 * to have read them all ?
4252 if (status == DBUS_DISPATCH_COMPLETE)
4253 status = notify_disconnected_and_dispatch_complete_unlocked (connection);
4256 if (status != DBUS_DISPATCH_COMPLETE)
4258 else if (connection->n_incoming > 0)
4259 return DBUS_DISPATCH_DATA_REMAINS;
4261 return DBUS_DISPATCH_COMPLETE;
4266 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
4267 DBusDispatchStatus new_status)
4269 dbus_bool_t changed;
4270 DBusDispatchStatusFunction function;
4273 HAVE_LOCK_CHECK (connection);
4275 _dbus_connection_ref_unlocked (connection);
4277 changed = new_status != connection->last_dispatch_status;
4279 connection->last_dispatch_status = new_status;
4281 function = connection->dispatch_status_function;
4282 data = connection->dispatch_status_data;
4284 if (connection->disconnected_message_arrived &&
4285 !connection->disconnected_message_processed)
4287 connection->disconnected_message_processed = TRUE;
4289 /* this does an unref, but we have a ref
4290 * so we should not run the finalizer here
4293 connection_forget_shared_unlocked (connection);
4295 if (connection->exit_on_disconnect)
4297 CONNECTION_UNLOCK (connection);
4299 _dbus_verbose ("Exiting on Disconnected signal\n");
4301 _dbus_assert_not_reached ("Call to exit() returned");
4305 /* We drop the lock */
4306 CONNECTION_UNLOCK (connection);
4308 if (changed && function)
4310 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
4311 connection, new_status,
4312 DISPATCH_STATUS_NAME (new_status));
4313 (* function) (connection, new_status, data);
4316 dbus_connection_unref (connection);
4320 * Gets the current state of the incoming message queue.
4321 * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
4322 * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
4323 * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
4324 * there could be data, but we can't know for sure without more
4327 * To process the incoming message queue, use dbus_connection_dispatch()
4328 * or (in rare cases) dbus_connection_pop_message().
4330 * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
4331 * have messages in the queue, or we have raw bytes buffered up
4332 * that need to be parsed. When these bytes are parsed, they
4333 * may not add up to an entire message. Thus, it's possible
4334 * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
4335 * have a message yet.
4337 * In particular this happens on initial connection, because all sorts
4338 * of authentication protocol stuff has to be parsed before the
4339 * first message arrives.
4341 * @param connection the connection.
4342 * @returns current dispatch status
4345 dbus_connection_get_dispatch_status (DBusConnection *connection)
4347 DBusDispatchStatus status;
4349 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4351 _dbus_verbose ("start\n");
4353 CONNECTION_LOCK (connection);
4355 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4357 CONNECTION_UNLOCK (connection);
4363 * Filter funtion for handling the Peer standard interface.
4365 static DBusHandlerResult
4366 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
4367 DBusMessage *message)
4369 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
4371 /* This means we're letting the bus route this message */
4372 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4374 else if (dbus_message_is_method_call (message,
4375 DBUS_INTERFACE_PEER,
4381 ret = dbus_message_new_method_return (message);
4383 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4385 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4387 dbus_message_unref (ret);
4390 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4392 return DBUS_HANDLER_RESULT_HANDLED;
4394 else if (dbus_message_is_method_call (message,
4395 DBUS_INTERFACE_PEER,
4402 ret = dbus_message_new_method_return (message);
4404 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4407 _dbus_string_init (&uuid);
4408 if (_dbus_get_local_machine_uuid_encoded (&uuid))
4410 const char *v_STRING = _dbus_string_get_const_data (&uuid);
4411 if (dbus_message_append_args (ret,
4412 DBUS_TYPE_STRING, &v_STRING,
4415 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4418 _dbus_string_free (&uuid);
4420 dbus_message_unref (ret);
4423 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4425 return DBUS_HANDLER_RESULT_HANDLED;
4427 else if (dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4429 /* We need to bounce anything else with this interface, otherwise apps
4430 * could start extending the interface and when we added extensions
4431 * here to DBusConnection we'd break those apps.
4437 ret = dbus_message_new_error (message,
4438 DBUS_ERROR_UNKNOWN_METHOD,
4439 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4441 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4443 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4445 dbus_message_unref (ret);
4448 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4450 return DBUS_HANDLER_RESULT_HANDLED;
4454 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4459 * Processes all builtin filter functions
4461 * If the spec specifies a standard interface
4462 * they should be processed from this method
4464 static DBusHandlerResult
4465 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4466 DBusMessage *message)
4468 /* We just run one filter for now but have the option to run more
4469 if the spec calls for it in the future */
4471 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4475 * Processes any incoming data.
4477 * If there's incoming raw data that has not yet been parsed, it is
4478 * parsed, which may or may not result in adding messages to the
4481 * The incoming data buffer is filled when the connection reads from
4482 * its underlying transport (such as a socket). Reading usually
4483 * happens in dbus_watch_handle() or dbus_connection_read_write().
4485 * If there are complete messages in the incoming queue,
4486 * dbus_connection_dispatch() removes one message from the queue and
4487 * processes it. Processing has three steps.
4489 * First, any method replies are passed to #DBusPendingCall or
4490 * dbus_connection_send_with_reply_and_block() in order to
4491 * complete the pending method call.
4493 * Second, any filters registered with dbus_connection_add_filter()
4494 * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4495 * then processing stops after that filter.
4497 * Third, if the message is a method call it is forwarded to
4498 * any registered object path handlers added with
4499 * dbus_connection_register_object_path() or
4500 * dbus_connection_register_fallback().
4502 * A single call to dbus_connection_dispatch() will process at most
4503 * one message; it will not clear the entire message queue.
4505 * Be careful about calling dbus_connection_dispatch() from inside a
4506 * message handler, i.e. calling dbus_connection_dispatch()
4507 * recursively. If threads have been initialized with a recursive
4508 * mutex function, then this will not deadlock; however, it can
4509 * certainly confuse your application.
4511 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4513 * @param connection the connection
4514 * @returns dispatch status, see dbus_connection_get_dispatch_status()
4517 dbus_connection_dispatch (DBusConnection *connection)
4519 DBusMessage *message;
4520 DBusList *link, *filter_list_copy, *message_link;
4521 DBusHandlerResult result;
4522 DBusPendingCall *pending;
4523 dbus_int32_t reply_serial;
4524 DBusDispatchStatus status;
4526 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4528 _dbus_verbose ("\n");
4530 CONNECTION_LOCK (connection);
4531 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4532 if (status != DBUS_DISPATCH_DATA_REMAINS)
4534 /* unlocks and calls out to user code */
4535 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4539 /* We need to ref the connection since the callback could potentially
4540 * drop the last ref to it
4542 _dbus_connection_ref_unlocked (connection);
4544 _dbus_connection_acquire_dispatch (connection);
4545 HAVE_LOCK_CHECK (connection);
4547 message_link = _dbus_connection_pop_message_link_unlocked (connection);
4548 if (message_link == NULL)
4550 /* another thread dispatched our stuff */
4552 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4554 _dbus_connection_release_dispatch (connection);
4556 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4558 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4560 dbus_connection_unref (connection);
4565 message = message_link->data;
4567 _dbus_verbose (" dispatching message %p (%s %s %s '%s')\n",
4569 dbus_message_type_to_string (dbus_message_get_type (message)),
4570 dbus_message_get_interface (message) ?
4571 dbus_message_get_interface (message) :
4573 dbus_message_get_member (message) ?
4574 dbus_message_get_member (message) :
4576 dbus_message_get_signature (message));
4578 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4580 /* Pending call handling must be first, because if you do
4581 * dbus_connection_send_with_reply_and_block() or
4582 * dbus_pending_call_block() then no handlers/filters will be run on
4583 * the reply. We want consistent semantics in the case where we
4584 * dbus_connection_dispatch() the reply.
4587 reply_serial = dbus_message_get_reply_serial (message);
4588 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4592 _dbus_verbose ("Dispatching a pending reply\n");
4593 complete_pending_call_and_unlock (connection, pending, message);
4594 pending = NULL; /* it's probably unref'd */
4596 CONNECTION_LOCK (connection);
4597 _dbus_verbose ("pending call completed in dispatch\n");
4598 result = DBUS_HANDLER_RESULT_HANDLED;
4602 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4603 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4606 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4608 _dbus_connection_release_dispatch (connection);
4609 HAVE_LOCK_CHECK (connection);
4611 _dbus_connection_failed_pop (connection, message_link);
4613 /* unlocks and calls user code */
4614 _dbus_connection_update_dispatch_status_and_unlock (connection,
4615 DBUS_DISPATCH_NEED_MEMORY);
4618 dbus_pending_call_unref (pending);
4619 dbus_connection_unref (connection);
4621 return DBUS_DISPATCH_NEED_MEMORY;
4624 _dbus_list_foreach (&filter_list_copy,
4625 (DBusForeachFunction)_dbus_message_filter_ref,
4628 /* We're still protected from dispatch() reentrancy here
4629 * since we acquired the dispatcher
4631 CONNECTION_UNLOCK (connection);
4633 link = _dbus_list_get_first_link (&filter_list_copy);
4634 while (link != NULL)
4636 DBusMessageFilter *filter = link->data;
4637 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4639 if (filter->function == NULL)
4641 _dbus_verbose (" filter was removed in a callback function\n");
4646 _dbus_verbose (" running filter on message %p\n", message);
4647 result = (* filter->function) (connection, message, filter->user_data);
4649 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4655 _dbus_list_foreach (&filter_list_copy,
4656 (DBusForeachFunction)_dbus_message_filter_unref,
4658 _dbus_list_clear (&filter_list_copy);
4660 CONNECTION_LOCK (connection);
4662 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4664 _dbus_verbose ("No memory\n");
4667 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4669 _dbus_verbose ("filter handled message in dispatch\n");
4673 /* We're still protected from dispatch() reentrancy here
4674 * since we acquired the dispatcher
4676 _dbus_verbose (" running object path dispatch on message %p (%s %s %s '%s')\n",
4678 dbus_message_type_to_string (dbus_message_get_type (message)),
4679 dbus_message_get_interface (message) ?
4680 dbus_message_get_interface (message) :
4682 dbus_message_get_member (message) ?
4683 dbus_message_get_member (message) :
4685 dbus_message_get_signature (message));
4687 HAVE_LOCK_CHECK (connection);
4688 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4691 CONNECTION_LOCK (connection);
4693 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4695 _dbus_verbose ("object tree handled message in dispatch\n");
4699 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4703 DBusPreallocatedSend *preallocated;
4705 _dbus_verbose (" sending error %s\n",
4706 DBUS_ERROR_UNKNOWN_METHOD);
4708 if (!_dbus_string_init (&str))
4710 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4711 _dbus_verbose ("no memory for error string in dispatch\n");
4715 if (!_dbus_string_append_printf (&str,
4716 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4717 dbus_message_get_member (message),
4718 dbus_message_get_signature (message),
4719 dbus_message_get_interface (message)))
4721 _dbus_string_free (&str);
4722 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4723 _dbus_verbose ("no memory for error string in dispatch\n");
4727 reply = dbus_message_new_error (message,
4728 DBUS_ERROR_UNKNOWN_METHOD,
4729 _dbus_string_get_const_data (&str));
4730 _dbus_string_free (&str);
4734 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4735 _dbus_verbose ("no memory for error reply in dispatch\n");
4739 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4741 if (preallocated == NULL)
4743 dbus_message_unref (reply);
4744 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4745 _dbus_verbose ("no memory for error send in dispatch\n");
4749 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4752 dbus_message_unref (reply);
4754 result = DBUS_HANDLER_RESULT_HANDLED;
4757 _dbus_verbose (" done dispatching %p (%s %s %s '%s') on connection %p\n", message,
4758 dbus_message_type_to_string (dbus_message_get_type (message)),
4759 dbus_message_get_interface (message) ?
4760 dbus_message_get_interface (message) :
4762 dbus_message_get_member (message) ?
4763 dbus_message_get_member (message) :
4765 dbus_message_get_signature (message),
4769 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4771 _dbus_verbose ("out of memory\n");
4773 /* Put message back, and we'll start over.
4774 * Yes this means handlers must be idempotent if they
4775 * don't return HANDLED; c'est la vie.
4777 _dbus_connection_putback_message_link_unlocked (connection,
4782 _dbus_verbose (" ... done dispatching\n");
4784 _dbus_list_free_link (message_link);
4785 dbus_message_unref (message); /* don't want the message to count in max message limits
4786 * in computing dispatch status below
4790 _dbus_connection_release_dispatch (connection);
4791 HAVE_LOCK_CHECK (connection);
4793 _dbus_verbose ("before final status update\n");
4794 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4796 /* unlocks and calls user code */
4797 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4799 dbus_connection_unref (connection);
4805 * Sets the watch functions for the connection. These functions are
4806 * responsible for making the application's main loop aware of file
4807 * descriptors that need to be monitored for events, using select() or
4808 * poll(). When using Qt, typically the DBusAddWatchFunction would
4809 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4810 * could call g_io_add_watch(), or could be used as part of a more
4811 * elaborate GSource. Note that when a watch is added, it may
4814 * The DBusWatchToggledFunction notifies the application that the
4815 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4816 * to check this. A disabled watch should have no effect, and enabled
4817 * watch should be added to the main loop. This feature is used
4818 * instead of simply adding/removing the watch because
4819 * enabling/disabling can be done without memory allocation. The
4820 * toggled function may be NULL if a main loop re-queries
4821 * dbus_watch_get_enabled() every time anyway.
4823 * The DBusWatch can be queried for the file descriptor to watch using
4824 * dbus_watch_get_unix_fd() or dbus_watch_get_socket(), and for the
4825 * events to watch for using dbus_watch_get_flags(). The flags
4826 * returned by dbus_watch_get_flags() will only contain
4827 * DBUS_WATCH_READABLE and DBUS_WATCH_WRITABLE, never
4828 * DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR; all watches implicitly
4829 * include a watch for hangups, errors, and other exceptional
4832 * Once a file descriptor becomes readable or writable, or an exception
4833 * occurs, dbus_watch_handle() should be called to
4834 * notify the connection of the file descriptor's condition.
4836 * dbus_watch_handle() cannot be called during the
4837 * DBusAddWatchFunction, as the connection will not be ready to handle
4840 * It is not allowed to reference a DBusWatch after it has been passed
4841 * to remove_function.
4843 * If #FALSE is returned due to lack of memory, the failure may be due
4844 * to a #FALSE return from the new add_function. If so, the
4845 * add_function may have been called successfully one or more times,
4846 * but the remove_function will also have been called to remove any
4847 * successful adds. i.e. if #FALSE is returned the net result
4848 * should be that dbus_connection_set_watch_functions() has no effect,
4849 * but the add_function and remove_function may have been called.
4851 * @note The thread lock on DBusConnection is held while
4852 * watch functions are invoked, so inside these functions you
4853 * may not invoke any methods on DBusConnection or it will deadlock.
4854 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/tread.html#8144
4855 * if you encounter this issue and want to attempt writing a patch.
4857 * @param connection the connection.
4858 * @param add_function function to begin monitoring a new descriptor.
4859 * @param remove_function function to stop monitoring a descriptor.
4860 * @param toggled_function function to notify of enable/disable
4861 * @param data data to pass to add_function and remove_function.
4862 * @param free_data_function function to be called to free the data.
4863 * @returns #FALSE on failure (no memory)
4866 dbus_connection_set_watch_functions (DBusConnection *connection,
4867 DBusAddWatchFunction add_function,
4868 DBusRemoveWatchFunction remove_function,
4869 DBusWatchToggledFunction toggled_function,
4871 DBusFreeFunction free_data_function)
4875 _dbus_return_val_if_fail (connection != NULL, FALSE);
4877 CONNECTION_LOCK (connection);
4879 retval = _dbus_watch_list_set_functions (connection->watches,
4880 add_function, remove_function,
4882 data, free_data_function);
4884 CONNECTION_UNLOCK (connection);
4890 * Sets the timeout functions for the connection. These functions are
4891 * responsible for making the application's main loop aware of timeouts.
4892 * When using Qt, typically the DBusAddTimeoutFunction would create a
4893 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4896 * The DBusTimeoutToggledFunction notifies the application that the
4897 * timeout has been enabled or disabled. Call
4898 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4899 * have no effect, and enabled timeout should be added to the main
4900 * loop. This feature is used instead of simply adding/removing the
4901 * timeout because enabling/disabling can be done without memory
4902 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4903 * to enable and disable. The toggled function may be NULL if a main
4904 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4905 * Whenever a timeout is toggled, its interval may change.
4907 * The DBusTimeout can be queried for the timer interval using
4908 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4909 * repeatedly, each time the interval elapses, starting after it has
4910 * elapsed once. The timeout stops firing when it is removed with the
4911 * given remove_function. The timer interval may change whenever the
4912 * timeout is added, removed, or toggled.
4914 * @note The thread lock on DBusConnection is held while
4915 * timeout functions are invoked, so inside these functions you
4916 * may not invoke any methods on DBusConnection or it will deadlock.
4917 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
4918 * if you encounter this issue and want to attempt writing a patch.
4920 * @param connection the connection.
4921 * @param add_function function to add a timeout.
4922 * @param remove_function function to remove a timeout.
4923 * @param toggled_function function to notify of enable/disable
4924 * @param data data to pass to add_function and remove_function.
4925 * @param free_data_function function to be called to free the data.
4926 * @returns #FALSE on failure (no memory)
4929 dbus_connection_set_timeout_functions (DBusConnection *connection,
4930 DBusAddTimeoutFunction add_function,
4931 DBusRemoveTimeoutFunction remove_function,
4932 DBusTimeoutToggledFunction toggled_function,
4934 DBusFreeFunction free_data_function)
4938 _dbus_return_val_if_fail (connection != NULL, FALSE);
4940 CONNECTION_LOCK (connection);
4942 retval = _dbus_timeout_list_set_functions (connection->timeouts,
4943 add_function, remove_function,
4945 data, free_data_function);
4947 CONNECTION_UNLOCK (connection);
4953 * Sets the mainloop wakeup function for the connection. This function
4954 * is responsible for waking up the main loop (if its sleeping in
4955 * another thread) when some some change has happened to the
4956 * connection that the mainloop needs to reconsider (e.g. a message
4957 * has been queued for writing). When using Qt, this typically
4958 * results in a call to QEventLoop::wakeUp(). When using GLib, it
4959 * would call g_main_context_wakeup().
4961 * @param connection the connection.
4962 * @param wakeup_main_function function to wake up the mainloop
4963 * @param data data to pass wakeup_main_function
4964 * @param free_data_function function to be called to free the data.
4967 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
4968 DBusWakeupMainFunction wakeup_main_function,
4970 DBusFreeFunction free_data_function)
4973 DBusFreeFunction old_free_data;
4975 _dbus_return_if_fail (connection != NULL);
4977 CONNECTION_LOCK (connection);
4978 old_data = connection->wakeup_main_data;
4979 old_free_data = connection->free_wakeup_main_data;
4981 connection->wakeup_main_function = wakeup_main_function;
4982 connection->wakeup_main_data = data;
4983 connection->free_wakeup_main_data = free_data_function;
4985 CONNECTION_UNLOCK (connection);
4987 /* Callback outside the lock */
4989 (*old_free_data) (old_data);
4993 * Set a function to be invoked when the dispatch status changes.
4994 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
4995 * dbus_connection_dispatch() needs to be called to process incoming
4996 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
4997 * from inside the DBusDispatchStatusFunction. Indeed, almost
4998 * any reentrancy in this function is a bad idea. Instead,
4999 * the DBusDispatchStatusFunction should simply save an indication
5000 * that messages should be dispatched later, when the main loop
5003 * If you don't set a dispatch status function, you have to be sure to
5004 * dispatch on every iteration of your main loop, especially if
5005 * dbus_watch_handle() or dbus_timeout_handle() were called.
5007 * @param connection the connection
5008 * @param function function to call on dispatch status changes
5009 * @param data data for function
5010 * @param free_data_function free the function data
5013 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
5014 DBusDispatchStatusFunction function,
5016 DBusFreeFunction free_data_function)
5019 DBusFreeFunction old_free_data;
5021 _dbus_return_if_fail (connection != NULL);
5023 CONNECTION_LOCK (connection);
5024 old_data = connection->dispatch_status_data;
5025 old_free_data = connection->free_dispatch_status_data;
5027 connection->dispatch_status_function = function;
5028 connection->dispatch_status_data = data;
5029 connection->free_dispatch_status_data = free_data_function;
5031 CONNECTION_UNLOCK (connection);
5033 /* Callback outside the lock */
5035 (*old_free_data) (old_data);
5039 * Get the UNIX file descriptor of the connection, if any. This can
5040 * be used for SELinux access control checks with getpeercon() for
5041 * example. DO NOT read or write to the file descriptor, or try to
5042 * select() on it; use DBusWatch for main loop integration. Not all
5043 * connections will have a file descriptor. So for adding descriptors
5044 * to the main loop, use dbus_watch_get_unix_fd() and so forth.
5046 * If the connection is socket-based, you can also use
5047 * dbus_connection_get_socket(), which will work on Windows too.
5048 * This function always fails on Windows.
5050 * Right now the returned descriptor is always a socket, but
5051 * that is not guaranteed.
5053 * @param connection the connection
5054 * @param fd return location for the file descriptor.
5055 * @returns #TRUE if fd is successfully obtained.
5058 dbus_connection_get_unix_fd (DBusConnection *connection,
5061 _dbus_return_val_if_fail (connection != NULL, FALSE);
5062 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5065 /* FIXME do this on a lower level */
5069 return dbus_connection_get_socket(connection, fd);
5073 * Gets the underlying Windows or UNIX socket file descriptor
5074 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
5075 * select() on it; use DBusWatch for main loop integration. Not all
5076 * connections will have a socket. So for adding descriptors
5077 * to the main loop, use dbus_watch_get_socket() and so forth.
5079 * If the connection is not socket-based, this function will return FALSE,
5080 * even if the connection does have a file descriptor of some kind.
5081 * i.e. this function always returns specifically a socket file descriptor.
5083 * @param connection the connection
5084 * @param fd return location for the file descriptor.
5085 * @returns #TRUE if fd is successfully obtained.
5088 dbus_connection_get_socket(DBusConnection *connection,
5093 _dbus_return_val_if_fail (connection != NULL, FALSE);
5094 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5096 CONNECTION_LOCK (connection);
5098 retval = _dbus_transport_get_socket_fd (connection->transport,
5101 CONNECTION_UNLOCK (connection);
5108 * Gets the UNIX user ID of the connection if known. Returns #TRUE if
5109 * the uid is filled in. Always returns #FALSE on non-UNIX platforms
5110 * for now, though in theory someone could hook Windows to NIS or
5111 * something. Always returns #FALSE prior to authenticating the
5114 * The UID is only read by servers from clients; clients can't usually
5115 * get the UID of servers, because servers do not authenticate to
5116 * clients. The returned UID is the UID the connection authenticated
5119 * The message bus is a server and the apps connecting to the bus
5122 * You can ask the bus to tell you the UID of another connection though
5123 * if you like; this is done with dbus_bus_get_unix_user().
5125 * @param connection the connection
5126 * @param uid return location for the user ID
5127 * @returns #TRUE if uid is filled in with a valid user ID
5130 dbus_connection_get_unix_user (DBusConnection *connection,
5135 _dbus_return_val_if_fail (connection != NULL, FALSE);
5136 _dbus_return_val_if_fail (uid != NULL, FALSE);
5138 CONNECTION_LOCK (connection);
5140 if (!_dbus_transport_get_is_authenticated (connection->transport))
5143 result = _dbus_transport_get_unix_user (connection->transport,
5147 _dbus_assert (!result);
5150 CONNECTION_UNLOCK (connection);
5156 * Gets the process ID of the connection if any.
5157 * Returns #TRUE if the pid is filled in.
5158 * Always returns #FALSE prior to authenticating the
5161 * @param connection the connection
5162 * @param pid return location for the process ID
5163 * @returns #TRUE if uid is filled in with a valid process ID
5166 dbus_connection_get_unix_process_id (DBusConnection *connection,
5171 _dbus_return_val_if_fail (connection != NULL, FALSE);
5172 _dbus_return_val_if_fail (pid != NULL, FALSE);
5174 CONNECTION_LOCK (connection);
5176 if (!_dbus_transport_get_is_authenticated (connection->transport))
5179 result = _dbus_transport_get_unix_process_id (connection->transport,
5182 CONNECTION_UNLOCK (connection);
5188 * Gets the ADT audit data of the connection if any.
5189 * Returns #TRUE if the structure pointer is returned.
5190 * Always returns #FALSE prior to authenticating the
5193 * @param connection the connection
5194 * @param data return location for audit data
5195 * @returns #TRUE if audit data is filled in with a valid ucred pointer
5198 dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
5200 dbus_int32_t *data_size)
5204 _dbus_return_val_if_fail (connection != NULL, FALSE);
5205 _dbus_return_val_if_fail (data != NULL, FALSE);
5206 _dbus_return_val_if_fail (data_size != NULL, FALSE);
5208 CONNECTION_LOCK (connection);
5210 if (!_dbus_transport_get_is_authenticated (connection->transport))
5213 result = _dbus_transport_get_adt_audit_session_data (connection->transport,
5216 CONNECTION_UNLOCK (connection);
5222 * Sets a predicate function used to determine whether a given user ID
5223 * is allowed to connect. When an incoming connection has
5224 * authenticated with a particular user ID, this function is called;
5225 * if it returns #TRUE, the connection is allowed to proceed,
5226 * otherwise the connection is disconnected.
5228 * If the function is set to #NULL (as it is by default), then
5229 * only the same UID as the server process will be allowed to
5230 * connect. Also, root is always allowed to connect.
5232 * On Windows, the function will be set and its free_data_function will
5233 * be invoked when the connection is freed or a new function is set.
5234 * However, the function will never be called, because there are
5235 * no UNIX user ids to pass to it, or at least none of the existing
5236 * auth protocols would allow authenticating as a UNIX user on Windows.
5238 * @param connection the connection
5239 * @param function the predicate
5240 * @param data data to pass to the predicate
5241 * @param free_data_function function to free the data
5244 dbus_connection_set_unix_user_function (DBusConnection *connection,
5245 DBusAllowUnixUserFunction function,
5247 DBusFreeFunction free_data_function)
5249 void *old_data = NULL;
5250 DBusFreeFunction old_free_function = NULL;
5252 _dbus_return_if_fail (connection != NULL);
5254 CONNECTION_LOCK (connection);
5255 _dbus_transport_set_unix_user_function (connection->transport,
5256 function, data, free_data_function,
5257 &old_data, &old_free_function);
5258 CONNECTION_UNLOCK (connection);
5260 if (old_free_function != NULL)
5261 (* old_free_function) (old_data);
5265 * Gets the Windows user SID of the connection if known. Returns
5266 * #TRUE if the ID is filled in. Always returns #FALSE on non-Windows
5267 * platforms for now, though in theory someone could hook UNIX to
5268 * Active Directory or something. Always returns #FALSE prior to
5269 * authenticating the connection.
5271 * The user is only read by servers from clients; clients can't usually
5272 * get the user of servers, because servers do not authenticate to
5273 * clients. The returned user is the user the connection authenticated
5276 * The message bus is a server and the apps connecting to the bus
5279 * The returned user string has to be freed with dbus_free().
5281 * The return value indicates whether the user SID is available;
5282 * if it's available but we don't have the memory to copy it,
5283 * then the return value is #TRUE and #NULL is given as the SID.
5285 * @todo We would like to be able to say "You can ask the bus to tell
5286 * you the user of another connection though if you like; this is done
5287 * with dbus_bus_get_windows_user()." But this has to be implemented
5288 * in bus/driver.c and dbus/dbus-bus.c, and is pointless anyway
5289 * since on Windows we only use the session bus for now.
5291 * @param connection the connection
5292 * @param windows_sid_p return location for an allocated copy of the user ID, or #NULL if no memory
5293 * @returns #TRUE if user is available (returned value may be #NULL anyway if no memory)
5296 dbus_connection_get_windows_user (DBusConnection *connection,
5297 char **windows_sid_p)
5301 _dbus_return_val_if_fail (connection != NULL, FALSE);
5302 _dbus_return_val_if_fail (windows_sid_p != NULL, FALSE);
5304 CONNECTION_LOCK (connection);
5306 if (!_dbus_transport_get_is_authenticated (connection->transport))
5309 result = _dbus_transport_get_windows_user (connection->transport,
5313 _dbus_assert (!result);
5316 CONNECTION_UNLOCK (connection);
5322 * Sets a predicate function used to determine whether a given user ID
5323 * is allowed to connect. When an incoming connection has
5324 * authenticated with a particular user ID, this function is called;
5325 * if it returns #TRUE, the connection is allowed to proceed,
5326 * otherwise the connection is disconnected.
5328 * If the function is set to #NULL (as it is by default), then
5329 * only the same user owning the server process will be allowed to
5332 * On UNIX, the function will be set and its free_data_function will
5333 * be invoked when the connection is freed or a new function is set.
5334 * However, the function will never be called, because there is no
5335 * way right now to authenticate as a Windows user on UNIX.
5337 * @param connection the connection
5338 * @param function the predicate
5339 * @param data data to pass to the predicate
5340 * @param free_data_function function to free the data
5343 dbus_connection_set_windows_user_function (DBusConnection *connection,
5344 DBusAllowWindowsUserFunction function,
5346 DBusFreeFunction free_data_function)
5348 void *old_data = NULL;
5349 DBusFreeFunction old_free_function = NULL;
5351 _dbus_return_if_fail (connection != NULL);
5353 CONNECTION_LOCK (connection);
5354 _dbus_transport_set_windows_user_function (connection->transport,
5355 function, data, free_data_function,
5356 &old_data, &old_free_function);
5357 CONNECTION_UNLOCK (connection);
5359 if (old_free_function != NULL)
5360 (* old_free_function) (old_data);
5364 * This function must be called on the server side of a connection when the
5365 * connection is first seen in the #DBusNewConnectionFunction. If set to
5366 * #TRUE (the default is #FALSE), then the connection can proceed even if
5367 * the client does not authenticate as some user identity, i.e. clients
5368 * can connect anonymously.
5370 * This setting interacts with the available authorization mechanisms
5371 * (see dbus_server_set_auth_mechanisms()). Namely, an auth mechanism
5372 * such as ANONYMOUS that supports anonymous auth must be included in
5373 * the list of available mechanisms for anonymous login to work.
5375 * This setting also changes the default rule for connections
5376 * authorized as a user; normally, if a connection authorizes as
5377 * a user identity, it is permitted if the user identity is
5378 * root or the user identity matches the user identity of the server
5379 * process. If anonymous connections are allowed, however,
5380 * then any user identity is allowed.
5382 * You can override the rules for connections authorized as a
5383 * user identity with dbus_connection_set_unix_user_function()
5384 * and dbus_connection_set_windows_user_function().
5386 * @param connection the connection
5387 * @param value whether to allow authentication as an anonymous user
5390 dbus_connection_set_allow_anonymous (DBusConnection *connection,
5393 _dbus_return_if_fail (connection != NULL);
5395 CONNECTION_LOCK (connection);
5396 _dbus_transport_set_allow_anonymous (connection->transport, value);
5397 CONNECTION_UNLOCK (connection);
5402 * Normally #DBusConnection automatically handles all messages to the
5403 * org.freedesktop.DBus.Peer interface. However, the message bus wants
5404 * to be able to route methods on that interface through the bus and
5405 * to other applications. If routing peer messages is enabled, then
5406 * messages with the org.freedesktop.DBus.Peer interface that also
5407 * have a bus destination name set will not be automatically
5408 * handled by the #DBusConnection and instead will be dispatched
5409 * normally to the application.
5411 * If a normal application sets this flag, it can break things badly.
5412 * So don't set this unless you are the message bus.
5414 * @param connection the connection
5415 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
5418 dbus_connection_set_route_peer_messages (DBusConnection *connection,
5421 _dbus_return_if_fail (connection != NULL);
5423 CONNECTION_LOCK (connection);
5424 connection->route_peer_messages = TRUE;
5425 CONNECTION_UNLOCK (connection);
5429 * Adds a message filter. Filters are handlers that are run on all
5430 * incoming messages, prior to the objects registered with
5431 * dbus_connection_register_object_path(). Filters are run in the
5432 * order that they were added. The same handler can be added as a
5433 * filter more than once, in which case it will be run more than once.
5434 * Filters added during a filter callback won't be run on the message
5437 * @todo we don't run filters on messages while blocking without
5438 * entering the main loop, since filters are run as part of
5439 * dbus_connection_dispatch(). This is probably a feature, as filters
5440 * could create arbitrary reentrancy. But kind of sucks if you're
5441 * trying to filter METHOD_RETURN for some reason.
5443 * @param connection the connection
5444 * @param function function to handle messages
5445 * @param user_data user data to pass to the function
5446 * @param free_data_function function to use for freeing user data
5447 * @returns #TRUE on success, #FALSE if not enough memory.
5450 dbus_connection_add_filter (DBusConnection *connection,
5451 DBusHandleMessageFunction function,
5453 DBusFreeFunction free_data_function)
5455 DBusMessageFilter *filter;
5457 _dbus_return_val_if_fail (connection != NULL, FALSE);
5458 _dbus_return_val_if_fail (function != NULL, FALSE);
5460 filter = dbus_new0 (DBusMessageFilter, 1);
5464 filter->refcount.value = 1;
5466 CONNECTION_LOCK (connection);
5468 if (!_dbus_list_append (&connection->filter_list,
5471 _dbus_message_filter_unref (filter);
5472 CONNECTION_UNLOCK (connection);
5476 /* Fill in filter after all memory allocated,
5477 * so we don't run the free_user_data_function
5478 * if the add_filter() fails
5481 filter->function = function;
5482 filter->user_data = user_data;
5483 filter->free_user_data_function = free_data_function;
5485 CONNECTION_UNLOCK (connection);
5490 * Removes a previously-added message filter. It is a programming
5491 * error to call this function for a handler that has not been added
5492 * as a filter. If the given handler was added more than once, only
5493 * one instance of it will be removed (the most recently-added
5496 * @param connection the connection
5497 * @param function the handler to remove
5498 * @param user_data user data for the handler to remove
5502 dbus_connection_remove_filter (DBusConnection *connection,
5503 DBusHandleMessageFunction function,
5507 DBusMessageFilter *filter;
5509 _dbus_return_if_fail (connection != NULL);
5510 _dbus_return_if_fail (function != NULL);
5512 CONNECTION_LOCK (connection);
5516 link = _dbus_list_get_last_link (&connection->filter_list);
5517 while (link != NULL)
5519 filter = link->data;
5521 if (filter->function == function &&
5522 filter->user_data == user_data)
5524 _dbus_list_remove_link (&connection->filter_list, link);
5525 filter->function = NULL;
5530 link = _dbus_list_get_prev_link (&connection->filter_list, link);
5534 CONNECTION_UNLOCK (connection);
5536 #ifndef DBUS_DISABLE_CHECKS
5539 _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5540 function, user_data);
5545 /* Call application code */
5546 if (filter->free_user_data_function)
5547 (* filter->free_user_data_function) (filter->user_data);
5549 filter->free_user_data_function = NULL;
5550 filter->user_data = NULL;
5552 _dbus_message_filter_unref (filter);
5556 * Registers a handler for a given path in the object hierarchy.
5557 * The given vtable handles messages sent to exactly the given path.
5559 * @param connection the connection
5560 * @param path a '/' delimited string of path elements
5561 * @param vtable the virtual table
5562 * @param user_data data to pass to functions in the vtable
5563 * @param error address where an error can be returned
5564 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5565 * #DBUS_ERROR_ADDRESS_IN_USE) is reported
5568 dbus_connection_try_register_object_path (DBusConnection *connection,
5570 const DBusObjectPathVTable *vtable,
5574 char **decomposed_path;
5577 _dbus_return_val_if_fail (connection != NULL, FALSE);
5578 _dbus_return_val_if_fail (path != NULL, FALSE);
5579 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5580 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5582 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5585 CONNECTION_LOCK (connection);
5587 retval = _dbus_object_tree_register (connection->objects,
5589 (const char **) decomposed_path, vtable,
5592 CONNECTION_UNLOCK (connection);
5594 dbus_free_string_array (decomposed_path);
5600 * Registers a handler for a given path in the object hierarchy.
5601 * The given vtable handles messages sent to exactly the given path.
5603 * It is a bug to call this function for object paths which already
5604 * have a handler. Use dbus_connection_try_register_object_path() if this
5605 * might be the case.
5607 * @param connection the connection
5608 * @param path a '/' delimited string of path elements
5609 * @param vtable the virtual table
5610 * @param user_data data to pass to functions in the vtable
5611 * @returns #FALSE if not enough memory
5614 dbus_connection_register_object_path (DBusConnection *connection,
5616 const DBusObjectPathVTable *vtable,
5619 char **decomposed_path;
5621 DBusError error = DBUS_ERROR_INIT;
5623 _dbus_return_val_if_fail (connection != NULL, FALSE);
5624 _dbus_return_val_if_fail (path != NULL, FALSE);
5625 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5626 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5628 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5631 CONNECTION_LOCK (connection);
5633 retval = _dbus_object_tree_register (connection->objects,
5635 (const char **) decomposed_path, vtable,
5638 CONNECTION_UNLOCK (connection);
5640 dbus_free_string_array (decomposed_path);
5642 if (dbus_error_has_name (&error, DBUS_ERROR_ADDRESS_IN_USE))
5644 _dbus_warn ("%s\n", error.message);
5645 dbus_error_free (&error);
5653 * Registers a fallback handler for a given subsection of the object
5654 * hierarchy. The given vtable handles messages at or below the given
5655 * path. You can use this to establish a default message handling
5656 * policy for a whole "subdirectory."
5658 * @param connection the connection
5659 * @param path a '/' delimited string of path elements
5660 * @param vtable the virtual table
5661 * @param user_data data to pass to functions in the vtable
5662 * @param error address where an error can be returned
5663 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5664 * #DBUS_ERROR_ADDRESS_IN_USE) is reported
5667 dbus_connection_try_register_fallback (DBusConnection *connection,
5669 const DBusObjectPathVTable *vtable,
5673 char **decomposed_path;
5676 _dbus_return_val_if_fail (connection != NULL, FALSE);
5677 _dbus_return_val_if_fail (path != NULL, FALSE);
5678 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5679 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5681 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5684 CONNECTION_LOCK (connection);
5686 retval = _dbus_object_tree_register (connection->objects,
5688 (const char **) decomposed_path, vtable,
5691 CONNECTION_UNLOCK (connection);
5693 dbus_free_string_array (decomposed_path);
5699 * Registers a fallback handler for a given subsection of the object
5700 * hierarchy. The given vtable handles messages at or below the given
5701 * path. You can use this to establish a default message handling
5702 * policy for a whole "subdirectory."
5704 * It is a bug to call this function for object paths which already
5705 * have a handler. Use dbus_connection_try_register_fallback() if this
5706 * might be the case.
5708 * @param connection the connection
5709 * @param path a '/' delimited string of path elements
5710 * @param vtable the virtual table
5711 * @param user_data data to pass to functions in the vtable
5712 * @returns #FALSE if not enough memory
5715 dbus_connection_register_fallback (DBusConnection *connection,
5717 const DBusObjectPathVTable *vtable,
5720 char **decomposed_path;
5722 DBusError error = DBUS_ERROR_INIT;
5724 _dbus_return_val_if_fail (connection != NULL, FALSE);
5725 _dbus_return_val_if_fail (path != NULL, FALSE);
5726 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5727 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5729 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5732 CONNECTION_LOCK (connection);
5734 retval = _dbus_object_tree_register (connection->objects,
5736 (const char **) decomposed_path, vtable,
5739 CONNECTION_UNLOCK (connection);
5741 dbus_free_string_array (decomposed_path);
5743 if (dbus_error_has_name (&error, DBUS_ERROR_ADDRESS_IN_USE))
5745 _dbus_warn ("%s\n", error.message);
5746 dbus_error_free (&error);
5754 * Unregisters the handler registered with exactly the given path.
5755 * It's a bug to call this function for a path that isn't registered.
5756 * Can unregister both fallback paths and object paths.
5758 * @param connection the connection
5759 * @param path a '/' delimited string of path elements
5760 * @returns #FALSE if not enough memory
5763 dbus_connection_unregister_object_path (DBusConnection *connection,
5766 char **decomposed_path;
5768 _dbus_return_val_if_fail (connection != NULL, FALSE);
5769 _dbus_return_val_if_fail (path != NULL, FALSE);
5770 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5772 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5775 CONNECTION_LOCK (connection);
5777 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5779 dbus_free_string_array (decomposed_path);
5785 * Gets the user data passed to dbus_connection_register_object_path()
5786 * or dbus_connection_register_fallback(). If nothing was registered
5787 * at this path, the data is filled in with #NULL.
5789 * @param connection the connection
5790 * @param path the path you registered with
5791 * @param data_p location to store the user data, or #NULL
5792 * @returns #FALSE if not enough memory
5795 dbus_connection_get_object_path_data (DBusConnection *connection,
5799 char **decomposed_path;
5801 _dbus_return_val_if_fail (connection != NULL, FALSE);
5802 _dbus_return_val_if_fail (path != NULL, FALSE);
5803 _dbus_return_val_if_fail (data_p != NULL, FALSE);
5807 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5810 CONNECTION_LOCK (connection);
5812 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5814 CONNECTION_UNLOCK (connection);
5816 dbus_free_string_array (decomposed_path);
5822 * Lists the registered fallback handlers and object path handlers at
5823 * the given parent_path. The returned array should be freed with
5824 * dbus_free_string_array().
5826 * @param connection the connection
5827 * @param parent_path the path to list the child handlers of
5828 * @param child_entries returns #NULL-terminated array of children
5829 * @returns #FALSE if no memory to allocate the child entries
5832 dbus_connection_list_registered (DBusConnection *connection,
5833 const char *parent_path,
5834 char ***child_entries)
5836 char **decomposed_path;
5838 _dbus_return_val_if_fail (connection != NULL, FALSE);
5839 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5840 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5841 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5843 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5846 CONNECTION_LOCK (connection);
5848 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5849 (const char **) decomposed_path,
5851 dbus_free_string_array (decomposed_path);
5856 static DBusDataSlotAllocator slot_allocator;
5857 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
5860 * Allocates an integer ID to be used for storing application-specific
5861 * data on any DBusConnection. The allocated ID may then be used
5862 * with dbus_connection_set_data() and dbus_connection_get_data().
5863 * The passed-in slot must be initialized to -1, and is filled in
5864 * with the slot ID. If the passed-in slot is not -1, it's assumed
5865 * to be already allocated, and its refcount is incremented.
5867 * The allocated slot is global, i.e. all DBusConnection objects will
5868 * have a slot with the given integer ID reserved.
5870 * @param slot_p address of a global variable storing the slot
5871 * @returns #FALSE on failure (no memory)
5874 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5876 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5877 &_DBUS_LOCK_NAME (connection_slots),
5882 * Deallocates a global ID for connection data slots.
5883 * dbus_connection_get_data() and dbus_connection_set_data() may no
5884 * longer be used with this slot. Existing data stored on existing
5885 * DBusConnection objects will be freed when the connection is
5886 * finalized, but may not be retrieved (and may only be replaced if
5887 * someone else reallocates the slot). When the refcount on the
5888 * passed-in slot reaches 0, it is set to -1.
5890 * @param slot_p address storing the slot to deallocate
5893 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5895 _dbus_return_if_fail (*slot_p >= 0);
5897 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5901 * Stores a pointer on a DBusConnection, along
5902 * with an optional function to be used for freeing
5903 * the data when the data is set again, or when
5904 * the connection is finalized. The slot number
5905 * must have been allocated with dbus_connection_allocate_data_slot().
5907 * @note This function does not take the
5908 * main thread lock on DBusConnection, which allows it to be
5909 * used from inside watch and timeout functions. (See the
5910 * note in docs for dbus_connection_set_watch_functions().)
5911 * A side effect of this is that you need to know there's
5912 * a reference held on the connection while invoking
5913 * dbus_connection_set_data(), or the connection could be
5914 * finalized during dbus_connection_set_data().
5916 * @param connection the connection
5917 * @param slot the slot number
5918 * @param data the data to store
5919 * @param free_data_func finalizer function for the data
5920 * @returns #TRUE if there was enough memory to store the data
5923 dbus_connection_set_data (DBusConnection *connection,
5926 DBusFreeFunction free_data_func)
5928 DBusFreeFunction old_free_func;
5932 _dbus_return_val_if_fail (connection != NULL, FALSE);
5933 _dbus_return_val_if_fail (slot >= 0, FALSE);
5935 SLOTS_LOCK (connection);
5937 retval = _dbus_data_slot_list_set (&slot_allocator,
5938 &connection->slot_list,
5939 slot, data, free_data_func,
5940 &old_free_func, &old_data);
5942 SLOTS_UNLOCK (connection);
5946 /* Do the actual free outside the connection lock */
5948 (* old_free_func) (old_data);
5955 * Retrieves data previously set with dbus_connection_set_data().
5956 * The slot must still be allocated (must not have been freed).
5958 * @note This function does not take the
5959 * main thread lock on DBusConnection, which allows it to be
5960 * used from inside watch and timeout functions. (See the
5961 * note in docs for dbus_connection_set_watch_functions().)
5962 * A side effect of this is that you need to know there's
5963 * a reference held on the connection while invoking
5964 * dbus_connection_get_data(), or the connection could be
5965 * finalized during dbus_connection_get_data().
5967 * @param connection the connection
5968 * @param slot the slot to get data from
5969 * @returns the data, or #NULL if not found
5972 dbus_connection_get_data (DBusConnection *connection,
5977 _dbus_return_val_if_fail (connection != NULL, NULL);
5979 SLOTS_LOCK (connection);
5981 res = _dbus_data_slot_list_get (&slot_allocator,
5982 &connection->slot_list,
5985 SLOTS_UNLOCK (connection);
5991 * This function sets a global flag for whether dbus_connection_new()
5992 * will set SIGPIPE behavior to SIG_IGN.
5994 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
5997 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
5999 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
6003 * Specifies the maximum size message this connection is allowed to
6004 * receive. Larger messages will result in disconnecting the
6007 * @param connection a #DBusConnection
6008 * @param size maximum message size the connection can receive, in bytes
6011 dbus_connection_set_max_message_size (DBusConnection *connection,
6014 _dbus_return_if_fail (connection != NULL);
6016 CONNECTION_LOCK (connection);
6017 _dbus_transport_set_max_message_size (connection->transport,
6019 CONNECTION_UNLOCK (connection);
6023 * Gets the value set by dbus_connection_set_max_message_size().
6025 * @param connection the connection
6026 * @returns the max size of a single message
6029 dbus_connection_get_max_message_size (DBusConnection *connection)
6033 _dbus_return_val_if_fail (connection != NULL, 0);
6035 CONNECTION_LOCK (connection);
6036 res = _dbus_transport_get_max_message_size (connection->transport);
6037 CONNECTION_UNLOCK (connection);
6042 * Specifies the maximum number of unix fds a message on this
6043 * connection is allowed to receive. Messages with more unix fds will
6044 * result in disconnecting the connection.
6046 * @param connection a #DBusConnection
6047 * @param size maximum message unix fds the connection can receive
6050 dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
6053 _dbus_return_if_fail (connection != NULL);
6055 CONNECTION_LOCK (connection);
6056 _dbus_transport_set_max_message_unix_fds (connection->transport,
6058 CONNECTION_UNLOCK (connection);
6062 * Gets the value set by dbus_connection_set_max_message_unix_fds().
6064 * @param connection the connection
6065 * @returns the max numer of unix fds of a single message
6068 dbus_connection_get_max_message_unix_fds (DBusConnection *connection)
6072 _dbus_return_val_if_fail (connection != NULL, 0);
6074 CONNECTION_LOCK (connection);
6075 res = _dbus_transport_get_max_message_unix_fds (connection->transport);
6076 CONNECTION_UNLOCK (connection);
6081 * Sets the maximum total number of bytes that can be used for all messages
6082 * received on this connection. Messages count toward the maximum until
6083 * they are finalized. When the maximum is reached, the connection will
6084 * not read more data until some messages are finalized.
6086 * The semantics of the maximum are: if outstanding messages are
6087 * already above the maximum, additional messages will not be read.
6088 * The semantics are not: if the next message would cause us to exceed
6089 * the maximum, we don't read it. The reason is that we don't know the
6090 * size of a message until after we read it.
6092 * Thus, the max live messages size can actually be exceeded
6093 * by up to the maximum size of a single message.
6095 * Also, if we read say 1024 bytes off the wire in a single read(),
6096 * and that contains a half-dozen small messages, we may exceed the
6097 * size max by that amount. But this should be inconsequential.
6099 * This does imply that we can't call read() with a buffer larger
6100 * than we're willing to exceed this limit by.
6102 * @param connection the connection
6103 * @param size the maximum size in bytes of all outstanding messages
6106 dbus_connection_set_max_received_size (DBusConnection *connection,
6109 _dbus_return_if_fail (connection != NULL);
6111 CONNECTION_LOCK (connection);
6112 _dbus_transport_set_max_received_size (connection->transport,
6114 CONNECTION_UNLOCK (connection);
6118 * Gets the value set by dbus_connection_set_max_received_size().
6120 * @param connection the connection
6121 * @returns the max size of all live messages
6124 dbus_connection_get_max_received_size (DBusConnection *connection)
6128 _dbus_return_val_if_fail (connection != NULL, 0);
6130 CONNECTION_LOCK (connection);
6131 res = _dbus_transport_get_max_received_size (connection->transport);
6132 CONNECTION_UNLOCK (connection);
6137 * Sets the maximum total number of unix fds that can be used for all messages
6138 * received on this connection. Messages count toward the maximum until
6139 * they are finalized. When the maximum is reached, the connection will
6140 * not read more data until some messages are finalized.
6142 * The semantics are analogous to those of dbus_connection_set_max_received_size().
6144 * @param connection the connection
6145 * @param size the maximum size in bytes of all outstanding messages
6148 dbus_connection_set_max_received_unix_fds (DBusConnection *connection,
6151 _dbus_return_if_fail (connection != NULL);
6153 CONNECTION_LOCK (connection);
6154 _dbus_transport_set_max_received_unix_fds (connection->transport,
6156 CONNECTION_UNLOCK (connection);
6160 * Gets the value set by dbus_connection_set_max_received_unix_fds().
6162 * @param connection the connection
6163 * @returns the max unix fds of all live messages
6166 dbus_connection_get_max_received_unix_fds (DBusConnection *connection)
6170 _dbus_return_val_if_fail (connection != NULL, 0);
6172 CONNECTION_LOCK (connection);
6173 res = _dbus_transport_get_max_received_unix_fds (connection->transport);
6174 CONNECTION_UNLOCK (connection);
6179 * Gets the approximate size in bytes of all messages in the outgoing
6180 * message queue. The size is approximate in that you shouldn't use
6181 * it to decide how many bytes to read off the network or anything
6182 * of that nature, as optimizations may choose to tell small white lies
6183 * to avoid performance overhead.
6185 * @param connection the connection
6186 * @returns the number of bytes that have been queued up but not sent
6189 dbus_connection_get_outgoing_size (DBusConnection *connection)
6193 _dbus_return_val_if_fail (connection != NULL, 0);
6195 CONNECTION_LOCK (connection);
6196 res = _dbus_counter_get_size_value (connection->outgoing_counter);
6197 CONNECTION_UNLOCK (connection);
6202 * Gets the approximate number of uni fds of all messages in the
6203 * outgoing message queue.
6205 * @param connection the connection
6206 * @returns the number of unix fds that have been queued up but not sent
6209 dbus_connection_get_outgoing_unix_fds (DBusConnection *connection)
6213 _dbus_return_val_if_fail (connection != NULL, 0);
6215 CONNECTION_LOCK (connection);
6216 res = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6217 CONNECTION_UNLOCK (connection);