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 #if 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 #ifdef DBUS_DISABLE_ASSERT
345 _dbus_atomic_inc (&filter->refcount);
347 dbus_int32_t old_value;
349 old_value = _dbus_atomic_inc (&filter->refcount);
350 _dbus_assert (old_value > 0);
357 _dbus_message_filter_unref (DBusMessageFilter *filter)
359 dbus_int32_t old_value;
361 old_value = _dbus_atomic_dec (&filter->refcount);
362 _dbus_assert (old_value > 0);
366 if (filter->free_user_data_function)
367 (* filter->free_user_data_function) (filter->user_data);
374 * Acquires the connection lock.
376 * @param connection the connection.
379 _dbus_connection_lock (DBusConnection *connection)
381 CONNECTION_LOCK (connection);
385 * Releases the connection lock.
387 * @param connection the connection.
390 _dbus_connection_unlock (DBusConnection *connection)
392 CONNECTION_UNLOCK (connection);
396 * Wakes up the main loop if it is sleeping
397 * Needed if we're e.g. queueing outgoing messages
398 * on a thread while the mainloop sleeps.
400 * @param connection the connection.
403 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
405 if (connection->wakeup_main_function)
406 (*connection->wakeup_main_function) (connection->wakeup_main_data);
409 #ifdef DBUS_BUILD_TESTS
410 /* For now this function isn't used */
412 * Adds a message to the incoming message queue, returning #FALSE
413 * if there's insufficient memory to queue the message.
414 * Does not take over refcount of the message.
416 * @param connection the connection.
417 * @param message the message to queue.
418 * @returns #TRUE on success.
421 _dbus_connection_queue_received_message (DBusConnection *connection,
422 DBusMessage *message)
426 link = _dbus_list_alloc_link (message);
430 dbus_message_ref (message);
431 _dbus_connection_queue_received_message_link (connection, link);
437 * Gets the locks so we can examine them
439 * @param connection the connection.
440 * @param mutex_loc return for the location of the main mutex pointer
441 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
442 * @param io_path_mutex_loc return location of the io_path mutex pointer
443 * @param dispatch_cond_loc return location of the dispatch conditional
445 * @param io_path_cond_loc return location of the io_path conditional
449 _dbus_connection_test_get_locks (DBusConnection *connection,
450 DBusMutex **mutex_loc,
451 DBusMutex **dispatch_mutex_loc,
452 DBusMutex **io_path_mutex_loc,
453 DBusCondVar **dispatch_cond_loc,
454 DBusCondVar **io_path_cond_loc)
456 *mutex_loc = connection->mutex;
457 *dispatch_mutex_loc = connection->dispatch_mutex;
458 *io_path_mutex_loc = connection->io_path_mutex;
459 *dispatch_cond_loc = connection->dispatch_cond;
460 *io_path_cond_loc = connection->io_path_cond;
465 * Adds a message-containing list link to the incoming message queue,
466 * taking ownership of the link and the message's current refcount.
467 * Cannot fail due to lack of memory.
469 * @param connection the connection.
470 * @param link the message link to queue.
473 _dbus_connection_queue_received_message_link (DBusConnection *connection,
476 DBusPendingCall *pending;
477 dbus_uint32_t reply_serial;
478 DBusMessage *message;
480 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
482 _dbus_list_append_link (&connection->incoming_messages,
484 message = link->data;
486 /* If this is a reply we're waiting on, remove timeout for it */
487 reply_serial = dbus_message_get_reply_serial (message);
488 if (reply_serial != 0)
490 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
494 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
495 _dbus_connection_remove_timeout_unlocked (connection,
496 _dbus_pending_call_get_timeout_unlocked (pending));
498 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
504 connection->n_incoming += 1;
506 _dbus_connection_wakeup_mainloop (connection);
508 _dbus_verbose ("Message %p (%s %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
510 dbus_message_type_to_string (dbus_message_get_type (message)),
511 dbus_message_get_path (message) ?
512 dbus_message_get_path (message) :
514 dbus_message_get_interface (message) ?
515 dbus_message_get_interface (message) :
517 dbus_message_get_member (message) ?
518 dbus_message_get_member (message) :
520 dbus_message_get_signature (message),
521 dbus_message_get_reply_serial (message),
523 connection->n_incoming);}
526 * Adds a link + message to the incoming message queue.
527 * Can't fail. Takes ownership of both link and message.
529 * @param connection the connection.
530 * @param link the list node and message to queue.
534 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
537 HAVE_LOCK_CHECK (connection);
539 _dbus_list_append_link (&connection->incoming_messages, link);
541 connection->n_incoming += 1;
543 _dbus_connection_wakeup_mainloop (connection);
545 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
546 link->data, connection, connection->n_incoming);
551 * Checks whether there are messages in the outgoing message queue.
552 * Called with connection lock held.
554 * @param connection the connection.
555 * @returns #TRUE if the outgoing queue is non-empty.
558 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
560 HAVE_LOCK_CHECK (connection);
561 return connection->outgoing_messages != NULL;
565 * Checks whether there are messages in the outgoing message queue.
566 * Use dbus_connection_flush() to block until all outgoing
567 * messages have been written to the underlying transport
568 * (such as a socket).
570 * @param connection the connection.
571 * @returns #TRUE if the outgoing queue is non-empty.
574 dbus_connection_has_messages_to_send (DBusConnection *connection)
578 _dbus_return_val_if_fail (connection != NULL, FALSE);
580 CONNECTION_LOCK (connection);
581 v = _dbus_connection_has_messages_to_send_unlocked (connection);
582 CONNECTION_UNLOCK (connection);
588 * Gets the next outgoing message. The message remains in the
589 * queue, and the caller does not own a reference to it.
591 * @param connection the connection.
592 * @returns the message to be sent.
595 _dbus_connection_get_message_to_send (DBusConnection *connection)
597 HAVE_LOCK_CHECK (connection);
599 return _dbus_list_get_last (&connection->outgoing_messages);
603 * Notifies the connection that a message has been sent, so the
604 * message can be removed from the outgoing queue.
605 * Called with the connection lock held.
607 * @param connection the connection.
608 * @param message the message that was sent.
611 _dbus_connection_message_sent (DBusConnection *connection,
612 DBusMessage *message)
616 HAVE_LOCK_CHECK (connection);
618 /* This can be called before we even complete authentication, since
619 * it's called on disconnect to clean up the outgoing queue.
620 * It's also called as we successfully send each message.
623 link = _dbus_list_get_last_link (&connection->outgoing_messages);
624 _dbus_assert (link != NULL);
625 _dbus_assert (link->data == message);
627 /* Save this link in the link cache */
628 _dbus_list_unlink (&connection->outgoing_messages,
630 _dbus_list_prepend_link (&connection->link_cache, link);
632 connection->n_outgoing -= 1;
634 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
636 dbus_message_type_to_string (dbus_message_get_type (message)),
637 dbus_message_get_path (message) ?
638 dbus_message_get_path (message) :
640 dbus_message_get_interface (message) ?
641 dbus_message_get_interface (message) :
643 dbus_message_get_member (message) ?
644 dbus_message_get_member (message) :
646 dbus_message_get_signature (message),
647 connection, connection->n_outgoing);
649 /* Save this link in the link cache also */
650 _dbus_message_remove_counter (message, connection->outgoing_counter,
652 _dbus_list_prepend_link (&connection->link_cache, link);
654 dbus_message_unref (message);
657 /** Function to be called in protected_change_watch() with refcount held */
658 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
660 /** Function to be called in protected_change_watch() with refcount held */
661 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
663 /** Function to be called in protected_change_watch() with refcount held */
664 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
666 dbus_bool_t enabled);
669 protected_change_watch (DBusConnection *connection,
671 DBusWatchAddFunction add_function,
672 DBusWatchRemoveFunction remove_function,
673 DBusWatchToggleFunction toggle_function,
678 HAVE_LOCK_CHECK (connection);
680 /* The original purpose of protected_change_watch() was to hold a
681 * ref on the connection while dropping the connection lock, then
682 * calling out to the app. This was a broken hack that did not
683 * work, since the connection was in a hosed state (no WatchList
684 * field) while calling out.
686 * So for now we'll just keep the lock while calling out. This means
687 * apps are not allowed to call DBusConnection methods inside a
688 * watch function or they will deadlock.
690 * The "real fix" is to use the _and_unlock() pattern found
691 * elsewhere in the code, to defer calling out to the app until
692 * we're about to drop locks and return flow of control to the app
695 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
698 if (connection->watches)
701 retval = (* add_function) (connection->watches, watch);
702 else if (remove_function)
705 (* remove_function) (connection->watches, watch);
710 (* toggle_function) (connection->watches, watch, enabled);
720 * Adds a watch using the connection's DBusAddWatchFunction if
721 * available. Otherwise records the watch to be added when said
722 * function is available. Also re-adds the watch if the
723 * DBusAddWatchFunction changes. May fail due to lack of memory.
724 * Connection lock should be held when calling this.
726 * @param connection the connection.
727 * @param watch the watch to add.
728 * @returns #TRUE on success.
731 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
734 return protected_change_watch (connection, watch,
735 _dbus_watch_list_add_watch,
740 * Removes a watch using the connection's DBusRemoveWatchFunction
741 * if available. It's an error to call this function on a watch
742 * that was not previously added.
743 * Connection lock should be held when calling this.
745 * @param connection the connection.
746 * @param watch the watch to remove.
749 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
752 protected_change_watch (connection, watch,
754 _dbus_watch_list_remove_watch,
759 * Toggles a watch and notifies app via connection's
760 * DBusWatchToggledFunction if available. It's an error to call this
761 * function on a watch that was not previously added.
762 * Connection lock should be held when calling this.
764 * @param connection the connection.
765 * @param watch the watch to toggle.
766 * @param enabled whether to enable or disable
769 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
773 _dbus_assert (watch != NULL);
775 protected_change_watch (connection, watch,
777 _dbus_watch_list_toggle_watch,
781 /** Function to be called in protected_change_timeout() with refcount held */
782 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
783 DBusTimeout *timeout);
784 /** Function to be called in protected_change_timeout() with refcount held */
785 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
786 DBusTimeout *timeout);
787 /** Function to be called in protected_change_timeout() with refcount held */
788 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
789 DBusTimeout *timeout,
790 dbus_bool_t enabled);
793 protected_change_timeout (DBusConnection *connection,
794 DBusTimeout *timeout,
795 DBusTimeoutAddFunction add_function,
796 DBusTimeoutRemoveFunction remove_function,
797 DBusTimeoutToggleFunction toggle_function,
802 HAVE_LOCK_CHECK (connection);
804 /* The original purpose of protected_change_timeout() was to hold a
805 * ref on the connection while dropping the connection lock, then
806 * calling out to the app. This was a broken hack that did not
807 * work, since the connection was in a hosed state (no TimeoutList
808 * field) while calling out.
810 * So for now we'll just keep the lock while calling out. This means
811 * apps are not allowed to call DBusConnection methods inside a
812 * timeout function or they will deadlock.
814 * The "real fix" is to use the _and_unlock() pattern found
815 * elsewhere in the code, to defer calling out to the app until
816 * we're about to drop locks and return flow of control to the app
819 * See http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
822 if (connection->timeouts)
825 retval = (* add_function) (connection->timeouts, timeout);
826 else if (remove_function)
829 (* remove_function) (connection->timeouts, timeout);
834 (* toggle_function) (connection->timeouts, timeout, enabled);
843 * Adds a timeout using the connection's DBusAddTimeoutFunction if
844 * available. Otherwise records the timeout to be added when said
845 * function is available. Also re-adds the timeout if the
846 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
847 * The timeout will fire repeatedly until removed.
848 * Connection lock should be held when calling this.
850 * @param connection the connection.
851 * @param timeout the timeout to add.
852 * @returns #TRUE on success.
855 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
856 DBusTimeout *timeout)
858 return protected_change_timeout (connection, timeout,
859 _dbus_timeout_list_add_timeout,
864 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
865 * if available. It's an error to call this function on a timeout
866 * that was not previously added.
867 * Connection lock should be held when calling this.
869 * @param connection the connection.
870 * @param timeout the timeout to remove.
873 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
874 DBusTimeout *timeout)
876 protected_change_timeout (connection, timeout,
878 _dbus_timeout_list_remove_timeout,
883 * Toggles a timeout and notifies app via connection's
884 * DBusTimeoutToggledFunction if available. It's an error to call this
885 * function on a timeout that was not previously added.
886 * Connection lock should be held when calling this.
888 * @param connection the connection.
889 * @param timeout the timeout to toggle.
890 * @param enabled whether to enable or disable
893 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
894 DBusTimeout *timeout,
897 protected_change_timeout (connection, timeout,
899 _dbus_timeout_list_toggle_timeout,
904 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
905 DBusPendingCall *pending)
907 dbus_uint32_t reply_serial;
908 DBusTimeout *timeout;
910 HAVE_LOCK_CHECK (connection);
912 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
914 _dbus_assert (reply_serial != 0);
916 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
920 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
923 if (!_dbus_hash_table_insert_int (connection->pending_replies,
927 _dbus_connection_remove_timeout_unlocked (connection, timeout);
929 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
930 HAVE_LOCK_CHECK (connection);
934 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
938 if (!_dbus_hash_table_insert_int (connection->pending_replies,
942 HAVE_LOCK_CHECK (connection);
947 _dbus_pending_call_ref_unlocked (pending);
949 HAVE_LOCK_CHECK (connection);
955 free_pending_call_on_hash_removal (void *data)
957 DBusPendingCall *pending;
958 DBusConnection *connection;
965 connection = _dbus_pending_call_get_connection_unlocked (pending);
967 HAVE_LOCK_CHECK (connection);
969 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
971 _dbus_connection_remove_timeout_unlocked (connection,
972 _dbus_pending_call_get_timeout_unlocked (pending));
974 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
977 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
978 * here, but the pending call finalizer could in principle call out to
979 * application code so we pretty much have to... some larger code reorg
982 _dbus_connection_ref_unlocked (connection);
983 _dbus_pending_call_unref_and_unlock (pending);
984 CONNECTION_LOCK (connection);
985 _dbus_connection_unref_unlocked (connection);
989 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
990 DBusPendingCall *pending)
992 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
995 _dbus_hash_table_remove_int (connection->pending_replies,
996 _dbus_pending_call_get_reply_serial_unlocked (pending));
1000 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
1001 DBusPendingCall *pending)
1003 /* The idea here is to avoid finalizing the pending call
1004 * with the lock held, since there's a destroy notifier
1005 * in pending call that goes out to application code.
1007 * There's an extra unlock inside the hash table
1008 * "free pending call" function FIXME...
1010 _dbus_pending_call_ref_unlocked (pending);
1011 _dbus_hash_table_remove_int (connection->pending_replies,
1012 _dbus_pending_call_get_reply_serial_unlocked (pending));
1014 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
1015 _dbus_connection_remove_timeout_unlocked (connection,
1016 _dbus_pending_call_get_timeout_unlocked (pending));
1018 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
1020 _dbus_pending_call_unref_and_unlock (pending);
1024 * Removes a pending call from the connection, such that
1025 * the pending reply will be ignored. May drop the last
1026 * reference to the pending call.
1028 * @param connection the connection
1029 * @param pending the pending call
1032 _dbus_connection_remove_pending_call (DBusConnection *connection,
1033 DBusPendingCall *pending)
1035 CONNECTION_LOCK (connection);
1036 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
1040 * Acquire the transporter I/O path. This must be done before
1041 * doing any I/O in the transporter. May sleep and drop the
1042 * IO path mutex while waiting for the I/O path.
1044 * @param connection the connection.
1045 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1046 * @returns TRUE if the I/O path was acquired.
1049 _dbus_connection_acquire_io_path (DBusConnection *connection,
1050 int timeout_milliseconds)
1052 dbus_bool_t we_acquired;
1054 HAVE_LOCK_CHECK (connection);
1056 /* We don't want the connection to vanish */
1057 _dbus_connection_ref_unlocked (connection);
1059 /* We will only touch io_path_acquired which is protected by our mutex */
1060 CONNECTION_UNLOCK (connection);
1062 _dbus_verbose ("locking io_path_mutex\n");
1063 _dbus_mutex_lock (connection->io_path_mutex);
1065 _dbus_verbose ("start connection->io_path_acquired = %d timeout = %d\n",
1066 connection->io_path_acquired, timeout_milliseconds);
1068 we_acquired = FALSE;
1070 if (connection->io_path_acquired)
1072 if (timeout_milliseconds != -1)
1074 _dbus_verbose ("waiting %d for IO path to be acquirable\n",
1075 timeout_milliseconds);
1077 if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1078 connection->io_path_mutex,
1079 timeout_milliseconds))
1081 /* We timed out before anyone signaled. */
1082 /* (writing the loop to handle the !timedout case by
1083 * waiting longer if needed is a pain since dbus
1084 * wraps pthread_cond_timedwait to take a relative
1085 * time instead of absolute, something kind of stupid
1086 * on our part. for now it doesn't matter, we will just
1087 * end up back here eventually.)
1093 while (connection->io_path_acquired)
1095 _dbus_verbose ("waiting for IO path to be acquirable\n");
1096 _dbus_condvar_wait (connection->io_path_cond,
1097 connection->io_path_mutex);
1102 if (!connection->io_path_acquired)
1105 connection->io_path_acquired = TRUE;
1108 _dbus_verbose ("end connection->io_path_acquired = %d we_acquired = %d\n",
1109 connection->io_path_acquired, we_acquired);
1111 _dbus_verbose ("unlocking io_path_mutex\n");
1112 _dbus_mutex_unlock (connection->io_path_mutex);
1114 CONNECTION_LOCK (connection);
1116 HAVE_LOCK_CHECK (connection);
1118 _dbus_connection_unref_unlocked (connection);
1124 * Release the I/O path when you're done with it. Only call
1125 * after you've acquired the I/O. Wakes up at most one thread
1126 * currently waiting to acquire the I/O path.
1128 * @param connection the connection.
1131 _dbus_connection_release_io_path (DBusConnection *connection)
1133 HAVE_LOCK_CHECK (connection);
1135 _dbus_verbose ("locking io_path_mutex\n");
1136 _dbus_mutex_lock (connection->io_path_mutex);
1138 _dbus_assert (connection->io_path_acquired);
1140 _dbus_verbose ("start connection->io_path_acquired = %d\n",
1141 connection->io_path_acquired);
1143 connection->io_path_acquired = FALSE;
1144 _dbus_condvar_wake_one (connection->io_path_cond);
1146 _dbus_verbose ("unlocking io_path_mutex\n");
1147 _dbus_mutex_unlock (connection->io_path_mutex);
1151 * Queues incoming messages and sends outgoing messages for this
1152 * connection, optionally blocking in the process. Each call to
1153 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1154 * time and then read or write data if possible.
1156 * The purpose of this function is to be able to flush outgoing
1157 * messages or queue up incoming messages without returning
1158 * control to the application and causing reentrancy weirdness.
1160 * The flags parameter allows you to specify whether to
1161 * read incoming messages, write outgoing messages, or both,
1162 * and whether to block if no immediate action is possible.
1164 * The timeout_milliseconds parameter does nothing unless the
1165 * iteration is blocking.
1167 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1168 * wasn't specified, then it's impossible to block, even if
1169 * you specify DBUS_ITERATION_BLOCK; in that case the function
1170 * returns immediately.
1172 * If pending is not NULL then a check is made if the pending call
1173 * is completed after the io path has been required. If the call
1174 * has been completed nothing is done. This must be done since
1175 * the _dbus_connection_acquire_io_path releases the connection
1178 * Called with connection lock held.
1180 * @param connection the connection.
1181 * @param pending the pending call that should be checked or NULL
1182 * @param flags iteration flags.
1183 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1186 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1187 DBusPendingCall *pending,
1189 int timeout_milliseconds)
1191 _dbus_verbose ("start\n");
1193 HAVE_LOCK_CHECK (connection);
1195 if (connection->n_outgoing == 0)
1196 flags &= ~DBUS_ITERATION_DO_WRITING;
1198 if (_dbus_connection_acquire_io_path (connection,
1199 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1201 HAVE_LOCK_CHECK (connection);
1203 if ( (pending != NULL) && _dbus_pending_call_get_completed_unlocked(pending))
1205 _dbus_verbose ("pending call completed while acquiring I/O path");
1207 else if ( (pending != NULL) &&
1208 _dbus_connection_peek_for_reply_unlocked (connection,
1209 _dbus_pending_call_get_reply_serial_unlocked (pending)))
1211 _dbus_verbose ("pending call completed while acquiring I/O path (reply found in queue)");
1215 _dbus_transport_do_iteration (connection->transport,
1216 flags, timeout_milliseconds);
1219 _dbus_connection_release_io_path (connection);
1222 HAVE_LOCK_CHECK (connection);
1224 _dbus_verbose ("end\n");
1228 * Creates a new connection for the given transport. A transport
1229 * represents a message stream that uses some concrete mechanism, such
1230 * as UNIX domain sockets. May return #NULL if insufficient
1231 * memory exists to create the connection.
1233 * @param transport the transport.
1234 * @returns the new connection, or #NULL on failure.
1237 _dbus_connection_new_for_transport (DBusTransport *transport)
1239 DBusConnection *connection;
1240 DBusWatchList *watch_list;
1241 DBusTimeoutList *timeout_list;
1242 DBusHashTable *pending_replies;
1243 DBusList *disconnect_link;
1244 DBusMessage *disconnect_message;
1245 DBusCounter *outgoing_counter;
1246 DBusObjectTree *objects;
1250 pending_replies = NULL;
1251 timeout_list = NULL;
1252 disconnect_link = NULL;
1253 disconnect_message = NULL;
1254 outgoing_counter = NULL;
1257 watch_list = _dbus_watch_list_new ();
1258 if (watch_list == NULL)
1261 timeout_list = _dbus_timeout_list_new ();
1262 if (timeout_list == NULL)
1266 _dbus_hash_table_new (DBUS_HASH_INT,
1268 (DBusFreeFunction)free_pending_call_on_hash_removal);
1269 if (pending_replies == NULL)
1272 connection = dbus_new0 (DBusConnection, 1);
1273 if (connection == NULL)
1276 _dbus_mutex_new_at_location (&connection->mutex);
1277 if (connection->mutex == NULL)
1280 _dbus_mutex_new_at_location (&connection->io_path_mutex);
1281 if (connection->io_path_mutex == NULL)
1284 _dbus_mutex_new_at_location (&connection->dispatch_mutex);
1285 if (connection->dispatch_mutex == NULL)
1288 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1289 if (connection->dispatch_cond == NULL)
1292 _dbus_condvar_new_at_location (&connection->io_path_cond);
1293 if (connection->io_path_cond == NULL)
1296 _dbus_mutex_new_at_location (&connection->slot_mutex);
1297 if (connection->slot_mutex == NULL)
1300 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1301 DBUS_INTERFACE_LOCAL,
1304 if (disconnect_message == NULL)
1307 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1308 if (disconnect_link == NULL)
1311 outgoing_counter = _dbus_counter_new ();
1312 if (outgoing_counter == NULL)
1315 objects = _dbus_object_tree_new (connection);
1316 if (objects == NULL)
1319 if (_dbus_modify_sigpipe)
1320 _dbus_disable_sigpipe ();
1322 connection->refcount.value = 1;
1323 connection->transport = transport;
1324 connection->watches = watch_list;
1325 connection->timeouts = timeout_list;
1326 connection->pending_replies = pending_replies;
1327 connection->outgoing_counter = outgoing_counter;
1328 connection->filter_list = NULL;
1329 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1330 connection->objects = objects;
1331 connection->exit_on_disconnect = FALSE;
1332 connection->shareable = FALSE;
1333 connection->route_peer_messages = FALSE;
1334 connection->disconnected_message_arrived = FALSE;
1335 connection->disconnected_message_processed = FALSE;
1337 #ifndef DBUS_DISABLE_CHECKS
1338 connection->generation = _dbus_current_generation;
1341 _dbus_data_slot_list_init (&connection->slot_list);
1343 connection->client_serial = 1;
1345 connection->disconnect_message_link = disconnect_link;
1347 CONNECTION_LOCK (connection);
1349 if (!_dbus_transport_set_connection (transport, connection))
1351 CONNECTION_UNLOCK (connection);
1356 _dbus_transport_ref (transport);
1358 CONNECTION_UNLOCK (connection);
1363 if (disconnect_message != NULL)
1364 dbus_message_unref (disconnect_message);
1366 if (disconnect_link != NULL)
1367 _dbus_list_free_link (disconnect_link);
1369 if (connection != NULL)
1371 _dbus_condvar_free_at_location (&connection->io_path_cond);
1372 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1373 _dbus_mutex_free_at_location (&connection->mutex);
1374 _dbus_mutex_free_at_location (&connection->io_path_mutex);
1375 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
1376 _dbus_mutex_free_at_location (&connection->slot_mutex);
1377 dbus_free (connection);
1379 if (pending_replies)
1380 _dbus_hash_table_unref (pending_replies);
1383 _dbus_watch_list_free (watch_list);
1386 _dbus_timeout_list_free (timeout_list);
1388 if (outgoing_counter)
1389 _dbus_counter_unref (outgoing_counter);
1392 _dbus_object_tree_unref (objects);
1398 * Increments the reference count of a DBusConnection.
1399 * Requires that the caller already holds the connection lock.
1401 * @param connection the connection.
1402 * @returns the connection.
1405 _dbus_connection_ref_unlocked (DBusConnection *connection)
1407 _dbus_assert (connection != NULL);
1408 _dbus_assert (connection->generation == _dbus_current_generation);
1410 HAVE_LOCK_CHECK (connection);
1412 _dbus_atomic_inc (&connection->refcount);
1418 * Decrements the reference count of a DBusConnection.
1419 * Requires that the caller already holds the connection lock.
1421 * @param connection the connection.
1424 _dbus_connection_unref_unlocked (DBusConnection *connection)
1426 dbus_bool_t last_unref;
1428 HAVE_LOCK_CHECK (connection);
1430 _dbus_assert (connection != NULL);
1432 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1435 _dbus_connection_last_unref (connection);
1438 static dbus_uint32_t
1439 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1441 dbus_uint32_t serial;
1443 serial = connection->client_serial++;
1445 if (connection->client_serial == 0)
1446 connection->client_serial = 1;
1452 * A callback for use with dbus_watch_new() to create a DBusWatch.
1454 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1455 * and the virtual handle_watch in DBusTransport if we got rid of it.
1456 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1459 * @param watch the watch.
1460 * @param condition the current condition of the file descriptors being watched.
1461 * @param data must be a pointer to a #DBusConnection
1462 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1465 _dbus_connection_handle_watch (DBusWatch *watch,
1466 unsigned int condition,
1469 DBusConnection *connection;
1471 DBusDispatchStatus status;
1475 _dbus_verbose ("start\n");
1477 CONNECTION_LOCK (connection);
1479 if (!_dbus_connection_acquire_io_path (connection, 1))
1481 /* another thread is handling the message */
1482 CONNECTION_UNLOCK (connection);
1486 HAVE_LOCK_CHECK (connection);
1487 retval = _dbus_transport_handle_watch (connection->transport,
1490 _dbus_connection_release_io_path (connection);
1492 HAVE_LOCK_CHECK (connection);
1494 _dbus_verbose ("middle\n");
1496 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1498 /* this calls out to user code */
1499 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1501 _dbus_verbose ("end\n");
1506 _DBUS_DEFINE_GLOBAL_LOCK (shared_connections);
1507 static DBusHashTable *shared_connections = NULL;
1508 static DBusList *shared_connections_no_guid = NULL;
1511 close_connection_on_shutdown (DBusConnection *connection)
1513 DBusMessage *message;
1515 dbus_connection_ref (connection);
1516 _dbus_connection_close_possibly_shared (connection);
1518 /* Churn through to the Disconnected message */
1519 while ((message = dbus_connection_pop_message (connection)))
1521 dbus_message_unref (message);
1523 dbus_connection_unref (connection);
1527 shared_connections_shutdown (void *data)
1531 _DBUS_LOCK (shared_connections);
1533 /* This is a little bit unpleasant... better ideas? */
1534 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1536 DBusConnection *connection;
1539 _dbus_hash_iter_init (shared_connections, &iter);
1540 _dbus_hash_iter_next (&iter);
1542 connection = _dbus_hash_iter_get_value (&iter);
1544 _DBUS_UNLOCK (shared_connections);
1545 close_connection_on_shutdown (connection);
1546 _DBUS_LOCK (shared_connections);
1548 /* The connection should now be dead and not in our hash ... */
1549 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1552 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1554 _dbus_hash_table_unref (shared_connections);
1555 shared_connections = NULL;
1557 if (shared_connections_no_guid != NULL)
1559 DBusConnection *connection;
1560 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1561 while (connection != NULL)
1563 _DBUS_UNLOCK (shared_connections);
1564 close_connection_on_shutdown (connection);
1565 _DBUS_LOCK (shared_connections);
1566 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1570 shared_connections_no_guid = NULL;
1572 _DBUS_UNLOCK (shared_connections);
1576 connection_lookup_shared (DBusAddressEntry *entry,
1577 DBusConnection **result)
1579 _dbus_verbose ("checking for existing connection\n");
1583 _DBUS_LOCK (shared_connections);
1585 if (shared_connections == NULL)
1587 _dbus_verbose ("creating shared_connections hash table\n");
1589 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1592 if (shared_connections == NULL)
1594 _DBUS_UNLOCK (shared_connections);
1598 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1600 _dbus_hash_table_unref (shared_connections);
1601 shared_connections = NULL;
1602 _DBUS_UNLOCK (shared_connections);
1606 _dbus_verbose (" successfully created shared_connections\n");
1608 _DBUS_UNLOCK (shared_connections);
1609 return TRUE; /* no point looking up in the hash we just made */
1615 guid = dbus_address_entry_get_value (entry, "guid");
1619 DBusConnection *connection;
1621 connection = _dbus_hash_table_lookup_string (shared_connections,
1626 /* The DBusConnection can't be finalized without taking
1627 * the shared_connections lock to remove it from the
1628 * hash. So it's safe to ref the connection here.
1629 * However, it may be disconnected if the Disconnected
1630 * message hasn't been processed yet, in which case we
1631 * want to pretend it isn't in the hash and avoid
1634 * The idea is to avoid ever returning a disconnected connection
1635 * from dbus_connection_open(). We could just synchronously
1636 * drop our shared ref to the connection on connection disconnect,
1637 * and then assert here that the connection is connected, but
1638 * that causes reentrancy headaches.
1640 CONNECTION_LOCK (connection);
1641 if (_dbus_connection_get_is_connected_unlocked (connection))
1643 _dbus_connection_ref_unlocked (connection);
1644 *result = connection;
1645 _dbus_verbose ("looked up existing connection to server guid %s\n",
1650 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1653 CONNECTION_UNLOCK (connection);
1657 _DBUS_UNLOCK (shared_connections);
1663 connection_record_shared_unlocked (DBusConnection *connection,
1667 char *guid_in_connection;
1669 HAVE_LOCK_CHECK (connection);
1670 _dbus_assert (connection->server_guid == NULL);
1671 _dbus_assert (connection->shareable);
1673 /* get a hard ref on this connection, even if
1674 * we won't in fact store it in the hash, we still
1675 * need to hold a ref on it until it's disconnected.
1677 _dbus_connection_ref_unlocked (connection);
1681 _DBUS_LOCK (shared_connections);
1683 if (!_dbus_list_prepend (&shared_connections_no_guid, connection))
1685 _DBUS_UNLOCK (shared_connections);
1689 _DBUS_UNLOCK (shared_connections);
1690 return TRUE; /* don't store in the hash */
1693 /* A separate copy of the key is required in the hash table, because
1694 * we don't have a lock on the connection when we are doing a hash
1698 guid_key = _dbus_strdup (guid);
1699 if (guid_key == NULL)
1702 guid_in_connection = _dbus_strdup (guid);
1703 if (guid_in_connection == NULL)
1705 dbus_free (guid_key);
1709 _DBUS_LOCK (shared_connections);
1710 _dbus_assert (shared_connections != NULL);
1712 if (!_dbus_hash_table_insert_string (shared_connections,
1713 guid_key, connection))
1715 dbus_free (guid_key);
1716 dbus_free (guid_in_connection);
1717 _DBUS_UNLOCK (shared_connections);
1721 connection->server_guid = guid_in_connection;
1723 _dbus_verbose ("stored connection to %s to be shared\n",
1724 connection->server_guid);
1726 _DBUS_UNLOCK (shared_connections);
1728 _dbus_assert (connection->server_guid != NULL);
1734 connection_forget_shared_unlocked (DBusConnection *connection)
1736 HAVE_LOCK_CHECK (connection);
1738 if (!connection->shareable)
1741 _DBUS_LOCK (shared_connections);
1743 if (connection->server_guid != NULL)
1745 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1746 connection->server_guid);
1748 if (!_dbus_hash_table_remove_string (shared_connections,
1749 connection->server_guid))
1750 _dbus_assert_not_reached ("connection was not in the shared table");
1752 dbus_free (connection->server_guid);
1753 connection->server_guid = NULL;
1757 _dbus_list_remove (&shared_connections_no_guid, connection);
1760 _DBUS_UNLOCK (shared_connections);
1762 /* remove our reference held on all shareable connections */
1763 _dbus_connection_unref_unlocked (connection);
1766 static DBusConnection*
1767 connection_try_from_address_entry (DBusAddressEntry *entry,
1770 DBusTransport *transport;
1771 DBusConnection *connection;
1773 transport = _dbus_transport_open (entry, error);
1775 if (transport == NULL)
1777 _DBUS_ASSERT_ERROR_IS_SET (error);
1781 connection = _dbus_connection_new_for_transport (transport);
1783 _dbus_transport_unref (transport);
1785 if (connection == NULL)
1787 _DBUS_SET_OOM (error);
1791 #ifndef DBUS_DISABLE_CHECKS
1792 _dbus_assert (!connection->have_connection_lock);
1798 * If the shared parameter is true, then any existing connection will
1799 * be used (and if a new connection is created, it will be available
1800 * for use by others). If the shared parameter is false, a new
1801 * connection will always be created, and the new connection will
1802 * never be returned to other callers.
1804 * @param address the address
1805 * @param shared whether the connection is shared or private
1806 * @param error error return
1807 * @returns the connection or #NULL on error
1809 static DBusConnection*
1810 _dbus_connection_open_internal (const char *address,
1814 DBusConnection *connection;
1815 DBusAddressEntry **entries;
1816 DBusError tmp_error = DBUS_ERROR_INIT;
1817 DBusError first_error = DBUS_ERROR_INIT;
1820 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1822 _dbus_verbose ("opening %s connection to: %s\n",
1823 shared ? "shared" : "private", address);
1825 if (!dbus_parse_address (address, &entries, &len, error))
1828 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1832 for (i = 0; i < len; i++)
1836 if (!connection_lookup_shared (entries[i], &connection))
1837 _DBUS_SET_OOM (&tmp_error);
1840 if (connection == NULL)
1842 connection = connection_try_from_address_entry (entries[i],
1845 if (connection != NULL && shared)
1849 connection->shareable = TRUE;
1851 /* guid may be NULL */
1852 guid = dbus_address_entry_get_value (entries[i], "guid");
1854 CONNECTION_LOCK (connection);
1856 if (!connection_record_shared_unlocked (connection, guid))
1858 _DBUS_SET_OOM (&tmp_error);
1859 _dbus_connection_close_possibly_shared_and_unlock (connection);
1860 dbus_connection_unref (connection);
1864 CONNECTION_UNLOCK (connection);
1871 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1874 dbus_move_error (&tmp_error, &first_error);
1876 dbus_error_free (&tmp_error);
1879 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1880 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1882 if (connection == NULL)
1884 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1885 dbus_move_error (&first_error, error);
1888 dbus_error_free (&first_error);
1890 dbus_address_entries_free (entries);
1895 * Closes a shared OR private connection, while dbus_connection_close() can
1896 * only be used on private connections. Should only be called by the
1897 * dbus code that owns the connection - an owner must be known,
1898 * the open/close state is like malloc/free, not like ref/unref.
1900 * @param connection the connection
1903 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1905 _dbus_assert (connection != NULL);
1906 _dbus_assert (connection->generation == _dbus_current_generation);
1908 CONNECTION_LOCK (connection);
1909 _dbus_connection_close_possibly_shared_and_unlock (connection);
1912 static DBusPreallocatedSend*
1913 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1915 DBusPreallocatedSend *preallocated;
1917 HAVE_LOCK_CHECK (connection);
1919 _dbus_assert (connection != NULL);
1921 preallocated = dbus_new (DBusPreallocatedSend, 1);
1922 if (preallocated == NULL)
1925 if (connection->link_cache != NULL)
1927 preallocated->queue_link =
1928 _dbus_list_pop_first_link (&connection->link_cache);
1929 preallocated->queue_link->data = NULL;
1933 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1934 if (preallocated->queue_link == NULL)
1938 if (connection->link_cache != NULL)
1940 preallocated->counter_link =
1941 _dbus_list_pop_first_link (&connection->link_cache);
1942 preallocated->counter_link->data = connection->outgoing_counter;
1946 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1947 if (preallocated->counter_link == NULL)
1951 _dbus_counter_ref (preallocated->counter_link->data);
1953 preallocated->connection = connection;
1955 return preallocated;
1958 _dbus_list_free_link (preallocated->queue_link);
1960 dbus_free (preallocated);
1965 /* Called with lock held, does not update dispatch status */
1967 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
1968 DBusPreallocatedSend *preallocated,
1969 DBusMessage *message,
1970 dbus_uint32_t *client_serial)
1972 dbus_uint32_t serial;
1974 preallocated->queue_link->data = message;
1975 _dbus_list_prepend_link (&connection->outgoing_messages,
1976 preallocated->queue_link);
1978 _dbus_message_add_counter_link (message,
1979 preallocated->counter_link);
1981 dbus_free (preallocated);
1982 preallocated = NULL;
1984 dbus_message_ref (message);
1986 connection->n_outgoing += 1;
1988 _dbus_verbose ("Message %p (%s %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
1990 dbus_message_type_to_string (dbus_message_get_type (message)),
1991 dbus_message_get_path (message) ?
1992 dbus_message_get_path (message) :
1994 dbus_message_get_interface (message) ?
1995 dbus_message_get_interface (message) :
1997 dbus_message_get_member (message) ?
1998 dbus_message_get_member (message) :
2000 dbus_message_get_signature (message),
2001 dbus_message_get_destination (message) ?
2002 dbus_message_get_destination (message) :
2005 connection->n_outgoing);
2007 if (dbus_message_get_serial (message) == 0)
2009 serial = _dbus_connection_get_next_client_serial (connection);
2010 dbus_message_set_serial (message, serial);
2012 *client_serial = serial;
2017 *client_serial = dbus_message_get_serial (message);
2020 _dbus_verbose ("Message %p serial is %u\n",
2021 message, dbus_message_get_serial (message));
2023 dbus_message_lock (message);
2025 /* Now we need to run an iteration to hopefully just write the messages
2026 * out immediately, and otherwise get them queued up
2028 _dbus_connection_do_iteration_unlocked (connection,
2030 DBUS_ITERATION_DO_WRITING,
2033 /* If stuff is still queued up, be sure we wake up the main loop */
2034 if (connection->n_outgoing > 0)
2035 _dbus_connection_wakeup_mainloop (connection);
2039 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2040 DBusPreallocatedSend *preallocated,
2041 DBusMessage *message,
2042 dbus_uint32_t *client_serial)
2044 DBusDispatchStatus status;
2046 HAVE_LOCK_CHECK (connection);
2048 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2050 message, client_serial);
2052 _dbus_verbose ("middle\n");
2053 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2055 /* this calls out to user code */
2056 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2060 * Like dbus_connection_send(), but assumes the connection
2061 * is already locked on function entry, and unlocks before returning.
2063 * @param connection the connection
2064 * @param message the message to send
2065 * @param client_serial return location for client serial of sent message
2066 * @returns #FALSE on out-of-memory
2069 _dbus_connection_send_and_unlock (DBusConnection *connection,
2070 DBusMessage *message,
2071 dbus_uint32_t *client_serial)
2073 DBusPreallocatedSend *preallocated;
2075 _dbus_assert (connection != NULL);
2076 _dbus_assert (message != NULL);
2078 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2079 if (preallocated == NULL)
2081 CONNECTION_UNLOCK (connection);
2085 _dbus_connection_send_preallocated_and_unlock (connection,
2093 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2094 * If the new connection function does not ref the connection, we want to close it.
2096 * A bit of a hack, probably the new connection function should have returned a value
2097 * for whether to close, or should have had to close the connection itself if it
2100 * But, this works OK as long as the new connection function doesn't do anything
2101 * crazy like keep the connection around without ref'ing it.
2103 * We have to lock the connection across refcount check and close in case
2104 * the new connection function spawns a thread that closes and unrefs.
2105 * In that case, if the app thread
2106 * closes and unrefs first, we'll harmlessly close again; if the app thread
2107 * still has the ref, we'll close and then the app will close harmlessly.
2108 * If the app unrefs without closing, the app is broken since if the
2109 * app refs from the new connection function it is supposed to also close.
2111 * If we didn't atomically check the refcount and close with the lock held
2112 * though, we could screw this up.
2114 * @param connection the connection
2117 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2119 dbus_int32_t tmp_refcount;
2121 CONNECTION_LOCK (connection);
2123 /* We increment and then decrement the refcount, because there is no
2124 * _dbus_atomic_get (mirroring the fact that there's no InterlockedGet
2126 _dbus_atomic_inc (&connection->refcount);
2127 tmp_refcount = _dbus_atomic_dec (&connection->refcount);
2129 /* The caller should have one ref, and this function temporarily took
2130 * one more, which is reflected in this count even though we already
2131 * released it (relying on the caller's ref) due to _dbus_atomic_dec
2133 _dbus_assert (tmp_refcount >= 2);
2135 if (tmp_refcount == 2)
2136 _dbus_connection_close_possibly_shared_and_unlock (connection);
2138 CONNECTION_UNLOCK (connection);
2143 * When a function that blocks has been called with a timeout, and we
2144 * run out of memory, the time to wait for memory is based on the
2145 * timeout. If the caller was willing to block a long time we wait a
2146 * relatively long time for memory, if they were only willing to block
2147 * briefly then we retry for memory at a rapid rate.
2149 * @timeout_milliseconds the timeout requested for blocking
2152 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2154 if (timeout_milliseconds == -1)
2155 _dbus_sleep_milliseconds (1000);
2156 else if (timeout_milliseconds < 100)
2157 ; /* just busy loop */
2158 else if (timeout_milliseconds <= 1000)
2159 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2161 _dbus_sleep_milliseconds (1000);
2164 static DBusMessage *
2165 generate_local_error_message (dbus_uint32_t serial,
2169 DBusMessage *message;
2170 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2174 if (!dbus_message_set_error_name (message, error_name))
2176 dbus_message_unref (message);
2181 dbus_message_set_no_reply (message, TRUE);
2183 if (!dbus_message_set_reply_serial (message,
2186 dbus_message_unref (message);
2191 if (error_msg != NULL)
2193 DBusMessageIter iter;
2195 dbus_message_iter_init_append (message, &iter);
2196 if (!dbus_message_iter_append_basic (&iter,
2200 dbus_message_unref (message);
2211 * Peek the incoming queue to see if we got reply for a specific serial
2214 _dbus_connection_peek_for_reply_unlocked (DBusConnection *connection,
2215 dbus_uint32_t client_serial)
2218 HAVE_LOCK_CHECK (connection);
2220 link = _dbus_list_get_first_link (&connection->incoming_messages);
2222 while (link != NULL)
2224 DBusMessage *reply = link->data;
2226 if (dbus_message_get_reply_serial (reply) == client_serial)
2228 _dbus_verbose ("%s reply to %d found in queue\n", _DBUS_FUNCTION_NAME, client_serial);
2231 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2237 /* This is slightly strange since we can pop a message here without
2238 * the dispatch lock.
2241 check_for_reply_unlocked (DBusConnection *connection,
2242 dbus_uint32_t client_serial)
2246 HAVE_LOCK_CHECK (connection);
2248 link = _dbus_list_get_first_link (&connection->incoming_messages);
2250 while (link != NULL)
2252 DBusMessage *reply = link->data;
2254 if (dbus_message_get_reply_serial (reply) == client_serial)
2256 _dbus_list_remove_link (&connection->incoming_messages, link);
2257 connection->n_incoming -= 1;
2260 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2267 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2269 /* We can't iterate over the hash in the normal way since we'll be
2270 * dropping the lock for each item. So we restart the
2271 * iter each time as we drain the hash table.
2274 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2276 DBusPendingCall *pending;
2279 _dbus_hash_iter_init (connection->pending_replies, &iter);
2280 _dbus_hash_iter_next (&iter);
2282 pending = _dbus_hash_iter_get_value (&iter);
2283 _dbus_pending_call_ref_unlocked (pending);
2285 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2288 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
2289 _dbus_connection_remove_timeout_unlocked (connection,
2290 _dbus_pending_call_get_timeout_unlocked (pending));
2291 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2292 _dbus_hash_iter_remove_entry (&iter);
2294 _dbus_pending_call_unref_and_unlock (pending);
2295 CONNECTION_LOCK (connection);
2297 HAVE_LOCK_CHECK (connection);
2301 complete_pending_call_and_unlock (DBusConnection *connection,
2302 DBusPendingCall *pending,
2303 DBusMessage *message)
2305 _dbus_pending_call_set_reply_unlocked (pending, message);
2306 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2307 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2309 /* Must be called unlocked since it invokes app callback */
2310 _dbus_pending_call_complete (pending);
2311 dbus_pending_call_unref (pending);
2315 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2316 DBusPendingCall *pending)
2319 DBusDispatchStatus status;
2321 reply = check_for_reply_unlocked (connection,
2322 _dbus_pending_call_get_reply_serial_unlocked (pending));
2325 _dbus_verbose ("checked for reply\n");
2327 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2329 complete_pending_call_and_unlock (connection, pending, reply);
2330 dbus_message_unref (reply);
2332 CONNECTION_LOCK (connection);
2333 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2334 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2335 dbus_pending_call_unref (pending);
2344 * Blocks until a pending call times out or gets a reply.
2346 * Does not re-enter the main loop or run filter/path-registered
2347 * callbacks. The reply to the message will not be seen by
2350 * Returns immediately if pending call already got a reply.
2352 * @todo could use performance improvements (it keeps scanning
2353 * the whole message queue for example)
2355 * @param pending the pending call we block for a reply on
2358 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2360 long start_tv_sec, start_tv_usec;
2361 long tv_sec, tv_usec;
2362 DBusDispatchStatus status;
2363 DBusConnection *connection;
2364 dbus_uint32_t client_serial;
2365 DBusTimeout *timeout;
2366 int timeout_milliseconds, elapsed_milliseconds;
2368 _dbus_assert (pending != NULL);
2370 if (dbus_pending_call_get_completed (pending))
2373 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2375 connection = _dbus_pending_call_get_connection_and_lock (pending);
2377 /* Flush message queue - note, can affect dispatch status */
2378 _dbus_connection_flush_unlocked (connection);
2380 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2382 /* note that timeout_milliseconds is limited to a smallish value
2383 * in _dbus_pending_call_new() so overflows aren't possible
2386 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
2387 _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
2390 timeout_milliseconds = dbus_timeout_get_interval (timeout);
2392 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec\n",
2393 timeout_milliseconds,
2395 start_tv_sec, start_tv_usec);
2399 timeout_milliseconds = -1;
2401 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block for reply serial %u\n", client_serial);
2404 /* check to see if we already got the data off the socket */
2405 /* from another blocked pending call */
2406 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2409 /* Now we wait... */
2410 /* always block at least once as we know we don't have the reply yet */
2411 _dbus_connection_do_iteration_unlocked (connection,
2413 DBUS_ITERATION_DO_READING |
2414 DBUS_ITERATION_BLOCK,
2415 timeout_milliseconds);
2419 _dbus_verbose ("top of recheck\n");
2421 HAVE_LOCK_CHECK (connection);
2423 /* queue messages and get status */
2425 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2427 /* the get_completed() is in case a dispatch() while we were blocking
2428 * got the reply instead of us.
2430 if (_dbus_pending_call_get_completed_unlocked (pending))
2432 _dbus_verbose ("Pending call completed by dispatch\n");
2433 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2434 dbus_pending_call_unref (pending);
2438 if (status == DBUS_DISPATCH_DATA_REMAINS)
2440 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2444 _dbus_get_current_time (&tv_sec, &tv_usec);
2445 elapsed_milliseconds = (tv_sec - start_tv_sec) * 1000 +
2446 (tv_usec - start_tv_usec) / 1000;
2448 if (!_dbus_connection_get_is_connected_unlocked (connection))
2450 DBusMessage *error_msg;
2452 error_msg = generate_local_error_message (client_serial,
2453 DBUS_ERROR_DISCONNECTED,
2454 "Connection was disconnected before a reply was received");
2456 /* on OOM error_msg is set to NULL */
2457 complete_pending_call_and_unlock (connection, pending, error_msg);
2458 dbus_pending_call_unref (pending);
2461 else if (connection->disconnect_message_link == NULL)
2462 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2463 else if (timeout == NULL)
2465 if (status == DBUS_DISPATCH_NEED_MEMORY)
2467 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2468 * we may already have a reply in the buffer and just can't process
2471 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2473 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2477 /* block again, we don't have the reply buffered yet. */
2478 _dbus_connection_do_iteration_unlocked (connection,
2480 DBUS_ITERATION_DO_READING |
2481 DBUS_ITERATION_BLOCK,
2482 timeout_milliseconds - elapsed_milliseconds);
2485 goto recheck_status;
2487 else if (tv_sec < start_tv_sec)
2488 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2489 else if (elapsed_milliseconds < timeout_milliseconds)
2491 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds - elapsed_milliseconds);
2493 if (status == DBUS_DISPATCH_NEED_MEMORY)
2495 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2496 * we may already have a reply in the buffer and just can't process
2499 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2501 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2505 /* block again, we don't have the reply buffered yet. */
2506 _dbus_connection_do_iteration_unlocked (connection,
2508 DBUS_ITERATION_DO_READING |
2509 DBUS_ITERATION_BLOCK,
2510 timeout_milliseconds - elapsed_milliseconds);
2513 goto recheck_status;
2516 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %d milliseconds and got no reply\n",
2517 elapsed_milliseconds);
2519 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2521 /* unlock and call user code */
2522 complete_pending_call_and_unlock (connection, pending, NULL);
2524 /* update user code on dispatch status */
2525 CONNECTION_LOCK (connection);
2526 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2527 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2528 dbus_pending_call_unref (pending);
2534 * @addtogroup DBusConnection
2540 * Gets a connection to a remote address. If a connection to the given
2541 * address already exists, returns the existing connection with its
2542 * reference count incremented. Otherwise, returns a new connection
2543 * and saves the new connection for possible re-use if a future call
2544 * to dbus_connection_open() asks to connect to the same server.
2546 * Use dbus_connection_open_private() to get a dedicated connection
2547 * not shared with other callers of dbus_connection_open().
2549 * If the open fails, the function returns #NULL, and provides a
2550 * reason for the failure in the error parameter. Pass #NULL for the
2551 * error parameter if you aren't interested in the reason for
2554 * Because this connection is shared, no user of the connection
2555 * may call dbus_connection_close(). However, when you are done with the
2556 * connection you should call dbus_connection_unref().
2558 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2559 * unless you have good reason; connections are expensive enough
2560 * that it's wasteful to create lots of connections to the same
2563 * @param address the address.
2564 * @param error address where an error can be returned.
2565 * @returns new connection, or #NULL on failure.
2568 dbus_connection_open (const char *address,
2571 DBusConnection *connection;
2573 _dbus_return_val_if_fail (address != NULL, NULL);
2574 _dbus_return_val_if_error_is_set (error, NULL);
2576 connection = _dbus_connection_open_internal (address,
2584 * Opens a new, dedicated connection to a remote address. Unlike
2585 * dbus_connection_open(), always creates a new connection.
2586 * This connection will not be saved or recycled by libdbus.
2588 * If the open fails, the function returns #NULL, and provides a
2589 * reason for the failure in the error parameter. Pass #NULL for the
2590 * error parameter if you aren't interested in the reason for
2593 * When you are done with this connection, you must
2594 * dbus_connection_close() to disconnect it,
2595 * and dbus_connection_unref() to free the connection object.
2597 * (The dbus_connection_close() can be skipped if the
2598 * connection is already known to be disconnected, for example
2599 * if you are inside a handler for the Disconnected signal.)
2601 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2602 * unless you have good reason; connections are expensive enough
2603 * that it's wasteful to create lots of connections to the same
2606 * @param address the address.
2607 * @param error address where an error can be returned.
2608 * @returns new connection, or #NULL on failure.
2611 dbus_connection_open_private (const char *address,
2614 DBusConnection *connection;
2616 _dbus_return_val_if_fail (address != NULL, NULL);
2617 _dbus_return_val_if_error_is_set (error, NULL);
2619 connection = _dbus_connection_open_internal (address,
2627 * Increments the reference count of a DBusConnection.
2629 * @param connection the connection.
2630 * @returns the connection.
2633 dbus_connection_ref (DBusConnection *connection)
2635 _dbus_return_val_if_fail (connection != NULL, NULL);
2636 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2638 _dbus_atomic_inc (&connection->refcount);
2644 free_outgoing_message (void *element,
2647 DBusMessage *message = element;
2648 DBusConnection *connection = data;
2650 _dbus_message_remove_counter (message,
2651 connection->outgoing_counter,
2653 dbus_message_unref (message);
2656 /* This is run without the mutex held, but after the last reference
2657 * to the connection has been dropped we should have no thread-related
2661 _dbus_connection_last_unref (DBusConnection *connection)
2665 _dbus_verbose ("Finalizing connection %p\n", connection);
2667 _dbus_assert (connection->refcount.value == 0);
2669 /* You have to disconnect the connection before unref:ing it. Otherwise
2670 * you won't get the disconnected message.
2672 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2673 _dbus_assert (connection->server_guid == NULL);
2675 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2676 _dbus_object_tree_free_all_unlocked (connection->objects);
2678 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2679 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2680 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2682 _dbus_watch_list_free (connection->watches);
2683 connection->watches = NULL;
2685 _dbus_timeout_list_free (connection->timeouts);
2686 connection->timeouts = NULL;
2688 _dbus_data_slot_list_free (&connection->slot_list);
2690 link = _dbus_list_get_first_link (&connection->filter_list);
2691 while (link != NULL)
2693 DBusMessageFilter *filter = link->data;
2694 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2696 filter->function = NULL;
2697 _dbus_message_filter_unref (filter); /* calls app callback */
2702 _dbus_list_clear (&connection->filter_list);
2704 /* ---- Done with stuff that invokes application callbacks */
2706 _dbus_object_tree_unref (connection->objects);
2708 _dbus_hash_table_unref (connection->pending_replies);
2709 connection->pending_replies = NULL;
2711 _dbus_list_clear (&connection->filter_list);
2713 _dbus_list_foreach (&connection->outgoing_messages,
2714 free_outgoing_message,
2716 _dbus_list_clear (&connection->outgoing_messages);
2718 _dbus_list_foreach (&connection->incoming_messages,
2719 (DBusForeachFunction) dbus_message_unref,
2721 _dbus_list_clear (&connection->incoming_messages);
2723 _dbus_counter_unref (connection->outgoing_counter);
2725 _dbus_transport_unref (connection->transport);
2727 if (connection->disconnect_message_link)
2729 DBusMessage *message = connection->disconnect_message_link->data;
2730 dbus_message_unref (message);
2731 _dbus_list_free_link (connection->disconnect_message_link);
2734 _dbus_list_clear (&connection->link_cache);
2736 _dbus_condvar_free_at_location (&connection->dispatch_cond);
2737 _dbus_condvar_free_at_location (&connection->io_path_cond);
2739 _dbus_mutex_free_at_location (&connection->io_path_mutex);
2740 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
2742 _dbus_mutex_free_at_location (&connection->slot_mutex);
2744 _dbus_mutex_free_at_location (&connection->mutex);
2746 dbus_free (connection);
2750 * Decrements the reference count of a DBusConnection, and finalizes
2751 * it if the count reaches zero.
2753 * Note: it is a bug to drop the last reference to a connection that
2754 * is still connected.
2756 * For shared connections, libdbus will own a reference
2757 * as long as the connection is connected, so you can know that either
2758 * you don't have the last reference, or it's OK to drop the last reference.
2759 * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2760 * return shared connections.
2762 * For private connections, the creator of the connection must arrange for
2763 * dbus_connection_close() to be called prior to dropping the last reference.
2764 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2766 * @param connection the connection.
2769 dbus_connection_unref (DBusConnection *connection)
2771 dbus_bool_t last_unref;
2773 _dbus_return_if_fail (connection != NULL);
2774 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2776 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
2780 #ifndef DBUS_DISABLE_CHECKS
2781 if (_dbus_transport_get_is_connected (connection->transport))
2783 _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",
2784 connection->shareable ?
2785 "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2786 "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2790 _dbus_connection_last_unref (connection);
2795 * Note that the transport can disconnect itself (other end drops us)
2796 * and in that case this function never runs. So this function must
2797 * not do anything more than disconnect the transport and update the
2800 * If the transport self-disconnects, then we assume someone will
2801 * dispatch the connection to cause the dispatch status update.
2804 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2806 DBusDispatchStatus status;
2808 HAVE_LOCK_CHECK (connection);
2810 _dbus_verbose ("Disconnecting %p\n", connection);
2812 /* We need to ref because update_dispatch_status_and_unlock will unref
2813 * the connection if it was shared and libdbus was the only remaining
2816 _dbus_connection_ref_unlocked (connection);
2818 _dbus_transport_disconnect (connection->transport);
2820 /* This has the side effect of queuing the disconnect message link
2821 * (unless we don't have enough memory, possibly, so don't assert it).
2822 * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2823 * should never again return the newly-disconnected connection.
2825 * However, we only unref the shared connection and exit_on_disconnect when
2826 * the disconnect message reaches the head of the message queue,
2827 * NOT when it's first queued.
2829 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2831 /* This calls out to user code */
2832 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2834 /* Could also call out to user code */
2835 dbus_connection_unref (connection);
2839 * Closes a private connection, so no further data can be sent or received.
2840 * This disconnects the transport (such as a socket) underlying the
2843 * Attempts to send messages after closing a connection are safe, but will result in
2844 * error replies generated locally in libdbus.
2846 * This function does not affect the connection's reference count. It's
2847 * safe to close a connection more than once; all calls after the
2848 * first do nothing. It's impossible to "reopen" a connection, a
2849 * new connection must be created. This function may result in a call
2850 * to the DBusDispatchStatusFunction set with
2851 * dbus_connection_set_dispatch_status_function(), as the disconnect
2852 * message it generates needs to be dispatched.
2854 * If a connection is dropped by the remote application, it will
2857 * You must close a connection prior to releasing the last reference to
2858 * the connection. If you dbus_connection_unref() for the last time
2859 * without closing the connection, the results are undefined; it
2860 * is a bug in your program and libdbus will try to print a warning.
2862 * You may not close a shared connection. Connections created with
2863 * dbus_connection_open() or dbus_bus_get() are shared.
2864 * These connections are owned by libdbus, and applications should
2865 * only unref them, never close them. Applications can know it is
2866 * safe to unref these connections because libdbus will be holding a
2867 * reference as long as the connection is open. Thus, either the
2868 * connection is closed and it is OK to drop the last reference,
2869 * or the connection is open and the app knows it does not have the
2872 * Connections created with dbus_connection_open_private() or
2873 * dbus_bus_get_private() are not kept track of or referenced by
2874 * libdbus. The creator of these connections is responsible for
2875 * calling dbus_connection_close() prior to releasing the last
2876 * reference, if the connection is not already disconnected.
2878 * @param connection the private (unshared) connection to close
2881 dbus_connection_close (DBusConnection *connection)
2883 _dbus_return_if_fail (connection != NULL);
2884 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2886 CONNECTION_LOCK (connection);
2888 #ifndef DBUS_DISABLE_CHECKS
2889 if (connection->shareable)
2891 CONNECTION_UNLOCK (connection);
2893 _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2898 _dbus_connection_close_possibly_shared_and_unlock (connection);
2902 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2904 HAVE_LOCK_CHECK (connection);
2905 return _dbus_transport_get_is_connected (connection->transport);
2909 * Gets whether the connection is currently open. A connection may
2910 * become disconnected when the remote application closes its end, or
2911 * exits; a connection may also be disconnected with
2912 * dbus_connection_close().
2914 * There are not separate states for "closed" and "disconnected," the two
2915 * terms are synonymous. This function should really be called
2916 * get_is_open() but for historical reasons is not.
2918 * @param connection the connection.
2919 * @returns #TRUE if the connection is still alive.
2922 dbus_connection_get_is_connected (DBusConnection *connection)
2926 _dbus_return_val_if_fail (connection != NULL, FALSE);
2928 CONNECTION_LOCK (connection);
2929 res = _dbus_connection_get_is_connected_unlocked (connection);
2930 CONNECTION_UNLOCK (connection);
2936 * Gets whether the connection was authenticated. (Note that
2937 * if the connection was authenticated then disconnected,
2938 * this function still returns #TRUE)
2940 * @param connection the connection
2941 * @returns #TRUE if the connection was ever authenticated
2944 dbus_connection_get_is_authenticated (DBusConnection *connection)
2948 _dbus_return_val_if_fail (connection != NULL, FALSE);
2950 CONNECTION_LOCK (connection);
2951 res = _dbus_transport_get_is_authenticated (connection->transport);
2952 CONNECTION_UNLOCK (connection);
2958 * Gets whether the connection is not authenticated as a specific
2959 * user. If the connection is not authenticated, this function
2960 * returns #TRUE, and if it is authenticated but as an anonymous user,
2961 * it returns #TRUE. If it is authenticated as a specific user, then
2962 * this returns #FALSE. (Note that if the connection was authenticated
2963 * as anonymous then disconnected, this function still returns #TRUE.)
2965 * If the connection is not anonymous, you can use
2966 * dbus_connection_get_unix_user() and
2967 * dbus_connection_get_windows_user() to see who it's authorized as.
2969 * If you want to prevent non-anonymous authorization, use
2970 * dbus_server_set_auth_mechanisms() to remove the mechanisms that
2971 * allow proving user identity (i.e. only allow the ANONYMOUS
2974 * @param connection the connection
2975 * @returns #TRUE if not authenticated or authenticated as anonymous
2978 dbus_connection_get_is_anonymous (DBusConnection *connection)
2982 _dbus_return_val_if_fail (connection != NULL, FALSE);
2984 CONNECTION_LOCK (connection);
2985 res = _dbus_transport_get_is_anonymous (connection->transport);
2986 CONNECTION_UNLOCK (connection);
2992 * Gets the ID of the server address we are authenticated to, if this
2993 * connection is on the client side. If the connection is on the
2994 * server side, this will always return #NULL - use dbus_server_get_id()
2995 * to get the ID of your own server, if you are the server side.
2997 * If a client-side connection is not authenticated yet, the ID may be
2998 * available if it was included in the server address, but may not be
2999 * available. The only way to be sure the server ID is available
3000 * is to wait for authentication to complete.
3002 * In general, each mode of connecting to a given server will have
3003 * its own ID. So for example, if the session bus daemon is listening
3004 * on UNIX domain sockets and on TCP, then each of those modalities
3005 * will have its own server ID.
3007 * If you want an ID that identifies an entire session bus, look at
3008 * dbus_bus_get_id() instead (which is just a convenience wrapper
3009 * around the org.freedesktop.DBus.GetId method invoked on the bus).
3011 * You can also get a machine ID; see dbus_get_local_machine_id() to
3012 * get the machine you are on. There isn't a convenience wrapper, but
3013 * you can invoke org.freedesktop.DBus.Peer.GetMachineId on any peer
3014 * to get the machine ID on the other end.
3016 * The D-Bus specification describes the server ID and other IDs in a
3019 * @param connection the connection
3020 * @returns the server ID or #NULL if no memory or the connection is server-side
3023 dbus_connection_get_server_id (DBusConnection *connection)
3027 _dbus_return_val_if_fail (connection != NULL, NULL);
3029 CONNECTION_LOCK (connection);
3030 id = _dbus_strdup (_dbus_transport_get_server_id (connection->transport));
3031 CONNECTION_UNLOCK (connection);
3037 * Tests whether a certain type can be send via the connection. This
3038 * will always return TRUE for all types, with the exception of
3039 * DBUS_TYPE_UNIX_FD. The function will return TRUE for
3040 * DBUS_TYPE_UNIX_FD only on systems that know Unix file descriptors
3041 * and can send them via the chosen transport and when the remote side
3044 * This function can be used to do runtime checking for types that
3045 * might be unknown to the specific D-Bus client implementation
3046 * version, i.e. it will return FALSE for all types this
3047 * implementation does not know, including invalid or reserved types.
3049 * @param connection the connection
3050 * @param type the type to check
3051 * @returns TRUE if the type may be send via the connection
3054 dbus_connection_can_send_type(DBusConnection *connection,
3057 _dbus_return_val_if_fail (connection != NULL, FALSE);
3059 if (!_dbus_type_is_valid(type))
3062 if (type != DBUS_TYPE_UNIX_FD)
3065 #ifdef HAVE_UNIX_FD_PASSING
3069 CONNECTION_LOCK(connection);
3070 b = _dbus_transport_can_pass_unix_fd(connection->transport);
3071 CONNECTION_UNLOCK(connection);
3081 * Set whether _exit() should be called when the connection receives a
3082 * disconnect signal. The call to _exit() comes after any handlers for
3083 * the disconnect signal run; handlers can cancel the exit by calling
3086 * By default, exit_on_disconnect is #FALSE; but for message bus
3087 * connections returned from dbus_bus_get() it will be toggled on
3090 * @param connection the connection
3091 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
3094 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
3095 dbus_bool_t exit_on_disconnect)
3097 _dbus_return_if_fail (connection != NULL);
3099 CONNECTION_LOCK (connection);
3100 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
3101 CONNECTION_UNLOCK (connection);
3105 * Preallocates resources needed to send a message, allowing the message
3106 * to be sent without the possibility of memory allocation failure.
3107 * Allows apps to create a future guarantee that they can send
3108 * a message regardless of memory shortages.
3110 * @param connection the connection we're preallocating for.
3111 * @returns the preallocated resources, or #NULL
3113 DBusPreallocatedSend*
3114 dbus_connection_preallocate_send (DBusConnection *connection)
3116 DBusPreallocatedSend *preallocated;
3118 _dbus_return_val_if_fail (connection != NULL, NULL);
3120 CONNECTION_LOCK (connection);
3123 _dbus_connection_preallocate_send_unlocked (connection);
3125 CONNECTION_UNLOCK (connection);
3127 return preallocated;
3131 * Frees preallocated message-sending resources from
3132 * dbus_connection_preallocate_send(). Should only
3133 * be called if the preallocated resources are not used
3134 * to send a message.
3136 * @param connection the connection
3137 * @param preallocated the resources
3140 dbus_connection_free_preallocated_send (DBusConnection *connection,
3141 DBusPreallocatedSend *preallocated)
3143 _dbus_return_if_fail (connection != NULL);
3144 _dbus_return_if_fail (preallocated != NULL);
3145 _dbus_return_if_fail (connection == preallocated->connection);
3147 _dbus_list_free_link (preallocated->queue_link);
3148 _dbus_counter_unref (preallocated->counter_link->data);
3149 _dbus_list_free_link (preallocated->counter_link);
3150 dbus_free (preallocated);
3154 * Sends a message using preallocated resources. This function cannot fail.
3155 * It works identically to dbus_connection_send() in other respects.
3156 * Preallocated resources comes from dbus_connection_preallocate_send().
3157 * This function "consumes" the preallocated resources, they need not
3158 * be freed separately.
3160 * @param connection the connection
3161 * @param preallocated the preallocated resources
3162 * @param message the message to send
3163 * @param client_serial return location for client serial assigned to the message
3166 dbus_connection_send_preallocated (DBusConnection *connection,
3167 DBusPreallocatedSend *preallocated,
3168 DBusMessage *message,
3169 dbus_uint32_t *client_serial)
3171 _dbus_return_if_fail (connection != NULL);
3172 _dbus_return_if_fail (preallocated != NULL);
3173 _dbus_return_if_fail (message != NULL);
3174 _dbus_return_if_fail (preallocated->connection == connection);
3175 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3176 dbus_message_get_member (message) != NULL);
3177 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
3178 (dbus_message_get_interface (message) != NULL &&
3179 dbus_message_get_member (message) != NULL));
3181 CONNECTION_LOCK (connection);
3183 #ifdef HAVE_UNIX_FD_PASSING
3185 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3186 message->n_unix_fds > 0)
3188 /* Refuse to send fds on a connection that cannot handle
3189 them. Unfortunately we cannot return a proper error here, so
3190 the best we can is just return. */
3191 CONNECTION_UNLOCK (connection);
3197 _dbus_connection_send_preallocated_and_unlock (connection,
3199 message, client_serial);
3203 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
3204 DBusMessage *message,
3205 dbus_uint32_t *client_serial)
3207 DBusPreallocatedSend *preallocated;
3209 _dbus_assert (connection != NULL);
3210 _dbus_assert (message != NULL);
3212 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
3213 if (preallocated == NULL)
3216 _dbus_connection_send_preallocated_unlocked_no_update (connection,
3224 * Adds a message to the outgoing message queue. Does not block to
3225 * write the message to the network; that happens asynchronously. To
3226 * force the message to be written, call dbus_connection_flush() however
3227 * it is not necessary to call dbus_connection_flush() by hand; the
3228 * message will be sent the next time the main loop is run.
3229 * dbus_connection_flush() should only be used, for example, if
3230 * the application was expected to exit before running the main loop.
3232 * Because this only queues the message, the only reason it can
3233 * fail is lack of memory. Even if the connection is disconnected,
3234 * no error will be returned. If the function fails due to lack of memory,
3235 * it returns #FALSE. The function will never fail for other reasons; even
3236 * if the connection is disconnected, you can queue an outgoing message,
3237 * though obviously it won't be sent.
3239 * The message serial is used by the remote application to send a
3240 * reply; see dbus_message_get_serial() or the D-Bus specification.
3242 * dbus_message_unref() can be called as soon as this method returns
3243 * as the message queue will hold its own ref until the message is sent.
3245 * @param connection the connection.
3246 * @param message the message to write.
3247 * @param serial return location for message serial, or #NULL if you don't care
3248 * @returns #TRUE on success.
3251 dbus_connection_send (DBusConnection *connection,
3252 DBusMessage *message,
3253 dbus_uint32_t *serial)
3255 _dbus_return_val_if_fail (connection != NULL, FALSE);
3256 _dbus_return_val_if_fail (message != NULL, FALSE);
3258 CONNECTION_LOCK (connection);
3260 #ifdef HAVE_UNIX_FD_PASSING
3262 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3263 message->n_unix_fds > 0)
3265 /* Refuse to send fds on a connection that cannot handle
3266 them. Unfortunately we cannot return a proper error here, so
3267 the best we can is just return. */
3268 CONNECTION_UNLOCK (connection);
3274 return _dbus_connection_send_and_unlock (connection,
3280 reply_handler_timeout (void *data)
3282 DBusConnection *connection;
3283 DBusDispatchStatus status;
3284 DBusPendingCall *pending = data;
3286 connection = _dbus_pending_call_get_connection_and_lock (pending);
3288 _dbus_pending_call_queue_timeout_error_unlocked (pending,
3290 _dbus_connection_remove_timeout_unlocked (connection,
3291 _dbus_pending_call_get_timeout_unlocked (pending));
3292 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
3294 _dbus_verbose ("middle\n");
3295 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3297 /* Unlocks, and calls out to user code */
3298 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3304 * Queues a message to send, as with dbus_connection_send(),
3305 * but also returns a #DBusPendingCall used to receive a reply to the
3306 * message. If no reply is received in the given timeout_milliseconds,
3307 * this function expires the pending reply and generates a synthetic
3308 * error reply (generated in-process, not by the remote application)
3309 * indicating that a timeout occurred.
3311 * A #DBusPendingCall will see a reply message before any filters or
3312 * registered object path handlers. See dbus_connection_dispatch() for
3313 * details on when handlers are run.
3315 * A #DBusPendingCall will always see exactly one reply message,
3316 * unless it's cancelled with dbus_pending_call_cancel().
3318 * If #NULL is passed for the pending_return, the #DBusPendingCall
3319 * will still be generated internally, and used to track
3320 * the message reply timeout. This means a timeout error will
3321 * occur if no reply arrives, unlike with dbus_connection_send().
3323 * If -1 is passed for the timeout, a sane default timeout is used. -1
3324 * is typically the best value for the timeout for this reason, unless
3325 * you want a very short or very long timeout. If #DBUS_TIMEOUT_INFINITE is
3326 * passed for the timeout, no timeout will be set and the call will block
3329 * @warning if the connection is disconnected or you try to send Unix
3330 * file descriptors on a connection that does not support them, the
3331 * #DBusPendingCall will be set to #NULL, so be careful with this.
3333 * @param connection the connection
3334 * @param message the message to send
3335 * @param pending_return return location for a #DBusPendingCall
3336 * object, or #NULL if connection is disconnected or when you try to
3337 * send Unix file descriptors on a connection that does not support
3339 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3340 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3342 * @returns #FALSE if no memory, #TRUE otherwise.
3346 dbus_connection_send_with_reply (DBusConnection *connection,
3347 DBusMessage *message,
3348 DBusPendingCall **pending_return,
3349 int timeout_milliseconds)
3351 DBusPendingCall *pending;
3352 dbus_int32_t serial = -1;
3353 DBusDispatchStatus status;
3355 _dbus_return_val_if_fail (connection != NULL, FALSE);
3356 _dbus_return_val_if_fail (message != NULL, FALSE);
3357 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3360 *pending_return = NULL;
3362 CONNECTION_LOCK (connection);
3364 #ifdef HAVE_UNIX_FD_PASSING
3366 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3367 message->n_unix_fds > 0)
3369 /* Refuse to send fds on a connection that cannot handle
3370 them. Unfortunately we cannot return a proper error here, so
3371 the best we can do is return TRUE but leave *pending_return
3373 CONNECTION_UNLOCK (connection);
3379 if (!_dbus_connection_get_is_connected_unlocked (connection))
3381 CONNECTION_UNLOCK (connection);
3386 pending = _dbus_pending_call_new_unlocked (connection,
3387 timeout_milliseconds,
3388 reply_handler_timeout);
3390 if (pending == NULL)
3392 CONNECTION_UNLOCK (connection);
3396 /* Assign a serial to the message */
3397 serial = dbus_message_get_serial (message);
3400 serial = _dbus_connection_get_next_client_serial (connection);
3401 dbus_message_set_serial (message, serial);
3404 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3407 /* Insert the serial in the pending replies hash;
3408 * hash takes a refcount on DBusPendingCall.
3409 * Also, add the timeout.
3411 if (!_dbus_connection_attach_pending_call_unlocked (connection,
3415 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3417 _dbus_connection_detach_pending_call_and_unlock (connection,
3419 goto error_unlocked;
3423 *pending_return = pending; /* hand off refcount */
3426 _dbus_connection_detach_pending_call_unlocked (connection, pending);
3427 /* we still have a ref to the pending call in this case, we unref
3428 * after unlocking, below
3432 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3434 /* this calls out to user code */
3435 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3437 if (pending_return == NULL)
3438 dbus_pending_call_unref (pending);
3443 CONNECTION_UNLOCK (connection);
3445 dbus_pending_call_unref (pending);
3450 * Sends a message and blocks a certain time period while waiting for
3451 * a reply. This function does not reenter the main loop,
3452 * i.e. messages other than the reply are queued up but not
3453 * processed. This function is used to invoke method calls on a
3456 * If a normal reply is received, it is returned, and removed from the
3457 * incoming message queue. If it is not received, #NULL is returned
3458 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3459 * received, it is converted to a #DBusError and returned as an error,
3460 * then the reply message is deleted and #NULL is returned. If
3461 * something else goes wrong, result is set to whatever is
3462 * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3463 * #DBUS_ERROR_DISCONNECTED.
3465 * @warning While this function blocks the calling thread will not be
3466 * processing the incoming message queue. This means you can end up
3467 * deadlocked if the application you're talking to needs you to reply
3468 * to a method. To solve this, either avoid the situation, block in a
3469 * separate thread from the main connection-dispatching thread, or use
3470 * dbus_pending_call_set_notify() to avoid blocking.
3472 * @param connection the connection
3473 * @param message the message to send
3474 * @param timeout_milliseconds timeout in milliseconds, -1 (or
3475 * #DBUS_TIMEOUT_USE_DEFAULT) for default or #DBUS_TIMEOUT_INFINITE for no
3477 * @param error return location for error message
3478 * @returns the message that is the reply or #NULL with an error code if the
3482 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3483 DBusMessage *message,
3484 int timeout_milliseconds,
3488 DBusPendingCall *pending;
3490 _dbus_return_val_if_fail (connection != NULL, NULL);
3491 _dbus_return_val_if_fail (message != NULL, NULL);
3492 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3493 _dbus_return_val_if_error_is_set (error, NULL);
3495 #ifdef HAVE_UNIX_FD_PASSING
3497 CONNECTION_LOCK (connection);
3498 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3499 message->n_unix_fds > 0)
3501 CONNECTION_UNLOCK (connection);
3502 dbus_set_error(error, DBUS_ERROR_FAILED, "Cannot send file descriptors on this connection.");
3505 CONNECTION_UNLOCK (connection);
3509 if (!dbus_connection_send_with_reply (connection, message,
3510 &pending, timeout_milliseconds))
3512 _DBUS_SET_OOM (error);
3516 if (pending == NULL)
3518 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3522 dbus_pending_call_block (pending);
3524 reply = dbus_pending_call_steal_reply (pending);
3525 dbus_pending_call_unref (pending);
3527 /* call_complete_and_unlock() called from pending_call_block() should
3528 * always fill this in.
3530 _dbus_assert (reply != NULL);
3532 if (dbus_set_error_from_message (error, reply))
3534 dbus_message_unref (reply);
3542 * Blocks until the outgoing message queue is empty.
3543 * Assumes connection lock already held.
3545 * If you call this, you MUST call update_dispatch_status afterword...
3547 * @param connection the connection.
3549 static DBusDispatchStatus
3550 _dbus_connection_flush_unlocked (DBusConnection *connection)
3552 /* We have to specify DBUS_ITERATION_DO_READING here because
3553 * otherwise we could have two apps deadlock if they are both doing
3554 * a flush(), and the kernel buffers fill up. This could change the
3557 DBusDispatchStatus status;
3559 HAVE_LOCK_CHECK (connection);
3561 while (connection->n_outgoing > 0 &&
3562 _dbus_connection_get_is_connected_unlocked (connection))
3564 _dbus_verbose ("doing iteration in\n");
3565 HAVE_LOCK_CHECK (connection);
3566 _dbus_connection_do_iteration_unlocked (connection,
3568 DBUS_ITERATION_DO_READING |
3569 DBUS_ITERATION_DO_WRITING |
3570 DBUS_ITERATION_BLOCK,
3574 HAVE_LOCK_CHECK (connection);
3575 _dbus_verbose ("middle\n");
3576 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3578 HAVE_LOCK_CHECK (connection);
3583 * Blocks until the outgoing message queue is empty.
3585 * @param connection the connection.
3588 dbus_connection_flush (DBusConnection *connection)
3590 /* We have to specify DBUS_ITERATION_DO_READING here because
3591 * otherwise we could have two apps deadlock if they are both doing
3592 * a flush(), and the kernel buffers fill up. This could change the
3595 DBusDispatchStatus status;
3597 _dbus_return_if_fail (connection != NULL);
3599 CONNECTION_LOCK (connection);
3601 status = _dbus_connection_flush_unlocked (connection);
3603 HAVE_LOCK_CHECK (connection);
3604 /* Unlocks and calls out to user code */
3605 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3607 _dbus_verbose ("end\n");
3611 * This function implements dbus_connection_read_write_dispatch() and
3612 * dbus_connection_read_write() (they pass a different value for the
3613 * dispatch parameter).
3615 * @param connection the connection
3616 * @param timeout_milliseconds max time to block or -1 for infinite
3617 * @param dispatch dispatch new messages or leave them on the incoming queue
3618 * @returns #TRUE if the disconnect message has not been processed
3621 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3622 int timeout_milliseconds,
3623 dbus_bool_t dispatch)
3625 DBusDispatchStatus dstatus;
3626 dbus_bool_t progress_possible;
3628 /* Need to grab a ref here in case we're a private connection and
3629 * the user drops the last ref in a handler we call; see bug
3630 * https://bugs.freedesktop.org/show_bug.cgi?id=15635
3632 dbus_connection_ref (connection);
3633 dstatus = dbus_connection_get_dispatch_status (connection);
3635 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3637 _dbus_verbose ("doing dispatch\n");
3638 dbus_connection_dispatch (connection);
3639 CONNECTION_LOCK (connection);
3641 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3643 _dbus_verbose ("pausing for memory\n");
3644 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3645 CONNECTION_LOCK (connection);
3649 CONNECTION_LOCK (connection);
3650 if (_dbus_connection_get_is_connected_unlocked (connection))
3652 _dbus_verbose ("doing iteration\n");
3653 _dbus_connection_do_iteration_unlocked (connection,
3655 DBUS_ITERATION_DO_READING |
3656 DBUS_ITERATION_DO_WRITING |
3657 DBUS_ITERATION_BLOCK,
3658 timeout_milliseconds);
3662 HAVE_LOCK_CHECK (connection);
3663 /* If we can dispatch, we can make progress until the Disconnected message
3664 * has been processed; if we can only read/write, we can make progress
3665 * as long as the transport is open.
3668 progress_possible = connection->n_incoming != 0 ||
3669 connection->disconnect_message_link != NULL;
3671 progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3673 CONNECTION_UNLOCK (connection);
3675 dbus_connection_unref (connection);
3677 return progress_possible; /* TRUE if we can make more progress */
3682 * This function is intended for use with applications that don't want
3683 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3684 * example usage would be:
3687 * while (dbus_connection_read_write_dispatch (connection, -1))
3688 * ; // empty loop body
3691 * In this usage you would normally have set up a filter function to look
3692 * at each message as it is dispatched. The loop terminates when the last
3693 * message from the connection (the disconnected signal) is processed.
3695 * If there are messages to dispatch, this function will
3696 * dbus_connection_dispatch() once, and return. If there are no
3697 * messages to dispatch, this function will block until it can read or
3698 * write, then read or write, then return.
3700 * The way to think of this function is that it either makes some sort
3701 * of progress, or it blocks. Note that, while it is blocked on I/O, it
3702 * cannot be interrupted (even by other threads), which makes this function
3703 * unsuitable for applications that do more than just react to received
3706 * The return value indicates whether the disconnect message has been
3707 * processed, NOT whether the connection is connected. This is
3708 * important because even after disconnecting, you want to process any
3709 * messages you received prior to the disconnect.
3711 * @param connection the connection
3712 * @param timeout_milliseconds max time to block or -1 for infinite
3713 * @returns #TRUE if the disconnect message has not been processed
3716 dbus_connection_read_write_dispatch (DBusConnection *connection,
3717 int timeout_milliseconds)
3719 _dbus_return_val_if_fail (connection != NULL, FALSE);
3720 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3721 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3725 * This function is intended for use with applications that don't want to
3726 * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3727 * dbus_connection_read_write_dispatch().
3729 * As long as the connection is open, this function will block until it can
3730 * read or write, then read or write, then return #TRUE.
3732 * If the connection is closed, the function returns #FALSE.
3734 * The return value indicates whether reading or writing is still
3735 * possible, i.e. whether the connection is connected.
3737 * Note that even after disconnection, messages may remain in the
3738 * incoming queue that need to be
3739 * processed. dbus_connection_read_write_dispatch() dispatches
3740 * incoming messages for you; with dbus_connection_read_write() you
3741 * have to arrange to drain the incoming queue yourself.
3743 * @param connection the connection
3744 * @param timeout_milliseconds max time to block or -1 for infinite
3745 * @returns #TRUE if still connected
3748 dbus_connection_read_write (DBusConnection *connection,
3749 int timeout_milliseconds)
3751 _dbus_return_val_if_fail (connection != NULL, FALSE);
3752 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3753 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3756 /* We need to call this anytime we pop the head of the queue, and then
3757 * update_dispatch_status_and_unlock needs to be called afterward
3758 * which will "process" the disconnected message and set
3759 * disconnected_message_processed.
3762 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3763 DBusMessage *head_of_queue)
3765 HAVE_LOCK_CHECK (connection);
3767 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3768 if (connection->disconnect_message_link == NULL &&
3769 dbus_message_is_signal (head_of_queue,
3770 DBUS_INTERFACE_LOCAL,
3773 connection->disconnected_message_arrived = TRUE;
3778 * Returns the first-received message from the incoming message queue,
3779 * leaving it in the queue. If the queue is empty, returns #NULL.
3781 * The caller does not own a reference to the returned message, and
3782 * must either return it using dbus_connection_return_message() or
3783 * keep it after calling dbus_connection_steal_borrowed_message(). No
3784 * one can get at the message while its borrowed, so return it as
3785 * quickly as possible and don't keep a reference to it after
3786 * returning it. If you need to keep the message, make a copy of it.
3788 * dbus_connection_dispatch() will block if called while a borrowed
3789 * message is outstanding; only one piece of code can be playing with
3790 * the incoming queue at a time. This function will block if called
3791 * during a dbus_connection_dispatch().
3793 * @param connection the connection.
3794 * @returns next message in the incoming queue.
3797 dbus_connection_borrow_message (DBusConnection *connection)
3799 DBusDispatchStatus status;
3800 DBusMessage *message;
3802 _dbus_return_val_if_fail (connection != NULL, NULL);
3804 _dbus_verbose ("start\n");
3806 /* this is called for the side effect that it queues
3807 * up any messages from the transport
3809 status = dbus_connection_get_dispatch_status (connection);
3810 if (status != DBUS_DISPATCH_DATA_REMAINS)
3813 CONNECTION_LOCK (connection);
3815 _dbus_connection_acquire_dispatch (connection);
3817 /* While a message is outstanding, the dispatch lock is held */
3818 _dbus_assert (connection->message_borrowed == NULL);
3820 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3822 message = connection->message_borrowed;
3824 check_disconnected_message_arrived_unlocked (connection, message);
3826 /* Note that we KEEP the dispatch lock until the message is returned */
3827 if (message == NULL)
3828 _dbus_connection_release_dispatch (connection);
3830 CONNECTION_UNLOCK (connection);
3832 /* We don't update dispatch status until it's returned or stolen */
3838 * Used to return a message after peeking at it using
3839 * dbus_connection_borrow_message(). Only called if
3840 * message from dbus_connection_borrow_message() was non-#NULL.
3842 * @param connection the connection
3843 * @param message the message from dbus_connection_borrow_message()
3846 dbus_connection_return_message (DBusConnection *connection,
3847 DBusMessage *message)
3849 DBusDispatchStatus status;
3851 _dbus_return_if_fail (connection != NULL);
3852 _dbus_return_if_fail (message != NULL);
3853 _dbus_return_if_fail (message == connection->message_borrowed);
3854 _dbus_return_if_fail (connection->dispatch_acquired);
3856 CONNECTION_LOCK (connection);
3858 _dbus_assert (message == connection->message_borrowed);
3860 connection->message_borrowed = NULL;
3862 _dbus_connection_release_dispatch (connection);
3864 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3865 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3869 * Used to keep a message after peeking at it using
3870 * dbus_connection_borrow_message(). Before using this function, see
3871 * the caveats/warnings in the documentation for
3872 * dbus_connection_pop_message().
3874 * @param connection the connection
3875 * @param message the message from dbus_connection_borrow_message()
3878 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3879 DBusMessage *message)
3881 DBusMessage *pop_message;
3882 DBusDispatchStatus status;
3884 _dbus_return_if_fail (connection != NULL);
3885 _dbus_return_if_fail (message != NULL);
3886 _dbus_return_if_fail (message == connection->message_borrowed);
3887 _dbus_return_if_fail (connection->dispatch_acquired);
3889 CONNECTION_LOCK (connection);
3891 _dbus_assert (message == connection->message_borrowed);
3893 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3894 _dbus_assert (message == pop_message);
3896 connection->n_incoming -= 1;
3898 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3899 message, connection->n_incoming);
3901 connection->message_borrowed = NULL;
3903 _dbus_connection_release_dispatch (connection);
3905 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3906 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3909 /* See dbus_connection_pop_message, but requires the caller to own
3910 * the lock before calling. May drop the lock while running.
3913 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3915 HAVE_LOCK_CHECK (connection);
3917 _dbus_assert (connection->message_borrowed == NULL);
3919 if (connection->n_incoming > 0)
3923 link = _dbus_list_pop_first_link (&connection->incoming_messages);
3924 connection->n_incoming -= 1;
3926 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from incoming queue %p, %d incoming\n",
3928 dbus_message_type_to_string (dbus_message_get_type (link->data)),
3929 dbus_message_get_path (link->data) ?
3930 dbus_message_get_path (link->data) :
3932 dbus_message_get_interface (link->data) ?
3933 dbus_message_get_interface (link->data) :
3935 dbus_message_get_member (link->data) ?
3936 dbus_message_get_member (link->data) :
3938 dbus_message_get_signature (link->data),
3939 connection, connection->n_incoming);
3941 check_disconnected_message_arrived_unlocked (connection, link->data);
3949 /* See dbus_connection_pop_message, but requires the caller to own
3950 * the lock before calling. May drop the lock while running.
3953 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3957 HAVE_LOCK_CHECK (connection);
3959 link = _dbus_connection_pop_message_link_unlocked (connection);
3963 DBusMessage *message;
3965 message = link->data;
3967 _dbus_list_free_link (link);
3976 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
3977 DBusList *message_link)
3979 HAVE_LOCK_CHECK (connection);
3981 _dbus_assert (message_link != NULL);
3982 /* You can't borrow a message while a link is outstanding */
3983 _dbus_assert (connection->message_borrowed == NULL);
3984 /* We had to have the dispatch lock across the pop/putback */
3985 _dbus_assert (connection->dispatch_acquired);
3987 _dbus_list_prepend_link (&connection->incoming_messages,
3989 connection->n_incoming += 1;
3991 _dbus_verbose ("Message %p (%s %s %s '%s') put back into queue %p, %d incoming\n",
3993 dbus_message_type_to_string (dbus_message_get_type (message_link->data)),
3994 dbus_message_get_interface (message_link->data) ?
3995 dbus_message_get_interface (message_link->data) :
3997 dbus_message_get_member (message_link->data) ?
3998 dbus_message_get_member (message_link->data) :
4000 dbus_message_get_signature (message_link->data),
4001 connection, connection->n_incoming);
4005 * Returns the first-received message from the incoming message queue,
4006 * removing it from the queue. The caller owns a reference to the
4007 * returned message. If the queue is empty, returns #NULL.
4009 * This function bypasses any message handlers that are registered,
4010 * and so using it is usually wrong. Instead, let the main loop invoke
4011 * dbus_connection_dispatch(). Popping messages manually is only
4012 * useful in very simple programs that don't share a #DBusConnection
4013 * with any libraries or other modules.
4015 * There is a lock that covers all ways of accessing the incoming message
4016 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
4017 * dbus_connection_borrow_message(), etc. will all block while one of the others
4018 * in the group is running.
4020 * @param connection the connection.
4021 * @returns next message in the incoming queue.
4024 dbus_connection_pop_message (DBusConnection *connection)
4026 DBusMessage *message;
4027 DBusDispatchStatus status;
4029 _dbus_verbose ("start\n");
4031 /* this is called for the side effect that it queues
4032 * up any messages from the transport
4034 status = dbus_connection_get_dispatch_status (connection);
4035 if (status != DBUS_DISPATCH_DATA_REMAINS)
4038 CONNECTION_LOCK (connection);
4039 _dbus_connection_acquire_dispatch (connection);
4040 HAVE_LOCK_CHECK (connection);
4042 message = _dbus_connection_pop_message_unlocked (connection);
4044 _dbus_verbose ("Returning popped message %p\n", message);
4046 _dbus_connection_release_dispatch (connection);
4048 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4049 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4055 * Acquire the dispatcher. This is a separate lock so the main
4056 * connection lock can be dropped to call out to application dispatch
4059 * @param connection the connection.
4062 _dbus_connection_acquire_dispatch (DBusConnection *connection)
4064 HAVE_LOCK_CHECK (connection);
4066 _dbus_connection_ref_unlocked (connection);
4067 CONNECTION_UNLOCK (connection);
4069 _dbus_verbose ("locking dispatch_mutex\n");
4070 _dbus_mutex_lock (connection->dispatch_mutex);
4072 while (connection->dispatch_acquired)
4074 _dbus_verbose ("waiting for dispatch to be acquirable\n");
4075 _dbus_condvar_wait (connection->dispatch_cond,
4076 connection->dispatch_mutex);
4079 _dbus_assert (!connection->dispatch_acquired);
4081 connection->dispatch_acquired = TRUE;
4083 _dbus_verbose ("unlocking dispatch_mutex\n");
4084 _dbus_mutex_unlock (connection->dispatch_mutex);
4086 CONNECTION_LOCK (connection);
4087 _dbus_connection_unref_unlocked (connection);
4091 * Release the dispatcher when you're done with it. Only call
4092 * after you've acquired the dispatcher. Wakes up at most one
4093 * thread currently waiting to acquire the dispatcher.
4095 * @param connection the connection.
4098 _dbus_connection_release_dispatch (DBusConnection *connection)
4100 HAVE_LOCK_CHECK (connection);
4102 _dbus_verbose ("locking dispatch_mutex\n");
4103 _dbus_mutex_lock (connection->dispatch_mutex);
4105 _dbus_assert (connection->dispatch_acquired);
4107 connection->dispatch_acquired = FALSE;
4108 _dbus_condvar_wake_one (connection->dispatch_cond);
4110 _dbus_verbose ("unlocking dispatch_mutex\n");
4111 _dbus_mutex_unlock (connection->dispatch_mutex);
4115 _dbus_connection_failed_pop (DBusConnection *connection,
4116 DBusList *message_link)
4118 _dbus_list_prepend_link (&connection->incoming_messages,
4120 connection->n_incoming += 1;
4123 /* Note this may be called multiple times since we don't track whether we already did it */
4125 notify_disconnected_unlocked (DBusConnection *connection)
4127 HAVE_LOCK_CHECK (connection);
4129 /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
4130 * connection from dbus_bus_get(). We make the same guarantee for
4131 * dbus_connection_open() but in a different way since we don't want to
4132 * unref right here; we instead check for connectedness before returning
4133 * the connection from the hash.
4135 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
4137 /* Dump the outgoing queue, we aren't going to be able to
4138 * send it now, and we'd like accessors like
4139 * dbus_connection_get_outgoing_size() to be accurate.
4141 if (connection->n_outgoing > 0)
4145 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
4146 connection->n_outgoing);
4148 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
4150 _dbus_connection_message_sent (connection, link->data);
4155 /* Note this may be called multiple times since we don't track whether we already did it */
4156 static DBusDispatchStatus
4157 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
4159 HAVE_LOCK_CHECK (connection);
4161 if (connection->disconnect_message_link != NULL)
4163 _dbus_verbose ("Sending disconnect message\n");
4165 /* If we have pending calls, queue their timeouts - we want the Disconnected
4166 * to be the last message, after these timeouts.
4168 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
4170 /* We haven't sent the disconnect message already,
4171 * and all real messages have been queued up.
4173 _dbus_connection_queue_synthesized_message_link (connection,
4174 connection->disconnect_message_link);
4175 connection->disconnect_message_link = NULL;
4177 return DBUS_DISPATCH_DATA_REMAINS;
4180 return DBUS_DISPATCH_COMPLETE;
4183 static DBusDispatchStatus
4184 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
4186 HAVE_LOCK_CHECK (connection);
4188 if (connection->n_incoming > 0)
4189 return DBUS_DISPATCH_DATA_REMAINS;
4190 else if (!_dbus_transport_queue_messages (connection->transport))
4191 return DBUS_DISPATCH_NEED_MEMORY;
4194 DBusDispatchStatus status;
4195 dbus_bool_t is_connected;
4197 status = _dbus_transport_get_dispatch_status (connection->transport);
4198 is_connected = _dbus_transport_get_is_connected (connection->transport);
4200 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
4201 DISPATCH_STATUS_NAME (status), is_connected);
4205 /* It's possible this would be better done by having an explicit
4206 * notification from _dbus_transport_disconnect() that would
4207 * synchronously do this, instead of waiting for the next dispatch
4208 * status check. However, probably not good to change until it causes
4211 notify_disconnected_unlocked (connection);
4213 /* I'm not sure this is needed; the idea is that we want to
4214 * queue the Disconnected only after we've read all the
4215 * messages, but if we're disconnected maybe we are guaranteed
4216 * to have read them all ?
4218 if (status == DBUS_DISPATCH_COMPLETE)
4219 status = notify_disconnected_and_dispatch_complete_unlocked (connection);
4222 if (status != DBUS_DISPATCH_COMPLETE)
4224 else if (connection->n_incoming > 0)
4225 return DBUS_DISPATCH_DATA_REMAINS;
4227 return DBUS_DISPATCH_COMPLETE;
4232 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
4233 DBusDispatchStatus new_status)
4235 dbus_bool_t changed;
4236 DBusDispatchStatusFunction function;
4239 HAVE_LOCK_CHECK (connection);
4241 _dbus_connection_ref_unlocked (connection);
4243 changed = new_status != connection->last_dispatch_status;
4245 connection->last_dispatch_status = new_status;
4247 function = connection->dispatch_status_function;
4248 data = connection->dispatch_status_data;
4250 if (connection->disconnected_message_arrived &&
4251 !connection->disconnected_message_processed)
4253 connection->disconnected_message_processed = TRUE;
4255 /* this does an unref, but we have a ref
4256 * so we should not run the finalizer here
4259 connection_forget_shared_unlocked (connection);
4261 if (connection->exit_on_disconnect)
4263 CONNECTION_UNLOCK (connection);
4265 _dbus_verbose ("Exiting on Disconnected signal\n");
4267 _dbus_assert_not_reached ("Call to exit() returned");
4271 /* We drop the lock */
4272 CONNECTION_UNLOCK (connection);
4274 if (changed && function)
4276 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
4277 connection, new_status,
4278 DISPATCH_STATUS_NAME (new_status));
4279 (* function) (connection, new_status, data);
4282 dbus_connection_unref (connection);
4286 * Gets the current state of the incoming message queue.
4287 * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
4288 * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
4289 * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
4290 * there could be data, but we can't know for sure without more
4293 * To process the incoming message queue, use dbus_connection_dispatch()
4294 * or (in rare cases) dbus_connection_pop_message().
4296 * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
4297 * have messages in the queue, or we have raw bytes buffered up
4298 * that need to be parsed. When these bytes are parsed, they
4299 * may not add up to an entire message. Thus, it's possible
4300 * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
4301 * have a message yet.
4303 * In particular this happens on initial connection, because all sorts
4304 * of authentication protocol stuff has to be parsed before the
4305 * first message arrives.
4307 * @param connection the connection.
4308 * @returns current dispatch status
4311 dbus_connection_get_dispatch_status (DBusConnection *connection)
4313 DBusDispatchStatus status;
4315 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4317 _dbus_verbose ("start\n");
4319 CONNECTION_LOCK (connection);
4321 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4323 CONNECTION_UNLOCK (connection);
4329 * Filter funtion for handling the Peer standard interface.
4331 static DBusHandlerResult
4332 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
4333 DBusMessage *message)
4335 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
4337 /* This means we're letting the bus route this message */
4338 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4340 else if (dbus_message_is_method_call (message,
4341 DBUS_INTERFACE_PEER,
4347 ret = dbus_message_new_method_return (message);
4349 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4351 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4353 dbus_message_unref (ret);
4356 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4358 return DBUS_HANDLER_RESULT_HANDLED;
4360 else if (dbus_message_is_method_call (message,
4361 DBUS_INTERFACE_PEER,
4368 ret = dbus_message_new_method_return (message);
4370 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4373 _dbus_string_init (&uuid);
4374 if (_dbus_get_local_machine_uuid_encoded (&uuid))
4376 const char *v_STRING = _dbus_string_get_const_data (&uuid);
4377 if (dbus_message_append_args (ret,
4378 DBUS_TYPE_STRING, &v_STRING,
4381 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4384 _dbus_string_free (&uuid);
4386 dbus_message_unref (ret);
4389 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4391 return DBUS_HANDLER_RESULT_HANDLED;
4393 else if (dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4395 /* We need to bounce anything else with this interface, otherwise apps
4396 * could start extending the interface and when we added extensions
4397 * here to DBusConnection we'd break those apps.
4403 ret = dbus_message_new_error (message,
4404 DBUS_ERROR_UNKNOWN_METHOD,
4405 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4407 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4409 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4411 dbus_message_unref (ret);
4414 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4416 return DBUS_HANDLER_RESULT_HANDLED;
4420 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4425 * Processes all builtin filter functions
4427 * If the spec specifies a standard interface
4428 * they should be processed from this method
4430 static DBusHandlerResult
4431 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4432 DBusMessage *message)
4434 /* We just run one filter for now but have the option to run more
4435 if the spec calls for it in the future */
4437 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4441 * Processes any incoming data.
4443 * If there's incoming raw data that has not yet been parsed, it is
4444 * parsed, which may or may not result in adding messages to the
4447 * The incoming data buffer is filled when the connection reads from
4448 * its underlying transport (such as a socket). Reading usually
4449 * happens in dbus_watch_handle() or dbus_connection_read_write().
4451 * If there are complete messages in the incoming queue,
4452 * dbus_connection_dispatch() removes one message from the queue and
4453 * processes it. Processing has three steps.
4455 * First, any method replies are passed to #DBusPendingCall or
4456 * dbus_connection_send_with_reply_and_block() in order to
4457 * complete the pending method call.
4459 * Second, any filters registered with dbus_connection_add_filter()
4460 * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4461 * then processing stops after that filter.
4463 * Third, if the message is a method call it is forwarded to
4464 * any registered object path handlers added with
4465 * dbus_connection_register_object_path() or
4466 * dbus_connection_register_fallback().
4468 * A single call to dbus_connection_dispatch() will process at most
4469 * one message; it will not clear the entire message queue.
4471 * Be careful about calling dbus_connection_dispatch() from inside a
4472 * message handler, i.e. calling dbus_connection_dispatch()
4473 * recursively. If threads have been initialized with a recursive
4474 * mutex function, then this will not deadlock; however, it can
4475 * certainly confuse your application.
4477 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4479 * @param connection the connection
4480 * @returns dispatch status, see dbus_connection_get_dispatch_status()
4483 dbus_connection_dispatch (DBusConnection *connection)
4485 DBusMessage *message;
4486 DBusList *link, *filter_list_copy, *message_link;
4487 DBusHandlerResult result;
4488 DBusPendingCall *pending;
4489 dbus_int32_t reply_serial;
4490 DBusDispatchStatus status;
4492 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4494 _dbus_verbose ("\n");
4496 CONNECTION_LOCK (connection);
4497 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4498 if (status != DBUS_DISPATCH_DATA_REMAINS)
4500 /* unlocks and calls out to user code */
4501 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4505 /* We need to ref the connection since the callback could potentially
4506 * drop the last ref to it
4508 _dbus_connection_ref_unlocked (connection);
4510 _dbus_connection_acquire_dispatch (connection);
4511 HAVE_LOCK_CHECK (connection);
4513 message_link = _dbus_connection_pop_message_link_unlocked (connection);
4514 if (message_link == NULL)
4516 /* another thread dispatched our stuff */
4518 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4520 _dbus_connection_release_dispatch (connection);
4522 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4524 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4526 dbus_connection_unref (connection);
4531 message = message_link->data;
4533 _dbus_verbose (" dispatching message %p (%s %s %s '%s')\n",
4535 dbus_message_type_to_string (dbus_message_get_type (message)),
4536 dbus_message_get_interface (message) ?
4537 dbus_message_get_interface (message) :
4539 dbus_message_get_member (message) ?
4540 dbus_message_get_member (message) :
4542 dbus_message_get_signature (message));
4544 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4546 /* Pending call handling must be first, because if you do
4547 * dbus_connection_send_with_reply_and_block() or
4548 * dbus_pending_call_block() then no handlers/filters will be run on
4549 * the reply. We want consistent semantics in the case where we
4550 * dbus_connection_dispatch() the reply.
4553 reply_serial = dbus_message_get_reply_serial (message);
4554 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4558 _dbus_verbose ("Dispatching a pending reply\n");
4559 complete_pending_call_and_unlock (connection, pending, message);
4560 pending = NULL; /* it's probably unref'd */
4562 CONNECTION_LOCK (connection);
4563 _dbus_verbose ("pending call completed in dispatch\n");
4564 result = DBUS_HANDLER_RESULT_HANDLED;
4568 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4569 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4572 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4574 _dbus_connection_release_dispatch (connection);
4575 HAVE_LOCK_CHECK (connection);
4577 _dbus_connection_failed_pop (connection, message_link);
4579 /* unlocks and calls user code */
4580 _dbus_connection_update_dispatch_status_and_unlock (connection,
4581 DBUS_DISPATCH_NEED_MEMORY);
4582 dbus_connection_unref (connection);
4584 return DBUS_DISPATCH_NEED_MEMORY;
4587 _dbus_list_foreach (&filter_list_copy,
4588 (DBusForeachFunction)_dbus_message_filter_ref,
4591 /* We're still protected from dispatch() reentrancy here
4592 * since we acquired the dispatcher
4594 CONNECTION_UNLOCK (connection);
4596 link = _dbus_list_get_first_link (&filter_list_copy);
4597 while (link != NULL)
4599 DBusMessageFilter *filter = link->data;
4600 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4602 if (filter->function == NULL)
4604 _dbus_verbose (" filter was removed in a callback function\n");
4609 _dbus_verbose (" running filter on message %p\n", message);
4610 result = (* filter->function) (connection, message, filter->user_data);
4612 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4618 _dbus_list_foreach (&filter_list_copy,
4619 (DBusForeachFunction)_dbus_message_filter_unref,
4621 _dbus_list_clear (&filter_list_copy);
4623 CONNECTION_LOCK (connection);
4625 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4627 _dbus_verbose ("No memory\n");
4630 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4632 _dbus_verbose ("filter handled message in dispatch\n");
4636 /* We're still protected from dispatch() reentrancy here
4637 * since we acquired the dispatcher
4639 _dbus_verbose (" running object path dispatch on message %p (%s %s %s '%s')\n",
4641 dbus_message_type_to_string (dbus_message_get_type (message)),
4642 dbus_message_get_interface (message) ?
4643 dbus_message_get_interface (message) :
4645 dbus_message_get_member (message) ?
4646 dbus_message_get_member (message) :
4648 dbus_message_get_signature (message));
4650 HAVE_LOCK_CHECK (connection);
4651 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4654 CONNECTION_LOCK (connection);
4656 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4658 _dbus_verbose ("object tree handled message in dispatch\n");
4662 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4666 DBusPreallocatedSend *preallocated;
4668 _dbus_verbose (" sending error %s\n",
4669 DBUS_ERROR_UNKNOWN_METHOD);
4671 if (!_dbus_string_init (&str))
4673 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4674 _dbus_verbose ("no memory for error string in dispatch\n");
4678 if (!_dbus_string_append_printf (&str,
4679 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4680 dbus_message_get_member (message),
4681 dbus_message_get_signature (message),
4682 dbus_message_get_interface (message)))
4684 _dbus_string_free (&str);
4685 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4686 _dbus_verbose ("no memory for error string in dispatch\n");
4690 reply = dbus_message_new_error (message,
4691 DBUS_ERROR_UNKNOWN_METHOD,
4692 _dbus_string_get_const_data (&str));
4693 _dbus_string_free (&str);
4697 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4698 _dbus_verbose ("no memory for error reply in dispatch\n");
4702 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4704 if (preallocated == NULL)
4706 dbus_message_unref (reply);
4707 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4708 _dbus_verbose ("no memory for error send in dispatch\n");
4712 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4715 dbus_message_unref (reply);
4717 result = DBUS_HANDLER_RESULT_HANDLED;
4720 _dbus_verbose (" done dispatching %p (%s %s %s '%s') on connection %p\n", message,
4721 dbus_message_type_to_string (dbus_message_get_type (message)),
4722 dbus_message_get_interface (message) ?
4723 dbus_message_get_interface (message) :
4725 dbus_message_get_member (message) ?
4726 dbus_message_get_member (message) :
4728 dbus_message_get_signature (message),
4732 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4734 _dbus_verbose ("out of memory\n");
4736 /* Put message back, and we'll start over.
4737 * Yes this means handlers must be idempotent if they
4738 * don't return HANDLED; c'est la vie.
4740 _dbus_connection_putback_message_link_unlocked (connection,
4745 _dbus_verbose (" ... done dispatching\n");
4747 _dbus_list_free_link (message_link);
4748 dbus_message_unref (message); /* don't want the message to count in max message limits
4749 * in computing dispatch status below
4753 _dbus_connection_release_dispatch (connection);
4754 HAVE_LOCK_CHECK (connection);
4756 _dbus_verbose ("before final status update\n");
4757 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4759 /* unlocks and calls user code */
4760 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4762 dbus_connection_unref (connection);
4768 * Sets the watch functions for the connection. These functions are
4769 * responsible for making the application's main loop aware of file
4770 * descriptors that need to be monitored for events, using select() or
4771 * poll(). When using Qt, typically the DBusAddWatchFunction would
4772 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4773 * could call g_io_add_watch(), or could be used as part of a more
4774 * elaborate GSource. Note that when a watch is added, it may
4777 * The DBusWatchToggledFunction notifies the application that the
4778 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4779 * to check this. A disabled watch should have no effect, and enabled
4780 * watch should be added to the main loop. This feature is used
4781 * instead of simply adding/removing the watch because
4782 * enabling/disabling can be done without memory allocation. The
4783 * toggled function may be NULL if a main loop re-queries
4784 * dbus_watch_get_enabled() every time anyway.
4786 * The DBusWatch can be queried for the file descriptor to watch using
4787 * dbus_watch_get_unix_fd() or dbus_watch_get_socket(), and for the
4788 * events to watch for using dbus_watch_get_flags(). The flags
4789 * returned by dbus_watch_get_flags() will only contain
4790 * DBUS_WATCH_READABLE and DBUS_WATCH_WRITABLE, never
4791 * DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR; all watches implicitly
4792 * include a watch for hangups, errors, and other exceptional
4795 * Once a file descriptor becomes readable or writable, or an exception
4796 * occurs, dbus_watch_handle() should be called to
4797 * notify the connection of the file descriptor's condition.
4799 * dbus_watch_handle() cannot be called during the
4800 * DBusAddWatchFunction, as the connection will not be ready to handle
4803 * It is not allowed to reference a DBusWatch after it has been passed
4804 * to remove_function.
4806 * If #FALSE is returned due to lack of memory, the failure may be due
4807 * to a #FALSE return from the new add_function. If so, the
4808 * add_function may have been called successfully one or more times,
4809 * but the remove_function will also have been called to remove any
4810 * successful adds. i.e. if #FALSE is returned the net result
4811 * should be that dbus_connection_set_watch_functions() has no effect,
4812 * but the add_function and remove_function may have been called.
4814 * @note The thread lock on DBusConnection is held while
4815 * watch functions are invoked, so inside these functions you
4816 * may not invoke any methods on DBusConnection or it will deadlock.
4817 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/tread.html#8144
4818 * if you encounter this issue and want to attempt writing a patch.
4820 * @param connection the connection.
4821 * @param add_function function to begin monitoring a new descriptor.
4822 * @param remove_function function to stop monitoring a descriptor.
4823 * @param toggled_function function to notify of enable/disable
4824 * @param data data to pass to add_function and remove_function.
4825 * @param free_data_function function to be called to free the data.
4826 * @returns #FALSE on failure (no memory)
4829 dbus_connection_set_watch_functions (DBusConnection *connection,
4830 DBusAddWatchFunction add_function,
4831 DBusRemoveWatchFunction remove_function,
4832 DBusWatchToggledFunction toggled_function,
4834 DBusFreeFunction free_data_function)
4838 _dbus_return_val_if_fail (connection != NULL, FALSE);
4840 CONNECTION_LOCK (connection);
4842 retval = _dbus_watch_list_set_functions (connection->watches,
4843 add_function, remove_function,
4845 data, free_data_function);
4847 CONNECTION_UNLOCK (connection);
4853 * Sets the timeout functions for the connection. These functions are
4854 * responsible for making the application's main loop aware of timeouts.
4855 * When using Qt, typically the DBusAddTimeoutFunction would create a
4856 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4859 * The DBusTimeoutToggledFunction notifies the application that the
4860 * timeout has been enabled or disabled. Call
4861 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4862 * have no effect, and enabled timeout should be added to the main
4863 * loop. This feature is used instead of simply adding/removing the
4864 * timeout because enabling/disabling can be done without memory
4865 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4866 * to enable and disable. The toggled function may be NULL if a main
4867 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4868 * Whenever a timeout is toggled, its interval may change.
4870 * The DBusTimeout can be queried for the timer interval using
4871 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4872 * repeatedly, each time the interval elapses, starting after it has
4873 * elapsed once. The timeout stops firing when it is removed with the
4874 * given remove_function. The timer interval may change whenever the
4875 * timeout is added, removed, or toggled.
4877 * @note The thread lock on DBusConnection is held while
4878 * timeout functions are invoked, so inside these functions you
4879 * may not invoke any methods on DBusConnection or it will deadlock.
4880 * See the comments in the code or http://lists.freedesktop.org/archives/dbus/2007-July/thread.html#8144
4881 * if you encounter this issue and want to attempt writing a patch.
4883 * @param connection the connection.
4884 * @param add_function function to add a timeout.
4885 * @param remove_function function to remove a timeout.
4886 * @param toggled_function function to notify of enable/disable
4887 * @param data data to pass to add_function and remove_function.
4888 * @param free_data_function function to be called to free the data.
4889 * @returns #FALSE on failure (no memory)
4892 dbus_connection_set_timeout_functions (DBusConnection *connection,
4893 DBusAddTimeoutFunction add_function,
4894 DBusRemoveTimeoutFunction remove_function,
4895 DBusTimeoutToggledFunction toggled_function,
4897 DBusFreeFunction free_data_function)
4901 _dbus_return_val_if_fail (connection != NULL, FALSE);
4903 CONNECTION_LOCK (connection);
4905 retval = _dbus_timeout_list_set_functions (connection->timeouts,
4906 add_function, remove_function,
4908 data, free_data_function);
4910 CONNECTION_UNLOCK (connection);
4916 * Sets the mainloop wakeup function for the connection. This function
4917 * is responsible for waking up the main loop (if its sleeping in
4918 * another thread) when some some change has happened to the
4919 * connection that the mainloop needs to reconsider (e.g. a message
4920 * has been queued for writing). When using Qt, this typically
4921 * results in a call to QEventLoop::wakeUp(). When using GLib, it
4922 * would call g_main_context_wakeup().
4924 * @param connection the connection.
4925 * @param wakeup_main_function function to wake up the mainloop
4926 * @param data data to pass wakeup_main_function
4927 * @param free_data_function function to be called to free the data.
4930 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
4931 DBusWakeupMainFunction wakeup_main_function,
4933 DBusFreeFunction free_data_function)
4936 DBusFreeFunction old_free_data;
4938 _dbus_return_if_fail (connection != NULL);
4940 CONNECTION_LOCK (connection);
4941 old_data = connection->wakeup_main_data;
4942 old_free_data = connection->free_wakeup_main_data;
4944 connection->wakeup_main_function = wakeup_main_function;
4945 connection->wakeup_main_data = data;
4946 connection->free_wakeup_main_data = free_data_function;
4948 CONNECTION_UNLOCK (connection);
4950 /* Callback outside the lock */
4952 (*old_free_data) (old_data);
4956 * Set a function to be invoked when the dispatch status changes.
4957 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
4958 * dbus_connection_dispatch() needs to be called to process incoming
4959 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
4960 * from inside the DBusDispatchStatusFunction. Indeed, almost
4961 * any reentrancy in this function is a bad idea. Instead,
4962 * the DBusDispatchStatusFunction should simply save an indication
4963 * that messages should be dispatched later, when the main loop
4966 * If you don't set a dispatch status function, you have to be sure to
4967 * dispatch on every iteration of your main loop, especially if
4968 * dbus_watch_handle() or dbus_timeout_handle() were called.
4970 * @param connection the connection
4971 * @param function function to call on dispatch status changes
4972 * @param data data for function
4973 * @param free_data_function free the function data
4976 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
4977 DBusDispatchStatusFunction function,
4979 DBusFreeFunction free_data_function)
4982 DBusFreeFunction old_free_data;
4984 _dbus_return_if_fail (connection != NULL);
4986 CONNECTION_LOCK (connection);
4987 old_data = connection->dispatch_status_data;
4988 old_free_data = connection->free_dispatch_status_data;
4990 connection->dispatch_status_function = function;
4991 connection->dispatch_status_data = data;
4992 connection->free_dispatch_status_data = free_data_function;
4994 CONNECTION_UNLOCK (connection);
4996 /* Callback outside the lock */
4998 (*old_free_data) (old_data);
5002 * Get the UNIX file descriptor of the connection, if any. This can
5003 * be used for SELinux access control checks with getpeercon() for
5004 * example. DO NOT read or write to the file descriptor, or try to
5005 * select() on it; use DBusWatch for main loop integration. Not all
5006 * connections will have a file descriptor. So for adding descriptors
5007 * to the main loop, use dbus_watch_get_unix_fd() and so forth.
5009 * If the connection is socket-based, you can also use
5010 * dbus_connection_get_socket(), which will work on Windows too.
5011 * This function always fails on Windows.
5013 * Right now the returned descriptor is always a socket, but
5014 * that is not guaranteed.
5016 * @param connection the connection
5017 * @param fd return location for the file descriptor.
5018 * @returns #TRUE if fd is successfully obtained.
5021 dbus_connection_get_unix_fd (DBusConnection *connection,
5024 _dbus_return_val_if_fail (connection != NULL, FALSE);
5025 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5028 /* FIXME do this on a lower level */
5032 return dbus_connection_get_socket(connection, fd);
5036 * Gets the underlying Windows or UNIX socket file descriptor
5037 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
5038 * select() on it; use DBusWatch for main loop integration. Not all
5039 * connections will have a socket. So for adding descriptors
5040 * to the main loop, use dbus_watch_get_socket() and so forth.
5042 * If the connection is not socket-based, this function will return FALSE,
5043 * even if the connection does have a file descriptor of some kind.
5044 * i.e. this function always returns specifically a socket file descriptor.
5046 * @param connection the connection
5047 * @param fd return location for the file descriptor.
5048 * @returns #TRUE if fd is successfully obtained.
5051 dbus_connection_get_socket(DBusConnection *connection,
5056 _dbus_return_val_if_fail (connection != NULL, FALSE);
5057 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5059 CONNECTION_LOCK (connection);
5061 retval = _dbus_transport_get_socket_fd (connection->transport,
5064 CONNECTION_UNLOCK (connection);
5071 * Gets the UNIX user ID of the connection if known. Returns #TRUE if
5072 * the uid is filled in. Always returns #FALSE on non-UNIX platforms
5073 * for now, though in theory someone could hook Windows to NIS or
5074 * something. Always returns #FALSE prior to authenticating the
5077 * The UID is only read by servers from clients; clients can't usually
5078 * get the UID of servers, because servers do not authenticate to
5079 * clients. The returned UID is the UID the connection authenticated
5082 * The message bus is a server and the apps connecting to the bus
5085 * You can ask the bus to tell you the UID of another connection though
5086 * if you like; this is done with dbus_bus_get_unix_user().
5088 * @param connection the connection
5089 * @param uid return location for the user ID
5090 * @returns #TRUE if uid is filled in with a valid user ID
5093 dbus_connection_get_unix_user (DBusConnection *connection,
5098 _dbus_return_val_if_fail (connection != NULL, FALSE);
5099 _dbus_return_val_if_fail (uid != NULL, FALSE);
5101 CONNECTION_LOCK (connection);
5103 if (!_dbus_transport_get_is_authenticated (connection->transport))
5106 result = _dbus_transport_get_unix_user (connection->transport,
5110 _dbus_assert (!result);
5113 CONNECTION_UNLOCK (connection);
5119 * Gets the process ID of the connection if any.
5120 * Returns #TRUE if the pid is filled in.
5121 * Always returns #FALSE prior to authenticating the
5124 * @param connection the connection
5125 * @param pid return location for the process ID
5126 * @returns #TRUE if uid is filled in with a valid process ID
5129 dbus_connection_get_unix_process_id (DBusConnection *connection,
5134 _dbus_return_val_if_fail (connection != NULL, FALSE);
5135 _dbus_return_val_if_fail (pid != NULL, FALSE);
5137 CONNECTION_LOCK (connection);
5139 if (!_dbus_transport_get_is_authenticated (connection->transport))
5142 result = _dbus_transport_get_unix_process_id (connection->transport,
5145 CONNECTION_UNLOCK (connection);
5151 * Gets the ADT audit data of the connection if any.
5152 * Returns #TRUE if the structure pointer is returned.
5153 * Always returns #FALSE prior to authenticating the
5156 * @param connection the connection
5157 * @param data return location for audit data
5158 * @returns #TRUE if audit data is filled in with a valid ucred pointer
5161 dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
5163 dbus_int32_t *data_size)
5167 _dbus_return_val_if_fail (connection != NULL, FALSE);
5168 _dbus_return_val_if_fail (data != NULL, FALSE);
5169 _dbus_return_val_if_fail (data_size != NULL, FALSE);
5171 CONNECTION_LOCK (connection);
5173 if (!_dbus_transport_get_is_authenticated (connection->transport))
5176 result = _dbus_transport_get_adt_audit_session_data (connection->transport,
5179 CONNECTION_UNLOCK (connection);
5185 * Sets a predicate function used to determine whether a given user ID
5186 * is allowed to connect. When an incoming connection has
5187 * authenticated with a particular user ID, this function is called;
5188 * if it returns #TRUE, the connection is allowed to proceed,
5189 * otherwise the connection is disconnected.
5191 * If the function is set to #NULL (as it is by default), then
5192 * only the same UID as the server process will be allowed to
5193 * connect. Also, root is always allowed to connect.
5195 * On Windows, the function will be set and its free_data_function will
5196 * be invoked when the connection is freed or a new function is set.
5197 * However, the function will never be called, because there are
5198 * no UNIX user ids to pass to it, or at least none of the existing
5199 * auth protocols would allow authenticating as a UNIX user on Windows.
5201 * @param connection the connection
5202 * @param function the predicate
5203 * @param data data to pass to the predicate
5204 * @param free_data_function function to free the data
5207 dbus_connection_set_unix_user_function (DBusConnection *connection,
5208 DBusAllowUnixUserFunction function,
5210 DBusFreeFunction free_data_function)
5212 void *old_data = NULL;
5213 DBusFreeFunction old_free_function = NULL;
5215 _dbus_return_if_fail (connection != NULL);
5217 CONNECTION_LOCK (connection);
5218 _dbus_transport_set_unix_user_function (connection->transport,
5219 function, data, free_data_function,
5220 &old_data, &old_free_function);
5221 CONNECTION_UNLOCK (connection);
5223 if (old_free_function != NULL)
5224 (* old_free_function) (old_data);
5228 * Gets the Windows user SID of the connection if known. Returns
5229 * #TRUE if the ID is filled in. Always returns #FALSE on non-Windows
5230 * platforms for now, though in theory someone could hook UNIX to
5231 * Active Directory or something. Always returns #FALSE prior to
5232 * authenticating the connection.
5234 * The user is only read by servers from clients; clients can't usually
5235 * get the user of servers, because servers do not authenticate to
5236 * clients. The returned user is the user the connection authenticated
5239 * The message bus is a server and the apps connecting to the bus
5242 * The returned user string has to be freed with dbus_free().
5244 * The return value indicates whether the user SID is available;
5245 * if it's available but we don't have the memory to copy it,
5246 * then the return value is #TRUE and #NULL is given as the SID.
5248 * @todo We would like to be able to say "You can ask the bus to tell
5249 * you the user of another connection though if you like; this is done
5250 * with dbus_bus_get_windows_user()." But this has to be implemented
5251 * in bus/driver.c and dbus/dbus-bus.c, and is pointless anyway
5252 * since on Windows we only use the session bus for now.
5254 * @param connection the connection
5255 * @param windows_sid_p return location for an allocated copy of the user ID, or #NULL if no memory
5256 * @returns #TRUE if user is available (returned value may be #NULL anyway if no memory)
5259 dbus_connection_get_windows_user (DBusConnection *connection,
5260 char **windows_sid_p)
5264 _dbus_return_val_if_fail (connection != NULL, FALSE);
5265 _dbus_return_val_if_fail (windows_sid_p != NULL, FALSE);
5267 CONNECTION_LOCK (connection);
5269 if (!_dbus_transport_get_is_authenticated (connection->transport))
5272 result = _dbus_transport_get_windows_user (connection->transport,
5276 _dbus_assert (!result);
5279 CONNECTION_UNLOCK (connection);
5285 * Sets a predicate function used to determine whether a given user ID
5286 * is allowed to connect. When an incoming connection has
5287 * authenticated with a particular user ID, this function is called;
5288 * if it returns #TRUE, the connection is allowed to proceed,
5289 * otherwise the connection is disconnected.
5291 * If the function is set to #NULL (as it is by default), then
5292 * only the same user owning the server process will be allowed to
5295 * On UNIX, the function will be set and its free_data_function will
5296 * be invoked when the connection is freed or a new function is set.
5297 * However, the function will never be called, because there is no
5298 * way right now to authenticate as a Windows user on UNIX.
5300 * @param connection the connection
5301 * @param function the predicate
5302 * @param data data to pass to the predicate
5303 * @param free_data_function function to free the data
5306 dbus_connection_set_windows_user_function (DBusConnection *connection,
5307 DBusAllowWindowsUserFunction function,
5309 DBusFreeFunction free_data_function)
5311 void *old_data = NULL;
5312 DBusFreeFunction old_free_function = NULL;
5314 _dbus_return_if_fail (connection != NULL);
5316 CONNECTION_LOCK (connection);
5317 _dbus_transport_set_windows_user_function (connection->transport,
5318 function, data, free_data_function,
5319 &old_data, &old_free_function);
5320 CONNECTION_UNLOCK (connection);
5322 if (old_free_function != NULL)
5323 (* old_free_function) (old_data);
5327 * This function must be called on the server side of a connection when the
5328 * connection is first seen in the #DBusNewConnectionFunction. If set to
5329 * #TRUE (the default is #FALSE), then the connection can proceed even if
5330 * the client does not authenticate as some user identity, i.e. clients
5331 * can connect anonymously.
5333 * This setting interacts with the available authorization mechanisms
5334 * (see dbus_server_set_auth_mechanisms()). Namely, an auth mechanism
5335 * such as ANONYMOUS that supports anonymous auth must be included in
5336 * the list of available mechanisms for anonymous login to work.
5338 * This setting also changes the default rule for connections
5339 * authorized as a user; normally, if a connection authorizes as
5340 * a user identity, it is permitted if the user identity is
5341 * root or the user identity matches the user identity of the server
5342 * process. If anonymous connections are allowed, however,
5343 * then any user identity is allowed.
5345 * You can override the rules for connections authorized as a
5346 * user identity with dbus_connection_set_unix_user_function()
5347 * and dbus_connection_set_windows_user_function().
5349 * @param connection the connection
5350 * @param value whether to allow authentication as an anonymous user
5353 dbus_connection_set_allow_anonymous (DBusConnection *connection,
5356 _dbus_return_if_fail (connection != NULL);
5358 CONNECTION_LOCK (connection);
5359 _dbus_transport_set_allow_anonymous (connection->transport, value);
5360 CONNECTION_UNLOCK (connection);
5365 * Normally #DBusConnection automatically handles all messages to the
5366 * org.freedesktop.DBus.Peer interface. However, the message bus wants
5367 * to be able to route methods on that interface through the bus and
5368 * to other applications. If routing peer messages is enabled, then
5369 * messages with the org.freedesktop.DBus.Peer interface that also
5370 * have a bus destination name set will not be automatically
5371 * handled by the #DBusConnection and instead will be dispatched
5372 * normally to the application.
5374 * If a normal application sets this flag, it can break things badly.
5375 * So don't set this unless you are the message bus.
5377 * @param connection the connection
5378 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
5381 dbus_connection_set_route_peer_messages (DBusConnection *connection,
5384 _dbus_return_if_fail (connection != NULL);
5386 CONNECTION_LOCK (connection);
5387 connection->route_peer_messages = TRUE;
5388 CONNECTION_UNLOCK (connection);
5392 * Adds a message filter. Filters are handlers that are run on all
5393 * incoming messages, prior to the objects registered with
5394 * dbus_connection_register_object_path(). Filters are run in the
5395 * order that they were added. The same handler can be added as a
5396 * filter more than once, in which case it will be run more than once.
5397 * Filters added during a filter callback won't be run on the message
5400 * @todo we don't run filters on messages while blocking without
5401 * entering the main loop, since filters are run as part of
5402 * dbus_connection_dispatch(). This is probably a feature, as filters
5403 * could create arbitrary reentrancy. But kind of sucks if you're
5404 * trying to filter METHOD_RETURN for some reason.
5406 * @param connection the connection
5407 * @param function function to handle messages
5408 * @param user_data user data to pass to the function
5409 * @param free_data_function function to use for freeing user data
5410 * @returns #TRUE on success, #FALSE if not enough memory.
5413 dbus_connection_add_filter (DBusConnection *connection,
5414 DBusHandleMessageFunction function,
5416 DBusFreeFunction free_data_function)
5418 DBusMessageFilter *filter;
5420 _dbus_return_val_if_fail (connection != NULL, FALSE);
5421 _dbus_return_val_if_fail (function != NULL, FALSE);
5423 filter = dbus_new0 (DBusMessageFilter, 1);
5427 _dbus_atomic_inc (&filter->refcount);
5429 CONNECTION_LOCK (connection);
5431 if (!_dbus_list_append (&connection->filter_list,
5434 _dbus_message_filter_unref (filter);
5435 CONNECTION_UNLOCK (connection);
5439 /* Fill in filter after all memory allocated,
5440 * so we don't run the free_user_data_function
5441 * if the add_filter() fails
5444 filter->function = function;
5445 filter->user_data = user_data;
5446 filter->free_user_data_function = free_data_function;
5448 CONNECTION_UNLOCK (connection);
5453 * Removes a previously-added message filter. It is a programming
5454 * error to call this function for a handler that has not been added
5455 * as a filter. If the given handler was added more than once, only
5456 * one instance of it will be removed (the most recently-added
5459 * @param connection the connection
5460 * @param function the handler to remove
5461 * @param user_data user data for the handler to remove
5465 dbus_connection_remove_filter (DBusConnection *connection,
5466 DBusHandleMessageFunction function,
5470 DBusMessageFilter *filter;
5472 _dbus_return_if_fail (connection != NULL);
5473 _dbus_return_if_fail (function != NULL);
5475 CONNECTION_LOCK (connection);
5479 link = _dbus_list_get_last_link (&connection->filter_list);
5480 while (link != NULL)
5482 filter = link->data;
5484 if (filter->function == function &&
5485 filter->user_data == user_data)
5487 _dbus_list_remove_link (&connection->filter_list, link);
5488 filter->function = NULL;
5493 link = _dbus_list_get_prev_link (&connection->filter_list, link);
5497 CONNECTION_UNLOCK (connection);
5499 #ifndef DBUS_DISABLE_CHECKS
5502 _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5503 function, user_data);
5508 /* Call application code */
5509 if (filter->free_user_data_function)
5510 (* filter->free_user_data_function) (filter->user_data);
5512 filter->free_user_data_function = NULL;
5513 filter->user_data = NULL;
5515 _dbus_message_filter_unref (filter);
5519 * Registers a handler for a given path in the object hierarchy.
5520 * The given vtable handles messages sent to exactly the given path.
5522 * @param connection the connection
5523 * @param path a '/' delimited string of path elements
5524 * @param vtable the virtual table
5525 * @param user_data data to pass to functions in the vtable
5526 * @param error address where an error can be returned
5527 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5528 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5531 dbus_connection_try_register_object_path (DBusConnection *connection,
5533 const DBusObjectPathVTable *vtable,
5537 char **decomposed_path;
5540 _dbus_return_val_if_fail (connection != NULL, FALSE);
5541 _dbus_return_val_if_fail (path != NULL, FALSE);
5542 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5543 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5545 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5548 CONNECTION_LOCK (connection);
5550 retval = _dbus_object_tree_register (connection->objects,
5552 (const char **) decomposed_path, vtable,
5555 CONNECTION_UNLOCK (connection);
5557 dbus_free_string_array (decomposed_path);
5563 * Registers a handler for a given path in the object hierarchy.
5564 * The given vtable handles messages sent to exactly the given path.
5566 * It is a bug to call this function for object paths which already
5567 * have a handler. Use dbus_connection_try_register_object_path() if this
5568 * might be the case.
5570 * @param connection the connection
5571 * @param path a '/' delimited string of path elements
5572 * @param vtable the virtual table
5573 * @param user_data data to pass to functions in the vtable
5574 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5575 * #DBUS_ERROR_OBJECT_PATH_IN_USE) ocurred
5578 dbus_connection_register_object_path (DBusConnection *connection,
5580 const DBusObjectPathVTable *vtable,
5583 char **decomposed_path;
5585 DBusError error = DBUS_ERROR_INIT;
5587 _dbus_return_val_if_fail (connection != NULL, FALSE);
5588 _dbus_return_val_if_fail (path != NULL, FALSE);
5589 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5590 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5592 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5595 CONNECTION_LOCK (connection);
5597 retval = _dbus_object_tree_register (connection->objects,
5599 (const char **) decomposed_path, vtable,
5602 CONNECTION_UNLOCK (connection);
5604 dbus_free_string_array (decomposed_path);
5606 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5608 _dbus_warn ("%s\n", error.message);
5609 dbus_error_free (&error);
5617 * Registers a fallback handler for a given subsection of the object
5618 * hierarchy. The given vtable handles messages at or below the given
5619 * path. You can use this to establish a default message handling
5620 * policy for a whole "subdirectory."
5622 * @param connection the connection
5623 * @param path a '/' delimited string of path elements
5624 * @param vtable the virtual table
5625 * @param user_data data to pass to functions in the vtable
5626 * @param error address where an error can be returned
5627 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5628 * #DBUS_ERROR_OBJECT_PATH_IN_USE) is reported
5631 dbus_connection_try_register_fallback (DBusConnection *connection,
5633 const DBusObjectPathVTable *vtable,
5637 char **decomposed_path;
5640 _dbus_return_val_if_fail (connection != NULL, FALSE);
5641 _dbus_return_val_if_fail (path != NULL, FALSE);
5642 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5643 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5645 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5648 CONNECTION_LOCK (connection);
5650 retval = _dbus_object_tree_register (connection->objects,
5652 (const char **) decomposed_path, vtable,
5655 CONNECTION_UNLOCK (connection);
5657 dbus_free_string_array (decomposed_path);
5663 * Registers a fallback handler for a given subsection of the object
5664 * hierarchy. The given vtable handles messages at or below the given
5665 * path. You can use this to establish a default message handling
5666 * policy for a whole "subdirectory."
5668 * It is a bug to call this function for object paths which already
5669 * have a handler. Use dbus_connection_try_register_fallback() if this
5670 * might be the case.
5672 * @param connection the connection
5673 * @param path a '/' delimited string of path elements
5674 * @param vtable the virtual table
5675 * @param user_data data to pass to functions in the vtable
5676 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5677 * #DBUS_ERROR_OBJECT_PATH_IN_USE) occured
5680 dbus_connection_register_fallback (DBusConnection *connection,
5682 const DBusObjectPathVTable *vtable,
5685 char **decomposed_path;
5687 DBusError error = DBUS_ERROR_INIT;
5689 _dbus_return_val_if_fail (connection != NULL, FALSE);
5690 _dbus_return_val_if_fail (path != NULL, FALSE);
5691 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5692 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5694 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5697 CONNECTION_LOCK (connection);
5699 retval = _dbus_object_tree_register (connection->objects,
5701 (const char **) decomposed_path, vtable,
5704 CONNECTION_UNLOCK (connection);
5706 dbus_free_string_array (decomposed_path);
5708 if (dbus_error_has_name (&error, DBUS_ERROR_OBJECT_PATH_IN_USE))
5710 _dbus_warn ("%s\n", error.message);
5711 dbus_error_free (&error);
5719 * Unregisters the handler registered with exactly the given path.
5720 * It's a bug to call this function for a path that isn't registered.
5721 * Can unregister both fallback paths and object paths.
5723 * @param connection the connection
5724 * @param path a '/' delimited string of path elements
5725 * @returns #FALSE if not enough memory
5728 dbus_connection_unregister_object_path (DBusConnection *connection,
5731 char **decomposed_path;
5733 _dbus_return_val_if_fail (connection != NULL, FALSE);
5734 _dbus_return_val_if_fail (path != NULL, FALSE);
5735 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5737 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5740 CONNECTION_LOCK (connection);
5742 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5744 dbus_free_string_array (decomposed_path);
5750 * Gets the user data passed to dbus_connection_register_object_path()
5751 * or dbus_connection_register_fallback(). If nothing was registered
5752 * at this path, the data is filled in with #NULL.
5754 * @param connection the connection
5755 * @param path the path you registered with
5756 * @param data_p location to store the user data, or #NULL
5757 * @returns #FALSE if not enough memory
5760 dbus_connection_get_object_path_data (DBusConnection *connection,
5764 char **decomposed_path;
5766 _dbus_return_val_if_fail (connection != NULL, FALSE);
5767 _dbus_return_val_if_fail (path != NULL, FALSE);
5768 _dbus_return_val_if_fail (data_p != NULL, FALSE);
5772 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5775 CONNECTION_LOCK (connection);
5777 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5779 CONNECTION_UNLOCK (connection);
5781 dbus_free_string_array (decomposed_path);
5787 * Lists the registered fallback handlers and object path handlers at
5788 * the given parent_path. The returned array should be freed with
5789 * dbus_free_string_array().
5791 * @param connection the connection
5792 * @param parent_path the path to list the child handlers of
5793 * @param child_entries returns #NULL-terminated array of children
5794 * @returns #FALSE if no memory to allocate the child entries
5797 dbus_connection_list_registered (DBusConnection *connection,
5798 const char *parent_path,
5799 char ***child_entries)
5801 char **decomposed_path;
5803 _dbus_return_val_if_fail (connection != NULL, FALSE);
5804 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5805 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5806 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5808 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5811 CONNECTION_LOCK (connection);
5813 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5814 (const char **) decomposed_path,
5816 dbus_free_string_array (decomposed_path);
5821 static DBusDataSlotAllocator slot_allocator;
5822 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
5825 * Allocates an integer ID to be used for storing application-specific
5826 * data on any DBusConnection. The allocated ID may then be used
5827 * with dbus_connection_set_data() and dbus_connection_get_data().
5828 * The passed-in slot must be initialized to -1, and is filled in
5829 * with the slot ID. If the passed-in slot is not -1, it's assumed
5830 * to be already allocated, and its refcount is incremented.
5832 * The allocated slot is global, i.e. all DBusConnection objects will
5833 * have a slot with the given integer ID reserved.
5835 * @param slot_p address of a global variable storing the slot
5836 * @returns #FALSE on failure (no memory)
5839 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5841 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5842 &_DBUS_LOCK_NAME (connection_slots),
5847 * Deallocates a global ID for connection data slots.
5848 * dbus_connection_get_data() and dbus_connection_set_data() may no
5849 * longer be used with this slot. Existing data stored on existing
5850 * DBusConnection objects will be freed when the connection is
5851 * finalized, but may not be retrieved (and may only be replaced if
5852 * someone else reallocates the slot). When the refcount on the
5853 * passed-in slot reaches 0, it is set to -1.
5855 * @param slot_p address storing the slot to deallocate
5858 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5860 _dbus_return_if_fail (*slot_p >= 0);
5862 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5866 * Stores a pointer on a DBusConnection, along
5867 * with an optional function to be used for freeing
5868 * the data when the data is set again, or when
5869 * the connection is finalized. The slot number
5870 * must have been allocated with dbus_connection_allocate_data_slot().
5872 * @note This function does not take the
5873 * main thread lock on DBusConnection, which allows it to be
5874 * used from inside watch and timeout functions. (See the
5875 * note in docs for dbus_connection_set_watch_functions().)
5876 * A side effect of this is that you need to know there's
5877 * a reference held on the connection while invoking
5878 * dbus_connection_set_data(), or the connection could be
5879 * finalized during dbus_connection_set_data().
5881 * @param connection the connection
5882 * @param slot the slot number
5883 * @param data the data to store
5884 * @param free_data_func finalizer function for the data
5885 * @returns #TRUE if there was enough memory to store the data
5888 dbus_connection_set_data (DBusConnection *connection,
5891 DBusFreeFunction free_data_func)
5893 DBusFreeFunction old_free_func;
5897 _dbus_return_val_if_fail (connection != NULL, FALSE);
5898 _dbus_return_val_if_fail (slot >= 0, FALSE);
5900 SLOTS_LOCK (connection);
5902 retval = _dbus_data_slot_list_set (&slot_allocator,
5903 &connection->slot_list,
5904 slot, data, free_data_func,
5905 &old_free_func, &old_data);
5907 SLOTS_UNLOCK (connection);
5911 /* Do the actual free outside the connection lock */
5913 (* old_free_func) (old_data);
5920 * Retrieves data previously set with dbus_connection_set_data().
5921 * The slot must still be allocated (must not have been freed).
5923 * @note This function does not take the
5924 * main thread lock on DBusConnection, which allows it to be
5925 * used from inside watch and timeout functions. (See the
5926 * note in docs for dbus_connection_set_watch_functions().)
5927 * A side effect of this is that you need to know there's
5928 * a reference held on the connection while invoking
5929 * dbus_connection_get_data(), or the connection could be
5930 * finalized during dbus_connection_get_data().
5932 * @param connection the connection
5933 * @param slot the slot to get data from
5934 * @returns the data, or #NULL if not found
5937 dbus_connection_get_data (DBusConnection *connection,
5942 _dbus_return_val_if_fail (connection != NULL, NULL);
5944 SLOTS_LOCK (connection);
5946 res = _dbus_data_slot_list_get (&slot_allocator,
5947 &connection->slot_list,
5950 SLOTS_UNLOCK (connection);
5956 * This function sets a global flag for whether dbus_connection_new()
5957 * will set SIGPIPE behavior to SIG_IGN.
5959 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
5962 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
5964 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
5968 * Specifies the maximum size message this connection is allowed to
5969 * receive. Larger messages will result in disconnecting the
5972 * @param connection a #DBusConnection
5973 * @param size maximum message size the connection can receive, in bytes
5976 dbus_connection_set_max_message_size (DBusConnection *connection,
5979 _dbus_return_if_fail (connection != NULL);
5981 CONNECTION_LOCK (connection);
5982 _dbus_transport_set_max_message_size (connection->transport,
5984 CONNECTION_UNLOCK (connection);
5988 * Gets the value set by dbus_connection_set_max_message_size().
5990 * @param connection the connection
5991 * @returns the max size of a single message
5994 dbus_connection_get_max_message_size (DBusConnection *connection)
5998 _dbus_return_val_if_fail (connection != NULL, 0);
6000 CONNECTION_LOCK (connection);
6001 res = _dbus_transport_get_max_message_size (connection->transport);
6002 CONNECTION_UNLOCK (connection);
6007 * Specifies the maximum number of unix fds a message on this
6008 * connection is allowed to receive. Messages with more unix fds will
6009 * result in disconnecting the connection.
6011 * @param connection a #DBusConnection
6012 * @param size maximum message unix fds the connection can receive
6015 dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
6018 _dbus_return_if_fail (connection != NULL);
6020 CONNECTION_LOCK (connection);
6021 _dbus_transport_set_max_message_unix_fds (connection->transport,
6023 CONNECTION_UNLOCK (connection);
6027 * Gets the value set by dbus_connection_set_max_message_unix_fds().
6029 * @param connection the connection
6030 * @returns the max numer of unix fds of a single message
6033 dbus_connection_get_max_message_unix_fds (DBusConnection *connection)
6037 _dbus_return_val_if_fail (connection != NULL, 0);
6039 CONNECTION_LOCK (connection);
6040 res = _dbus_transport_get_max_message_unix_fds (connection->transport);
6041 CONNECTION_UNLOCK (connection);
6046 * Sets the maximum total number of bytes that can be used for all messages
6047 * received on this connection. Messages count toward the maximum until
6048 * they are finalized. When the maximum is reached, the connection will
6049 * not read more data until some messages are finalized.
6051 * The semantics of the maximum are: if outstanding messages are
6052 * already above the maximum, additional messages will not be read.
6053 * The semantics are not: if the next message would cause us to exceed
6054 * the maximum, we don't read it. The reason is that we don't know the
6055 * size of a message until after we read it.
6057 * Thus, the max live messages size can actually be exceeded
6058 * by up to the maximum size of a single message.
6060 * Also, if we read say 1024 bytes off the wire in a single read(),
6061 * and that contains a half-dozen small messages, we may exceed the
6062 * size max by that amount. But this should be inconsequential.
6064 * This does imply that we can't call read() with a buffer larger
6065 * than we're willing to exceed this limit by.
6067 * @param connection the connection
6068 * @param size the maximum size in bytes of all outstanding messages
6071 dbus_connection_set_max_received_size (DBusConnection *connection,
6074 _dbus_return_if_fail (connection != NULL);
6076 CONNECTION_LOCK (connection);
6077 _dbus_transport_set_max_received_size (connection->transport,
6079 CONNECTION_UNLOCK (connection);
6083 * Gets the value set by dbus_connection_set_max_received_size().
6085 * @param connection the connection
6086 * @returns the max size of all live messages
6089 dbus_connection_get_max_received_size (DBusConnection *connection)
6093 _dbus_return_val_if_fail (connection != NULL, 0);
6095 CONNECTION_LOCK (connection);
6096 res = _dbus_transport_get_max_received_size (connection->transport);
6097 CONNECTION_UNLOCK (connection);
6102 * Sets the maximum total number of unix fds that can be used for all messages
6103 * received on this connection. Messages count toward the maximum until
6104 * they are finalized. When the maximum is reached, the connection will
6105 * not read more data until some messages are finalized.
6107 * The semantics are analogous to those of dbus_connection_set_max_received_size().
6109 * @param connection the connection
6110 * @param size the maximum size in bytes of all outstanding messages
6113 dbus_connection_set_max_received_unix_fds (DBusConnection *connection,
6116 _dbus_return_if_fail (connection != NULL);
6118 CONNECTION_LOCK (connection);
6119 _dbus_transport_set_max_received_unix_fds (connection->transport,
6121 CONNECTION_UNLOCK (connection);
6125 * Gets the value set by dbus_connection_set_max_received_unix_fds().
6127 * @param connection the connection
6128 * @returns the max unix fds of all live messages
6131 dbus_connection_get_max_received_unix_fds (DBusConnection *connection)
6135 _dbus_return_val_if_fail (connection != NULL, 0);
6137 CONNECTION_LOCK (connection);
6138 res = _dbus_transport_get_max_received_unix_fds (connection->transport);
6139 CONNECTION_UNLOCK (connection);
6144 * Gets the approximate size in bytes of all messages in the outgoing
6145 * message queue. The size is approximate in that you shouldn't use
6146 * it to decide how many bytes to read off the network or anything
6147 * of that nature, as optimizations may choose to tell small white lies
6148 * to avoid performance overhead.
6150 * @param connection the connection
6151 * @returns the number of bytes that have been queued up but not sent
6154 dbus_connection_get_outgoing_size (DBusConnection *connection)
6158 _dbus_return_val_if_fail (connection != NULL, 0);
6160 CONNECTION_LOCK (connection);
6161 res = _dbus_counter_get_size_value (connection->outgoing_counter);
6162 CONNECTION_UNLOCK (connection);
6167 * Gets the approximate number of uni fds of all messages in the
6168 * outgoing message queue.
6170 * @param connection the connection
6171 * @returns the number of unix fds that have been queued up but not sent
6174 dbus_connection_get_outgoing_unix_fds (DBusConnection *connection)
6178 _dbus_return_val_if_fail (connection != NULL, 0);
6180 CONNECTION_LOCK (connection);
6181 res = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6182 CONNECTION_UNLOCK (connection);