1 /* -*- mode: C; c-file-style: "gnu" -*- */
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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-threads.h"
37 #include "dbus-protocol.h"
38 #include "dbus-dataslot.h"
39 #include "dbus-string.h"
40 #include "dbus-pending-call.h"
41 #include "dbus-object-tree.h"
42 #include "dbus-threads-internal.h"
45 #ifdef DBUS_DISABLE_CHECKS
46 #define TOOK_LOCK_CHECK(connection)
47 #define RELEASING_LOCK_CHECK(connection)
48 #define HAVE_LOCK_CHECK(connection)
50 #define TOOK_LOCK_CHECK(connection) do { \
51 _dbus_assert (!(connection)->have_connection_lock); \
52 (connection)->have_connection_lock = TRUE; \
54 #define RELEASING_LOCK_CHECK(connection) do { \
55 _dbus_assert ((connection)->have_connection_lock); \
56 (connection)->have_connection_lock = FALSE; \
58 #define HAVE_LOCK_CHECK(connection) _dbus_assert ((connection)->have_connection_lock)
59 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
64 #define CONNECTION_LOCK(connection) do { \
65 if (TRACE_LOCKS) { _dbus_verbose (" LOCK: %s\n", _DBUS_FUNCTION_NAME); } \
66 _dbus_mutex_lock ((connection)->mutex); \
67 TOOK_LOCK_CHECK (connection); \
70 #define CONNECTION_UNLOCK(connection) do { \
71 if (TRACE_LOCKS) { _dbus_verbose (" UNLOCK: %s\n", _DBUS_FUNCTION_NAME); } \
72 RELEASING_LOCK_CHECK (connection); \
73 _dbus_mutex_unlock ((connection)->mutex); \
76 #define DISPATCH_STATUS_NAME(s) \
77 ((s) == DBUS_DISPATCH_COMPLETE ? "complete" : \
78 (s) == DBUS_DISPATCH_DATA_REMAINS ? "data remains" : \
79 (s) == DBUS_DISPATCH_NEED_MEMORY ? "need memory" : \
83 * @defgroup DBusConnection DBusConnection
85 * @brief Connection to another application
87 * A DBusConnection represents a connection to another
88 * application. Messages can be sent and received via this connection.
89 * The other application may be a message bus; for convenience, the
90 * function dbus_bus_get() is provided to automatically open a
91 * connection to the well-known message buses.
93 * In brief a DBusConnection is a message queue associated with some
94 * message transport mechanism such as a socket. The connection
95 * maintains a queue of incoming messages and a queue of outgoing
98 * Incoming messages are normally processed by calling
99 * dbus_connection_dispatch(). dbus_connection_dispatch() runs any
100 * handlers registered for the topmost message in the message queue,
101 * then discards the message, then returns.
103 * dbus_connection_get_dispatch_status() indicates whether
104 * messages are currently in the queue that need dispatching.
105 * dbus_connection_set_dispatch_status_function() allows
106 * you to set a function to be used to monitor the dispatch status.
108 * If you're using GLib or Qt add-on libraries for D-Bus, there are
109 * special convenience APIs in those libraries that hide
110 * all the details of dispatch and watch/timeout monitoring.
111 * For example, dbus_connection_setup_with_g_main().
113 * If you aren't using these add-on libraries, you have to manually
114 * call dbus_connection_set_dispatch_status_function(),
115 * dbus_connection_set_watch_functions(),
116 * dbus_connection_set_timeout_functions() providing appropriate
117 * functions to integrate the connection with your application's main
120 * When you use dbus_connection_send() or one of its variants to send
121 * a message, the message is added to the outgoing queue. It's
122 * actually written to the network later; either in
123 * dbus_watch_handle() invoked by your main loop, or in
124 * dbus_connection_flush() which blocks until it can write out the
125 * entire outgoing queue. The GLib/Qt add-on libraries again
126 * handle the details here for you by setting up watch functions.
128 * When a connection is disconnected, you are guaranteed to get a
129 * signal "Disconnected" from the interface
130 * #DBUS_INTERFACE_LOCAL, path
133 * You may not drop the last reference to a #DBusConnection
134 * until that connection has been disconnected.
136 * You may dispatch the unprocessed incoming message queue even if the
137 * connection is disconnected. However, "Disconnected" will always be
138 * the last message in the queue (obviously no messages are received
139 * after disconnection).
141 * #DBusConnection has thread locks and drops them when invoking user
142 * callbacks, so in general is transparently threadsafe. However,
143 * #DBusMessage does NOT have thread locks; you must not send the same
144 * message to multiple #DBusConnection that will be used from
149 * @defgroup DBusConnectionInternals DBusConnection implementation details
150 * @ingroup DBusInternals
151 * @brief Implementation details of DBusConnection
157 * Internal struct representing a message filter function
159 typedef struct DBusMessageFilter DBusMessageFilter;
162 * Internal struct representing a message filter function
164 struct DBusMessageFilter
166 DBusAtomic refcount; /**< Reference count */
167 DBusHandleMessageFunction function; /**< Function to call to filter */
168 void *user_data; /**< User data for the function */
169 DBusFreeFunction free_user_data_function; /**< Function to free the user data */
174 * Internals of DBusPreallocatedSend
176 struct DBusPreallocatedSend
178 DBusConnection *connection; /**< Connection we'd send the message to */
179 DBusList *queue_link; /**< Preallocated link in the queue */
180 DBusList *counter_link; /**< Preallocated link in the resource counter */
183 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
186 * Implementation details of DBusConnection. All fields are private.
188 struct DBusConnection
190 DBusAtomic refcount; /**< Reference count. */
192 DBusMutex *mutex; /**< Lock on the entire DBusConnection */
194 DBusMutex *dispatch_mutex; /**< Protects dispatch_acquired */
195 DBusCondVar *dispatch_cond; /**< Notify when dispatch_acquired is available */
196 DBusMutex *io_path_mutex; /**< Protects io_path_acquired */
197 DBusCondVar *io_path_cond; /**< Notify when io_path_acquired is available */
199 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
200 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
202 DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
203 * dispatch_acquired will be set by the borrower
206 int n_outgoing; /**< Length of outgoing queue. */
207 int n_incoming; /**< Length of incoming queue. */
209 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
211 DBusTransport *transport; /**< Object that sends/receives messages over network. */
212 DBusWatchList *watches; /**< Stores active watches. */
213 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
215 DBusList *filter_list; /**< List of filters. */
217 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
219 DBusHashTable *pending_replies; /**< Hash of message serials to #DBusPendingCall. */
221 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
222 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
224 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
225 void *wakeup_main_data; /**< Application data for wakeup_main_function */
226 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
228 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
229 void *dispatch_status_data; /**< Application data for dispatch_status_function */
230 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
232 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
234 DBusList *link_cache; /**< A cache of linked list links to prevent contention
235 * for the global linked list mempool lock
237 DBusObjectTree *objects; /**< Object path handlers registered with this connection */
239 char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
241 unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
243 unsigned int dispatch_acquired : 1; /**< Someone has dispatch path (can drain incoming queue) */
244 unsigned int io_path_acquired : 1; /**< Someone has transport io path (can use the transport to read/write messages) */
246 unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
248 unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
250 unsigned int disconnected_message_arrived : 1; /**< We popped or are dispatching the disconnected message.
251 * if the disconnect_message_link is NULL then we queued it, but
252 * this flag is whether it got to the head of the queue.
254 unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
255 * such as closing the connection.
258 #ifndef DBUS_DISABLE_CHECKS
259 unsigned int have_connection_lock : 1; /**< Used to check locking */
262 #ifndef DBUS_DISABLE_CHECKS
263 int generation; /**< _dbus_current_generation that should correspond to this connection */
267 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
268 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
269 DBusDispatchStatus new_status);
270 static void _dbus_connection_last_unref (DBusConnection *connection);
271 static void _dbus_connection_acquire_dispatch (DBusConnection *connection);
272 static void _dbus_connection_release_dispatch (DBusConnection *connection);
273 static DBusDispatchStatus _dbus_connection_flush_unlocked (DBusConnection *connection);
274 static void _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection);
275 static dbus_bool_t _dbus_connection_get_is_connected_unlocked (DBusConnection *connection);
277 static DBusMessageFilter *
278 _dbus_message_filter_ref (DBusMessageFilter *filter)
280 _dbus_assert (filter->refcount.value > 0);
281 _dbus_atomic_inc (&filter->refcount);
287 _dbus_message_filter_unref (DBusMessageFilter *filter)
289 _dbus_assert (filter->refcount.value > 0);
291 if (_dbus_atomic_dec (&filter->refcount) == 1)
293 if (filter->free_user_data_function)
294 (* filter->free_user_data_function) (filter->user_data);
301 * Acquires the connection lock.
303 * @param connection the connection.
306 _dbus_connection_lock (DBusConnection *connection)
308 CONNECTION_LOCK (connection);
312 * Releases the connection lock.
314 * @param connection the connection.
317 _dbus_connection_unlock (DBusConnection *connection)
319 CONNECTION_UNLOCK (connection);
323 * Wakes up the main loop if it is sleeping
324 * Needed if we're e.g. queueing outgoing messages
325 * on a thread while the mainloop sleeps.
327 * @param connection the connection.
330 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
332 if (connection->wakeup_main_function)
333 (*connection->wakeup_main_function) (connection->wakeup_main_data);
336 #ifdef DBUS_BUILD_TESTS
337 /* For now this function isn't used */
339 * Adds a message to the incoming message queue, returning #FALSE
340 * if there's insufficient memory to queue the message.
341 * Does not take over refcount of the message.
343 * @param connection the connection.
344 * @param message the message to queue.
345 * @returns #TRUE on success.
348 _dbus_connection_queue_received_message (DBusConnection *connection,
349 DBusMessage *message)
353 link = _dbus_list_alloc_link (message);
357 dbus_message_ref (message);
358 _dbus_connection_queue_received_message_link (connection, link);
364 * Gets the locks so we can examine them
366 * @param connection the connection.
367 * @param mutex_loc return for the location of the main mutex pointer
368 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
369 * @param io_path_mutex_loc return location of the io_path mutex pointer
370 * @param dispatch_cond_loc return location of the dispatch conditional
372 * @param io_path_cond_loc return location of the io_path conditional
376 _dbus_connection_test_get_locks (DBusConnection *conn,
377 DBusMutex **mutex_loc,
378 DBusMutex **dispatch_mutex_loc,
379 DBusMutex **io_path_mutex_loc,
380 DBusCondVar **dispatch_cond_loc,
381 DBusCondVar **io_path_cond_loc)
383 *mutex_loc = conn->mutex;
384 *dispatch_mutex_loc = conn->dispatch_mutex;
385 *io_path_mutex_loc = conn->io_path_mutex;
386 *dispatch_cond_loc = conn->dispatch_cond;
387 *io_path_cond_loc = conn->io_path_cond;
392 * Adds a message-containing list link to the incoming message queue,
393 * taking ownership of the link and the message's current refcount.
394 * Cannot fail due to lack of memory.
396 * @param connection the connection.
397 * @param link the message link to queue.
400 _dbus_connection_queue_received_message_link (DBusConnection *connection,
403 DBusPendingCall *pending;
404 dbus_int32_t reply_serial;
405 DBusMessage *message;
407 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
409 _dbus_list_append_link (&connection->incoming_messages,
411 message = link->data;
413 /* If this is a reply we're waiting on, remove timeout for it */
414 reply_serial = dbus_message_get_reply_serial (message);
415 if (reply_serial != -1)
417 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
421 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
422 _dbus_connection_remove_timeout_unlocked (connection,
423 _dbus_pending_call_get_timeout_unlocked (pending));
425 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
431 connection->n_incoming += 1;
433 _dbus_connection_wakeup_mainloop (connection);
435 _dbus_verbose ("Message %p (%d %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
437 dbus_message_get_type (message),
438 dbus_message_get_path (message) ?
439 dbus_message_get_path (message) :
441 dbus_message_get_interface (message) ?
442 dbus_message_get_interface (message) :
444 dbus_message_get_member (message) ?
445 dbus_message_get_member (message) :
447 dbus_message_get_signature (message),
448 dbus_message_get_reply_serial (message),
450 connection->n_incoming);}
453 * Adds a link + message to the incoming message queue.
454 * Can't fail. Takes ownership of both link and message.
456 * @param connection the connection.
457 * @param link the list node and message to queue.
461 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
464 HAVE_LOCK_CHECK (connection);
466 _dbus_list_append_link (&connection->incoming_messages, link);
468 connection->n_incoming += 1;
470 _dbus_connection_wakeup_mainloop (connection);
472 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
473 link->data, connection, connection->n_incoming);
478 * Checks whether there are messages in the outgoing message queue.
479 * Called with connection lock held.
481 * @param connection the connection.
482 * @returns #TRUE if the outgoing queue is non-empty.
485 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
487 HAVE_LOCK_CHECK (connection);
488 return connection->outgoing_messages != NULL;
492 * Checks whether there are messages in the outgoing message queue.
494 * @param connection the connection.
495 * @returns #TRUE if the outgoing queue is non-empty.
498 dbus_connection_has_messages_to_send (DBusConnection *connection)
502 _dbus_return_val_if_fail (connection != NULL, FALSE);
504 CONNECTION_LOCK (connection);
505 v = _dbus_connection_has_messages_to_send_unlocked (connection);
506 CONNECTION_UNLOCK (connection);
512 * Gets the next outgoing message. The message remains in the
513 * queue, and the caller does not own a reference to it.
515 * @param connection the connection.
516 * @returns the message to be sent.
519 _dbus_connection_get_message_to_send (DBusConnection *connection)
521 HAVE_LOCK_CHECK (connection);
523 return _dbus_list_get_last (&connection->outgoing_messages);
527 * Notifies the connection that a message has been sent, so the
528 * message can be removed from the outgoing queue.
529 * Called with the connection lock held.
531 * @param connection the connection.
532 * @param message the message that was sent.
535 _dbus_connection_message_sent (DBusConnection *connection,
536 DBusMessage *message)
540 HAVE_LOCK_CHECK (connection);
542 /* This can be called before we even complete authentication, since
543 * it's called on disconnect to clean up the outgoing queue.
544 * It's also called as we successfully send each message.
547 link = _dbus_list_get_last_link (&connection->outgoing_messages);
548 _dbus_assert (link != NULL);
549 _dbus_assert (link->data == message);
551 /* Save this link in the link cache */
552 _dbus_list_unlink (&connection->outgoing_messages,
554 _dbus_list_prepend_link (&connection->link_cache, link);
556 connection->n_outgoing -= 1;
558 _dbus_verbose ("Message %p (%d %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
560 dbus_message_get_type (message),
561 dbus_message_get_path (message) ?
562 dbus_message_get_path (message) :
564 dbus_message_get_interface (message) ?
565 dbus_message_get_interface (message) :
567 dbus_message_get_member (message) ?
568 dbus_message_get_member (message) :
570 dbus_message_get_signature (message),
571 connection, connection->n_outgoing);
573 /* Save this link in the link cache also */
574 _dbus_message_remove_size_counter (message, connection->outgoing_counter,
576 _dbus_list_prepend_link (&connection->link_cache, link);
578 dbus_message_unref (message);
581 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
583 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
585 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
587 dbus_bool_t enabled);
590 protected_change_watch (DBusConnection *connection,
592 DBusWatchAddFunction add_function,
593 DBusWatchRemoveFunction remove_function,
594 DBusWatchToggleFunction toggle_function,
597 DBusWatchList *watches;
600 HAVE_LOCK_CHECK (connection);
602 /* This isn't really safe or reasonable; a better pattern is the "do everything, then
603 * drop lock and call out" one; but it has to be propagated up through all callers
606 watches = connection->watches;
609 connection->watches = NULL;
610 _dbus_connection_ref_unlocked (connection);
611 CONNECTION_UNLOCK (connection);
614 retval = (* add_function) (watches, watch);
615 else if (remove_function)
618 (* remove_function) (watches, watch);
623 (* toggle_function) (watches, watch, enabled);
626 CONNECTION_LOCK (connection);
627 connection->watches = watches;
628 _dbus_connection_unref_unlocked (connection);
638 * Adds a watch using the connection's DBusAddWatchFunction if
639 * available. Otherwise records the watch to be added when said
640 * function is available. Also re-adds the watch if the
641 * DBusAddWatchFunction changes. May fail due to lack of memory.
642 * Connection lock should be held when calling this.
644 * @param connection the connection.
645 * @param watch the watch to add.
646 * @returns #TRUE on success.
649 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
652 return protected_change_watch (connection, watch,
653 _dbus_watch_list_add_watch,
658 * Removes a watch using the connection's DBusRemoveWatchFunction
659 * if available. It's an error to call this function on a watch
660 * that was not previously added.
661 * Connection lock should be held when calling this.
663 * @param connection the connection.
664 * @param watch the watch to remove.
667 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
670 protected_change_watch (connection, watch,
672 _dbus_watch_list_remove_watch,
677 * Toggles a watch and notifies app via connection's
678 * DBusWatchToggledFunction if available. It's an error to call this
679 * function on a watch that was not previously added.
680 * Connection lock should be held when calling this.
682 * @param connection the connection.
683 * @param watch the watch to toggle.
684 * @param enabled whether to enable or disable
687 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
691 _dbus_assert (watch != NULL);
693 protected_change_watch (connection, watch,
695 _dbus_watch_list_toggle_watch,
699 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
700 DBusTimeout *timeout);
701 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
702 DBusTimeout *timeout);
703 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
704 DBusTimeout *timeout,
705 dbus_bool_t enabled);
708 protected_change_timeout (DBusConnection *connection,
709 DBusTimeout *timeout,
710 DBusTimeoutAddFunction add_function,
711 DBusTimeoutRemoveFunction remove_function,
712 DBusTimeoutToggleFunction toggle_function,
715 DBusTimeoutList *timeouts;
718 HAVE_LOCK_CHECK (connection);
720 /* This isn't really safe or reasonable; a better pattern is the "do everything, then
721 * drop lock and call out" one; but it has to be propagated up through all callers
724 timeouts = connection->timeouts;
727 connection->timeouts = NULL;
728 _dbus_connection_ref_unlocked (connection);
729 CONNECTION_UNLOCK (connection);
732 retval = (* add_function) (timeouts, timeout);
733 else if (remove_function)
736 (* remove_function) (timeouts, timeout);
741 (* toggle_function) (timeouts, timeout, enabled);
744 CONNECTION_LOCK (connection);
745 connection->timeouts = timeouts;
746 _dbus_connection_unref_unlocked (connection);
755 * Adds a timeout using the connection's DBusAddTimeoutFunction if
756 * available. Otherwise records the timeout to be added when said
757 * function is available. Also re-adds the timeout if the
758 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
759 * The timeout will fire repeatedly until removed.
760 * Connection lock should be held when calling this.
762 * @param connection the connection.
763 * @param timeout the timeout to add.
764 * @returns #TRUE on success.
767 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
768 DBusTimeout *timeout)
770 return protected_change_timeout (connection, timeout,
771 _dbus_timeout_list_add_timeout,
776 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
777 * if available. It's an error to call this function on a timeout
778 * that was not previously added.
779 * Connection lock should be held when calling this.
781 * @param connection the connection.
782 * @param timeout the timeout to remove.
785 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
786 DBusTimeout *timeout)
788 protected_change_timeout (connection, timeout,
790 _dbus_timeout_list_remove_timeout,
795 * Toggles a timeout and notifies app via connection's
796 * DBusTimeoutToggledFunction if available. It's an error to call this
797 * function on a timeout that was not previously added.
798 * Connection lock should be held when calling this.
800 * @param connection the connection.
801 * @param timeout the timeout to toggle.
802 * @param enabled whether to enable or disable
805 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
806 DBusTimeout *timeout,
809 protected_change_timeout (connection, timeout,
811 _dbus_timeout_list_toggle_timeout,
816 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
817 DBusPendingCall *pending)
819 dbus_uint32_t reply_serial;
820 DBusTimeout *timeout;
822 HAVE_LOCK_CHECK (connection);
824 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
826 _dbus_assert (reply_serial != 0);
828 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
830 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
833 if (!_dbus_hash_table_insert_int (connection->pending_replies,
837 _dbus_connection_remove_timeout_unlocked (connection, timeout);
839 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
840 HAVE_LOCK_CHECK (connection);
844 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
846 _dbus_pending_call_ref_unlocked (pending);
848 HAVE_LOCK_CHECK (connection);
854 free_pending_call_on_hash_removal (void *data)
856 DBusPendingCall *pending;
857 DBusConnection *connection;
864 connection = _dbus_pending_call_get_connection_unlocked (pending);
866 HAVE_LOCK_CHECK (connection);
868 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
870 _dbus_connection_remove_timeout_unlocked (connection,
871 _dbus_pending_call_get_timeout_unlocked (pending));
873 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
876 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
877 * here, but the pending call finalizer could in principle call out to
878 * application code so we pretty much have to... some larger code reorg
881 _dbus_connection_ref_unlocked (connection);
882 _dbus_pending_call_unref_and_unlock (pending);
883 CONNECTION_LOCK (connection);
884 _dbus_connection_unref_unlocked (connection);
888 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
889 DBusPendingCall *pending)
891 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
894 _dbus_hash_table_remove_int (connection->pending_replies,
895 _dbus_pending_call_get_reply_serial_unlocked (pending));
899 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
900 DBusPendingCall *pending)
902 /* The idea here is to avoid finalizing the pending call
903 * with the lock held, since there's a destroy notifier
904 * in pending call that goes out to application code.
906 * There's an extra unlock inside the hash table
907 * "free pending call" function FIXME...
909 _dbus_pending_call_ref_unlocked (pending);
910 _dbus_hash_table_remove_int (connection->pending_replies,
911 _dbus_pending_call_get_reply_serial_unlocked (pending));
912 _dbus_pending_call_unref_and_unlock (pending);
916 * Removes a pending call from the connection, such that
917 * the pending reply will be ignored. May drop the last
918 * reference to the pending call.
920 * @param connection the connection
921 * @param pending the pending call
924 _dbus_connection_remove_pending_call (DBusConnection *connection,
925 DBusPendingCall *pending)
927 CONNECTION_LOCK (connection);
928 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
932 * Acquire the transporter I/O path. This must be done before
933 * doing any I/O in the transporter. May sleep and drop the
934 * IO path mutex while waiting for the I/O path.
936 * @param connection the connection.
937 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
938 * @returns TRUE if the I/O path was acquired.
941 _dbus_connection_acquire_io_path (DBusConnection *connection,
942 int timeout_milliseconds)
944 dbus_bool_t we_acquired;
946 HAVE_LOCK_CHECK (connection);
948 /* We don't want the connection to vanish */
949 _dbus_connection_ref_unlocked (connection);
951 /* We will only touch io_path_acquired which is protected by our mutex */
952 CONNECTION_UNLOCK (connection);
954 _dbus_verbose ("%s locking io_path_mutex\n", _DBUS_FUNCTION_NAME);
955 _dbus_mutex_lock (connection->io_path_mutex);
957 _dbus_verbose ("%s start connection->io_path_acquired = %d timeout = %d\n",
958 _DBUS_FUNCTION_NAME, connection->io_path_acquired, timeout_milliseconds);
962 if (connection->io_path_acquired)
964 if (timeout_milliseconds != -1)
966 _dbus_verbose ("%s waiting %d for IO path to be acquirable\n",
967 _DBUS_FUNCTION_NAME, timeout_milliseconds);
968 _dbus_condvar_wait_timeout (connection->io_path_cond,
969 connection->io_path_mutex,
970 timeout_milliseconds);
974 while (connection->io_path_acquired)
976 _dbus_verbose ("%s waiting for IO path to be acquirable\n", _DBUS_FUNCTION_NAME);
977 _dbus_condvar_wait (connection->io_path_cond,
978 connection->io_path_mutex);
983 if (!connection->io_path_acquired)
986 connection->io_path_acquired = TRUE;
989 _dbus_verbose ("%s end connection->io_path_acquired = %d we_acquired = %d\n",
990 _DBUS_FUNCTION_NAME, connection->io_path_acquired, we_acquired);
992 _dbus_verbose ("%s unlocking io_path_mutex\n", _DBUS_FUNCTION_NAME);
993 _dbus_mutex_unlock (connection->io_path_mutex);
995 CONNECTION_LOCK (connection);
997 HAVE_LOCK_CHECK (connection);
999 _dbus_connection_unref_unlocked (connection);
1005 * Release the I/O path when you're done with it. Only call
1006 * after you've acquired the I/O. Wakes up at most one thread
1007 * currently waiting to acquire the I/O path.
1009 * @param connection the connection.
1012 _dbus_connection_release_io_path (DBusConnection *connection)
1014 HAVE_LOCK_CHECK (connection);
1016 _dbus_verbose ("%s locking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1017 _dbus_mutex_lock (connection->io_path_mutex);
1019 _dbus_assert (connection->io_path_acquired);
1021 _dbus_verbose ("%s start connection->io_path_acquired = %d\n",
1022 _DBUS_FUNCTION_NAME, connection->io_path_acquired);
1024 connection->io_path_acquired = FALSE;
1025 _dbus_condvar_wake_one (connection->io_path_cond);
1027 _dbus_verbose ("%s unlocking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1028 _dbus_mutex_unlock (connection->io_path_mutex);
1032 * Queues incoming messages and sends outgoing messages for this
1033 * connection, optionally blocking in the process. Each call to
1034 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1035 * time and then read or write data if possible.
1037 * The purpose of this function is to be able to flush outgoing
1038 * messages or queue up incoming messages without returning
1039 * control to the application and causing reentrancy weirdness.
1041 * The flags parameter allows you to specify whether to
1042 * read incoming messages, write outgoing messages, or both,
1043 * and whether to block if no immediate action is possible.
1045 * The timeout_milliseconds parameter does nothing unless the
1046 * iteration is blocking.
1048 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1049 * wasn't specified, then it's impossible to block, even if
1050 * you specify DBUS_ITERATION_BLOCK; in that case the function
1051 * returns immediately.
1053 * Called with connection lock held.
1055 * @param connection the connection.
1056 * @param flags iteration flags.
1057 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1060 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1062 int timeout_milliseconds)
1064 _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
1066 HAVE_LOCK_CHECK (connection);
1068 if (connection->n_outgoing == 0)
1069 flags &= ~DBUS_ITERATION_DO_WRITING;
1071 if (_dbus_connection_acquire_io_path (connection,
1072 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1074 HAVE_LOCK_CHECK (connection);
1076 _dbus_transport_do_iteration (connection->transport,
1077 flags, timeout_milliseconds);
1078 _dbus_connection_release_io_path (connection);
1081 HAVE_LOCK_CHECK (connection);
1083 _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
1087 * Creates a new connection for the given transport. A transport
1088 * represents a message stream that uses some concrete mechanism, such
1089 * as UNIX domain sockets. May return #NULL if insufficient
1090 * memory exists to create the connection.
1092 * @param transport the transport.
1093 * @returns the new connection, or #NULL on failure.
1096 _dbus_connection_new_for_transport (DBusTransport *transport)
1098 DBusConnection *connection;
1099 DBusWatchList *watch_list;
1100 DBusTimeoutList *timeout_list;
1101 DBusHashTable *pending_replies;
1102 DBusList *disconnect_link;
1103 DBusMessage *disconnect_message;
1104 DBusCounter *outgoing_counter;
1105 DBusObjectTree *objects;
1109 pending_replies = NULL;
1110 timeout_list = NULL;
1111 disconnect_link = NULL;
1112 disconnect_message = NULL;
1113 outgoing_counter = NULL;
1116 watch_list = _dbus_watch_list_new ();
1117 if (watch_list == NULL)
1120 timeout_list = _dbus_timeout_list_new ();
1121 if (timeout_list == NULL)
1125 _dbus_hash_table_new (DBUS_HASH_INT,
1127 (DBusFreeFunction)free_pending_call_on_hash_removal);
1128 if (pending_replies == NULL)
1131 connection = dbus_new0 (DBusConnection, 1);
1132 if (connection == NULL)
1135 _dbus_mutex_new_at_location (&connection->mutex);
1136 if (connection->mutex == NULL)
1139 _dbus_mutex_new_at_location (&connection->io_path_mutex);
1140 if (connection->io_path_mutex == NULL)
1143 _dbus_mutex_new_at_location (&connection->dispatch_mutex);
1144 if (connection->dispatch_mutex == NULL)
1147 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1148 if (connection->dispatch_cond == NULL)
1151 _dbus_condvar_new_at_location (&connection->io_path_cond);
1152 if (connection->io_path_cond == NULL)
1155 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1156 DBUS_INTERFACE_LOCAL,
1159 if (disconnect_message == NULL)
1162 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1163 if (disconnect_link == NULL)
1166 outgoing_counter = _dbus_counter_new ();
1167 if (outgoing_counter == NULL)
1170 objects = _dbus_object_tree_new (connection);
1171 if (objects == NULL)
1174 if (_dbus_modify_sigpipe)
1175 _dbus_disable_sigpipe ();
1177 connection->refcount.value = 1;
1178 connection->transport = transport;
1179 connection->watches = watch_list;
1180 connection->timeouts = timeout_list;
1181 connection->pending_replies = pending_replies;
1182 connection->outgoing_counter = outgoing_counter;
1183 connection->filter_list = NULL;
1184 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1185 connection->objects = objects;
1186 connection->exit_on_disconnect = FALSE;
1187 connection->shareable = FALSE;
1188 connection->route_peer_messages = FALSE;
1189 connection->disconnected_message_arrived = FALSE;
1190 connection->disconnected_message_processed = FALSE;
1192 #ifndef DBUS_DISABLE_CHECKS
1193 connection->generation = _dbus_current_generation;
1196 _dbus_data_slot_list_init (&connection->slot_list);
1198 connection->client_serial = 1;
1200 connection->disconnect_message_link = disconnect_link;
1202 CONNECTION_LOCK (connection);
1204 if (!_dbus_transport_set_connection (transport, connection))
1206 CONNECTION_UNLOCK (connection);
1211 _dbus_transport_ref (transport);
1213 CONNECTION_UNLOCK (connection);
1218 if (disconnect_message != NULL)
1219 dbus_message_unref (disconnect_message);
1221 if (disconnect_link != NULL)
1222 _dbus_list_free_link (disconnect_link);
1224 if (connection != NULL)
1226 _dbus_condvar_free_at_location (&connection->io_path_cond);
1227 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1228 _dbus_mutex_free_at_location (&connection->mutex);
1229 _dbus_mutex_free_at_location (&connection->io_path_mutex);
1230 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
1231 dbus_free (connection);
1233 if (pending_replies)
1234 _dbus_hash_table_unref (pending_replies);
1237 _dbus_watch_list_free (watch_list);
1240 _dbus_timeout_list_free (timeout_list);
1242 if (outgoing_counter)
1243 _dbus_counter_unref (outgoing_counter);
1246 _dbus_object_tree_unref (objects);
1252 * Increments the reference count of a DBusConnection.
1253 * Requires that the caller already holds the connection lock.
1255 * @param connection the connection.
1256 * @returns the connection.
1259 _dbus_connection_ref_unlocked (DBusConnection *connection)
1261 _dbus_assert (connection != NULL);
1262 _dbus_assert (connection->generation == _dbus_current_generation);
1264 HAVE_LOCK_CHECK (connection);
1266 #ifdef DBUS_HAVE_ATOMIC_INT
1267 _dbus_atomic_inc (&connection->refcount);
1269 _dbus_assert (connection->refcount.value > 0);
1270 connection->refcount.value += 1;
1277 * Decrements the reference count of a DBusConnection.
1278 * Requires that the caller already holds the connection lock.
1280 * @param connection the connection.
1283 _dbus_connection_unref_unlocked (DBusConnection *connection)
1285 dbus_bool_t last_unref;
1287 HAVE_LOCK_CHECK (connection);
1289 _dbus_assert (connection != NULL);
1291 /* The connection lock is better than the global
1292 * lock in the atomic increment fallback
1295 #ifdef DBUS_HAVE_ATOMIC_INT
1296 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1298 _dbus_assert (connection->refcount.value > 0);
1300 connection->refcount.value -= 1;
1301 last_unref = (connection->refcount.value == 0);
1303 printf ("unref_unlocked() connection %p count = %d\n", connection, connection->refcount.value);
1308 _dbus_connection_last_unref (connection);
1311 static dbus_uint32_t
1312 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1316 serial = connection->client_serial++;
1318 if (connection->client_serial < 0)
1319 connection->client_serial = 1;
1325 * A callback for use with dbus_watch_new() to create a DBusWatch.
1327 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1328 * and the virtual handle_watch in DBusTransport if we got rid of it.
1329 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1332 * @param watch the watch.
1333 * @param condition the current condition of the file descriptors being watched.
1334 * @param data must be a pointer to a #DBusConnection
1335 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1338 _dbus_connection_handle_watch (DBusWatch *watch,
1339 unsigned int condition,
1342 DBusConnection *connection;
1344 DBusDispatchStatus status;
1348 _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
1350 CONNECTION_LOCK (connection);
1351 _dbus_connection_acquire_io_path (connection, -1);
1352 HAVE_LOCK_CHECK (connection);
1353 retval = _dbus_transport_handle_watch (connection->transport,
1356 _dbus_connection_release_io_path (connection);
1358 HAVE_LOCK_CHECK (connection);
1360 _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
1362 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1364 /* this calls out to user code */
1365 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1367 _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
1372 _DBUS_DEFINE_GLOBAL_LOCK (shared_connections);
1373 static DBusHashTable *shared_connections = NULL;
1376 shared_connections_shutdown (void *data)
1380 _DBUS_LOCK (shared_connections);
1382 /* This is a little bit unpleasant... better ideas? */
1383 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1385 DBusConnection *connection;
1386 DBusMessage *message;
1389 _dbus_hash_iter_init (shared_connections, &iter);
1390 _dbus_hash_iter_next (&iter);
1392 connection = _dbus_hash_iter_get_value (&iter);
1394 _DBUS_UNLOCK (shared_connections);
1396 dbus_connection_ref (connection);
1397 _dbus_connection_close_possibly_shared (connection);
1399 /* Churn through to the Disconnected message */
1400 while ((message = dbus_connection_pop_message (connection)))
1402 dbus_message_unref (message);
1404 dbus_connection_unref (connection);
1406 _DBUS_LOCK (shared_connections);
1408 /* The connection should now be dead and not in our hash ... */
1409 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1412 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1414 _dbus_hash_table_unref (shared_connections);
1415 shared_connections = NULL;
1417 _DBUS_UNLOCK (shared_connections);
1421 connection_lookup_shared (DBusAddressEntry *entry,
1422 DBusConnection **result)
1424 _dbus_verbose ("checking for existing connection\n");
1428 _DBUS_LOCK (shared_connections);
1430 if (shared_connections == NULL)
1432 _dbus_verbose ("creating shared_connections hash table\n");
1434 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1437 if (shared_connections == NULL)
1439 _DBUS_UNLOCK (shared_connections);
1443 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1445 _dbus_hash_table_unref (shared_connections);
1446 shared_connections = NULL;
1447 _DBUS_UNLOCK (shared_connections);
1451 _dbus_verbose (" successfully created shared_connections\n");
1453 _DBUS_UNLOCK (shared_connections);
1454 return TRUE; /* no point looking up in the hash we just made */
1460 guid = dbus_address_entry_get_value (entry, "guid");
1464 DBusConnection *connection;
1466 connection = _dbus_hash_table_lookup_string (shared_connections,
1471 /* The DBusConnection can't be finalized without taking
1472 * the shared_connections lock to remove it from the
1473 * hash. So it's safe to ref the connection here.
1474 * However, it may be disconnected if the Disconnected
1475 * message hasn't been processed yet, in which case we
1476 * want to pretend it isn't in the hash and avoid
1479 CONNECTION_LOCK (connection);
1480 if (_dbus_connection_get_is_connected_unlocked (connection))
1482 _dbus_connection_ref_unlocked (connection);
1483 *result = connection;
1484 _dbus_verbose ("looked up existing connection to server guid %s\n",
1489 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1492 CONNECTION_UNLOCK (connection);
1496 _DBUS_UNLOCK (shared_connections);
1502 connection_record_shared_unlocked (DBusConnection *connection,
1506 char *guid_in_connection;
1508 HAVE_LOCK_CHECK (connection);
1509 _dbus_assert (connection->server_guid == NULL);
1510 _dbus_assert (connection->shareable);
1512 /* get a hard ref on this connection, even if
1513 * we won't in fact store it in the hash, we still
1514 * need to hold a ref on it until it's disconnected.
1516 _dbus_connection_ref_unlocked (connection);
1519 return TRUE; /* don't store in the hash */
1521 /* A separate copy of the key is required in the hash table, because
1522 * we don't have a lock on the connection when we are doing a hash
1526 guid_key = _dbus_strdup (guid);
1527 if (guid_key == NULL)
1530 guid_in_connection = _dbus_strdup (guid);
1531 if (guid_in_connection == NULL)
1533 dbus_free (guid_key);
1537 _DBUS_LOCK (shared_connections);
1538 _dbus_assert (shared_connections != NULL);
1540 if (!_dbus_hash_table_insert_string (shared_connections,
1541 guid_key, connection))
1543 dbus_free (guid_key);
1544 dbus_free (guid_in_connection);
1545 _DBUS_UNLOCK (shared_connections);
1549 connection->server_guid = guid_in_connection;
1551 _dbus_verbose ("stored connection to %s to be shared\n",
1552 connection->server_guid);
1554 _DBUS_UNLOCK (shared_connections);
1556 _dbus_assert (connection->server_guid != NULL);
1562 connection_forget_shared_unlocked (DBusConnection *connection)
1564 HAVE_LOCK_CHECK (connection);
1566 if (!connection->shareable)
1569 if (connection->server_guid != NULL)
1571 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1572 connection->server_guid);
1574 _DBUS_LOCK (shared_connections);
1576 if (!_dbus_hash_table_remove_string (shared_connections,
1577 connection->server_guid))
1578 _dbus_assert_not_reached ("connection was not in the shared table");
1580 dbus_free (connection->server_guid);
1581 connection->server_guid = NULL;
1582 _DBUS_UNLOCK (shared_connections);
1585 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
1587 /* remove our reference held on all shareable connections */
1588 _dbus_connection_unref_unlocked (connection);
1591 static DBusConnection*
1592 connection_try_from_address_entry (DBusAddressEntry *entry,
1595 DBusTransport *transport;
1596 DBusConnection *connection;
1598 transport = _dbus_transport_open (entry, error);
1600 if (transport == NULL)
1602 _DBUS_ASSERT_ERROR_IS_SET (error);
1606 connection = _dbus_connection_new_for_transport (transport);
1608 _dbus_transport_unref (transport);
1610 if (connection == NULL)
1612 _DBUS_SET_OOM (error);
1616 #ifndef DBUS_DISABLE_CHECKS
1617 _dbus_assert (!connection->have_connection_lock);
1623 * If the shared parameter is true, then any existing connection will
1624 * be used (and if a new connection is created, it will be available
1625 * for use by others). If the shared parameter is false, a new
1626 * connection will always be created, and the new connection will
1627 * never be returned to other callers.
1629 * @param address the address
1630 * @param shared whether the connection is shared or private
1631 * @param error error return
1632 * @returns the connection or #NULL on error
1634 static DBusConnection*
1635 _dbus_connection_open_internal (const char *address,
1639 DBusConnection *connection;
1640 DBusAddressEntry **entries;
1641 DBusError tmp_error;
1642 DBusError first_error;
1645 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1647 _dbus_verbose ("opening %s connection to: %s\n",
1648 shared ? "shared" : "private", address);
1650 if (!dbus_parse_address (address, &entries, &len, error))
1653 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1657 dbus_error_init (&tmp_error);
1658 dbus_error_init (&first_error);
1659 for (i = 0; i < len; i++)
1663 if (!connection_lookup_shared (entries[i], &connection))
1664 _DBUS_SET_OOM (&tmp_error);
1667 if (connection == NULL)
1669 connection = connection_try_from_address_entry (entries[i],
1672 if (connection != NULL)
1674 CONNECTION_LOCK (connection);
1680 connection->shareable = TRUE;
1682 /* guid may be NULL */
1683 guid = dbus_address_entry_get_value (entries[i], "guid");
1685 if (!connection_record_shared_unlocked (connection, guid))
1687 _DBUS_SET_OOM (&tmp_error);
1688 _dbus_connection_close_possibly_shared_and_unlock (connection);
1689 dbus_connection_unref (connection);
1693 /* Note: as of now the connection is possibly shared
1694 * since another thread could have pulled it from the table.
1695 * However, we still have it locked so that thread isn't
1696 * doing anything more than blocking on the lock.
1704 HAVE_LOCK_CHECK (connection);
1708 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1711 dbus_move_error (&tmp_error, &first_error);
1713 dbus_error_free (&tmp_error);
1716 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1717 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1719 if (connection == NULL)
1721 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1722 dbus_move_error (&first_error, error);
1726 dbus_error_free (&first_error);
1728 CONNECTION_UNLOCK (connection);
1731 dbus_address_entries_free (entries);
1738 * @addtogroup DBusConnection
1744 * Gets a connection to a remote address. If a connection to the given
1745 * address already exists, returns the existing connection with its
1746 * reference count incremented. Otherwise, returns a new connection
1747 * and saves the new connection for possible re-use if a future call
1748 * to dbus_connection_open() asks to connect to the same server.
1750 * Use dbus_connection_open_private() to get a dedicated connection
1751 * not shared with other callers of dbus_connection_open().
1753 * If the open fails, the function returns #NULL, and provides a
1754 * reason for the failure in the error parameter. Pass #NULL for the
1755 * error parameter if you aren't interested in the reason for
1758 * Because this connection is shared, no user of the connection
1759 * may call dbus_connection_close(). However, when you are done with the
1760 * connection you should call dbus_connection_unref().
1762 * @param address the address.
1763 * @param error address where an error can be returned.
1764 * @returns new connection, or #NULL on failure.
1767 dbus_connection_open (const char *address,
1770 DBusConnection *connection;
1772 _dbus_return_val_if_fail (address != NULL, NULL);
1773 _dbus_return_val_if_error_is_set (error, NULL);
1775 connection = _dbus_connection_open_internal (address,
1783 * Opens a new, dedicated connection to a remote address. Unlike
1784 * dbus_connection_open(), always creates a new connection.
1785 * This connection will not be saved or recycled by libdbus.
1787 * If the open fails, the function returns #NULL, and provides a
1788 * reason for the failure in the error parameter. Pass #NULL for the
1789 * error parameter if you aren't interested in the reason for
1792 * When you are done with this connection, you must
1793 * dbus_connection_close() to disconnect it,
1794 * and dbus_connection_unref() to free the connection object.
1796 * (The dbus_connection_close() can be skipped if the
1797 * connection is already known to be disconnected, for example
1798 * if you are inside a handler for the Disconnected signal.)
1800 * @param address the address.
1801 * @param error address where an error can be returned.
1802 * @returns new connection, or #NULL on failure.
1805 dbus_connection_open_private (const char *address,
1808 DBusConnection *connection;
1810 _dbus_return_val_if_fail (address != NULL, NULL);
1811 _dbus_return_val_if_error_is_set (error, NULL);
1813 connection = _dbus_connection_open_internal (address,
1821 * Increments the reference count of a DBusConnection.
1823 * @param connection the connection.
1824 * @returns the connection.
1827 dbus_connection_ref (DBusConnection *connection)
1829 _dbus_return_val_if_fail (connection != NULL, NULL);
1830 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
1832 /* The connection lock is better than the global
1833 * lock in the atomic increment fallback
1836 #ifdef DBUS_HAVE_ATOMIC_INT
1837 _dbus_atomic_inc (&connection->refcount);
1839 CONNECTION_LOCK (connection);
1840 _dbus_assert (connection->refcount.value > 0);
1842 connection->refcount.value += 1;
1843 CONNECTION_UNLOCK (connection);
1850 free_outgoing_message (void *element,
1853 DBusMessage *message = element;
1854 DBusConnection *connection = data;
1856 _dbus_message_remove_size_counter (message,
1857 connection->outgoing_counter,
1859 dbus_message_unref (message);
1862 /* This is run without the mutex held, but after the last reference
1863 * to the connection has been dropped we should have no thread-related
1867 _dbus_connection_last_unref (DBusConnection *connection)
1871 _dbus_verbose ("Finalizing connection %p\n", connection);
1873 _dbus_assert (connection->refcount.value == 0);
1875 /* You have to disconnect the connection before unref:ing it. Otherwise
1876 * you won't get the disconnected message.
1878 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
1879 _dbus_assert (connection->server_guid == NULL);
1881 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
1882 _dbus_object_tree_free_all_unlocked (connection->objects);
1884 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
1885 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
1886 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
1888 _dbus_watch_list_free (connection->watches);
1889 connection->watches = NULL;
1891 _dbus_timeout_list_free (connection->timeouts);
1892 connection->timeouts = NULL;
1894 _dbus_data_slot_list_free (&connection->slot_list);
1896 link = _dbus_list_get_first_link (&connection->filter_list);
1897 while (link != NULL)
1899 DBusMessageFilter *filter = link->data;
1900 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
1902 filter->function = NULL;
1903 _dbus_message_filter_unref (filter); /* calls app callback */
1908 _dbus_list_clear (&connection->filter_list);
1910 /* ---- Done with stuff that invokes application callbacks */
1912 _dbus_object_tree_unref (connection->objects);
1914 _dbus_hash_table_unref (connection->pending_replies);
1915 connection->pending_replies = NULL;
1917 _dbus_list_clear (&connection->filter_list);
1919 _dbus_list_foreach (&connection->outgoing_messages,
1920 free_outgoing_message,
1922 _dbus_list_clear (&connection->outgoing_messages);
1924 _dbus_list_foreach (&connection->incoming_messages,
1925 (DBusForeachFunction) dbus_message_unref,
1927 _dbus_list_clear (&connection->incoming_messages);
1929 _dbus_counter_unref (connection->outgoing_counter);
1931 _dbus_transport_unref (connection->transport);
1933 if (connection->disconnect_message_link)
1935 DBusMessage *message = connection->disconnect_message_link->data;
1936 dbus_message_unref (message);
1937 _dbus_list_free_link (connection->disconnect_message_link);
1940 _dbus_list_clear (&connection->link_cache);
1942 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1943 _dbus_condvar_free_at_location (&connection->io_path_cond);
1945 _dbus_mutex_free_at_location (&connection->io_path_mutex);
1946 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
1948 _dbus_mutex_free_at_location (&connection->mutex);
1950 dbus_free (connection);
1954 * Decrements the reference count of a DBusConnection, and finalizes
1955 * it if the count reaches zero.
1957 * Note: it is a bug to drop the last reference to a connection that
1958 * is still connected.
1960 * For shared connections, libdbus will own a reference
1961 * as long as the connection is connected, so you can know that either
1962 * you don't have the last reference, or it's OK to drop the last reference.
1963 * Most connections are shared.
1965 * For private connections, the creator of the connection must arrange for
1966 * dbus_connection_close() to be called prior to dropping the last reference.
1967 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
1969 * @param connection the connection.
1972 dbus_connection_unref (DBusConnection *connection)
1974 dbus_bool_t last_unref;
1976 _dbus_return_if_fail (connection != NULL);
1977 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
1979 /* The connection lock is better than the global
1980 * lock in the atomic increment fallback
1983 #ifdef DBUS_HAVE_ATOMIC_INT
1984 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1986 CONNECTION_LOCK (connection);
1988 _dbus_assert (connection->refcount.value > 0);
1990 connection->refcount.value -= 1;
1991 last_unref = (connection->refcount.value == 0);
1994 printf ("unref() connection %p count = %d\n", connection, connection->refcount.value);
1997 CONNECTION_UNLOCK (connection);
2001 _dbus_connection_last_unref (connection);
2005 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2007 DBusDispatchStatus status;
2009 HAVE_LOCK_CHECK (connection);
2011 _dbus_verbose ("Disconnecting %p\n", connection);
2013 /* We need to ref because update_dispatch_status_and_unlock will unref
2014 * the connection if it was shared and libdbus was the only remaining
2017 _dbus_connection_ref_unlocked (connection);
2019 _dbus_transport_disconnect (connection->transport);
2021 _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
2022 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2024 /* this calls out to user code */
2025 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2027 /* could also call out to user code */
2028 dbus_connection_unref (connection);
2032 _dbus_connection_close_possibly_shared (DBusConnection *connection)
2034 _dbus_assert (connection != NULL);
2035 _dbus_assert (connection->generation == _dbus_current_generation);
2037 CONNECTION_LOCK (connection);
2038 _dbus_connection_close_possibly_shared_and_unlock (connection);
2042 * Closes a private connection, so no further data can be sent or received.
2043 * This disconnects the transport (such as a socket) underlying the
2046 * Attempts to send messages after closing a connection are safe, but will result in
2047 * error replies generated locally in libdbus.
2049 * This function does not affect the connection's reference count. It's
2050 * safe to close a connection more than once; all calls after the
2051 * first do nothing. It's impossible to "reopen" a connection, a
2052 * new connection must be created. This function may result in a call
2053 * to the DBusDispatchStatusFunction set with
2054 * dbus_connection_set_dispatch_status_function(), as the disconnect
2055 * message it generates needs to be dispatched.
2057 * If a connection is dropped by the remote application, it will
2060 * You must close a connection prior to releasing the last reference to
2061 * the connection. If you dbus_connection_unref() for the last time
2062 * without closing the connection, the results are undefined; it
2063 * is a bug in your program and libdbus will try to print a warning.
2065 * You may not close a shared connection. Connections created with
2066 * dbus_connection_open() or dbus_bus_get() are shared.
2067 * These connections are owned by libdbus, and applications should
2068 * only unref them, never close them. Applications can know it is
2069 * safe to unref these connections because libdbus will be holding a
2070 * reference as long as the connection is open. Thus, either the
2071 * connection is closed and it is OK to drop the last reference,
2072 * or the connection is open and the app knows it does not have the
2075 * Connections created with dbus_connection_open_private() or
2076 * dbus_bus_get_private() are not kept track of or referenced by
2077 * libdbus. The creator of these connections is responsible for
2078 * calling dbus_connection_close() prior to releasing the last
2079 * reference, if the connection is not already disconnected.
2081 * @param connection the private (unshared) connection to close
2084 dbus_connection_close (DBusConnection *connection)
2086 _dbus_return_if_fail (connection != NULL);
2087 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2089 CONNECTION_LOCK (connection);
2091 if (connection->shareable)
2093 CONNECTION_UNLOCK (connection);
2095 _dbus_warn ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2099 _dbus_connection_close_possibly_shared_and_unlock (connection);
2103 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2104 * If the new connection function does not ref the connection, we want to close it.
2106 * A bit of a hack, probably the new connection function should have returned a value
2107 * for whether to close, or should have had to close the connection itself if it
2110 * But, this works OK as long as the new connection function doesn't do anything
2111 * crazy like keep the connection around without ref'ing it.
2113 * We have to lock the connection across refcount check and close in case
2114 * the new connection function spawns a thread that closes and unrefs.
2115 * In that case, if the app thread
2116 * closes and unrefs first, we'll harmlessly close again; if the app thread
2117 * still has the ref, we'll close and then the app will close harmlessly.
2118 * If the app unrefs without closing, the app is broken since if the
2119 * app refs from the new connection function it is supposed to also close.
2121 * If we didn't atomically check the refcount and close with the lock held
2122 * though, we could screw this up.
2124 * @param connection the connection
2127 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2129 CONNECTION_LOCK (connection);
2131 _dbus_assert (connection->refcount.value > 0);
2133 if (connection->refcount.value == 1)
2134 _dbus_connection_close_possibly_shared_and_unlock (connection);
2136 CONNECTION_UNLOCK (connection);
2140 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2142 HAVE_LOCK_CHECK (connection);
2143 return _dbus_transport_get_is_connected (connection->transport);
2147 * Gets whether the connection is currently open. A connection may
2148 * become disconnected when the remote application closes its end, or
2149 * exits; a connection may also be disconnected with
2150 * dbus_connection_close().
2152 * There are not separate states for "closed" and "disconnected," the two
2153 * terms are synonymous. This function should really be called
2154 * get_is_open() but for historical reasons is not.
2156 * @param connection the connection.
2157 * @returns #TRUE if the connection is still alive.
2160 dbus_connection_get_is_connected (DBusConnection *connection)
2164 _dbus_return_val_if_fail (connection != NULL, FALSE);
2166 CONNECTION_LOCK (connection);
2167 res = _dbus_connection_get_is_connected_unlocked (connection);
2168 CONNECTION_UNLOCK (connection);
2174 * Gets whether the connection was authenticated. (Note that
2175 * if the connection was authenticated then disconnected,
2176 * this function still returns #TRUE)
2178 * @param connection the connection
2179 * @returns #TRUE if the connection was ever authenticated
2182 dbus_connection_get_is_authenticated (DBusConnection *connection)
2186 _dbus_return_val_if_fail (connection != NULL, FALSE);
2188 CONNECTION_LOCK (connection);
2189 res = _dbus_transport_get_is_authenticated (connection->transport);
2190 CONNECTION_UNLOCK (connection);
2196 * Set whether _exit() should be called when the connection receives a
2197 * disconnect signal. The call to _exit() comes after any handlers for
2198 * the disconnect signal run; handlers can cancel the exit by calling
2201 * By default, exit_on_disconnect is #FALSE; but for message bus
2202 * connections returned from dbus_bus_get() it will be toggled on
2205 * @param connection the connection
2206 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
2209 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
2210 dbus_bool_t exit_on_disconnect)
2212 _dbus_return_if_fail (connection != NULL);
2214 CONNECTION_LOCK (connection);
2215 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
2216 CONNECTION_UNLOCK (connection);
2219 static DBusPreallocatedSend*
2220 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
2222 DBusPreallocatedSend *preallocated;
2224 HAVE_LOCK_CHECK (connection);
2226 _dbus_assert (connection != NULL);
2228 preallocated = dbus_new (DBusPreallocatedSend, 1);
2229 if (preallocated == NULL)
2232 if (connection->link_cache != NULL)
2234 preallocated->queue_link =
2235 _dbus_list_pop_first_link (&connection->link_cache);
2236 preallocated->queue_link->data = NULL;
2240 preallocated->queue_link = _dbus_list_alloc_link (NULL);
2241 if (preallocated->queue_link == NULL)
2245 if (connection->link_cache != NULL)
2247 preallocated->counter_link =
2248 _dbus_list_pop_first_link (&connection->link_cache);
2249 preallocated->counter_link->data = connection->outgoing_counter;
2253 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
2254 if (preallocated->counter_link == NULL)
2258 _dbus_counter_ref (preallocated->counter_link->data);
2260 preallocated->connection = connection;
2262 return preallocated;
2265 _dbus_list_free_link (preallocated->queue_link);
2267 dbus_free (preallocated);
2273 * Preallocates resources needed to send a message, allowing the message
2274 * to be sent without the possibility of memory allocation failure.
2275 * Allows apps to create a future guarantee that they can send
2276 * a message regardless of memory shortages.
2278 * @param connection the connection we're preallocating for.
2279 * @returns the preallocated resources, or #NULL
2281 DBusPreallocatedSend*
2282 dbus_connection_preallocate_send (DBusConnection *connection)
2284 DBusPreallocatedSend *preallocated;
2286 _dbus_return_val_if_fail (connection != NULL, NULL);
2288 CONNECTION_LOCK (connection);
2291 _dbus_connection_preallocate_send_unlocked (connection);
2293 CONNECTION_UNLOCK (connection);
2295 return preallocated;
2299 * Frees preallocated message-sending resources from
2300 * dbus_connection_preallocate_send(). Should only
2301 * be called if the preallocated resources are not used
2302 * to send a message.
2304 * @param connection the connection
2305 * @param preallocated the resources
2308 dbus_connection_free_preallocated_send (DBusConnection *connection,
2309 DBusPreallocatedSend *preallocated)
2311 _dbus_return_if_fail (connection != NULL);
2312 _dbus_return_if_fail (preallocated != NULL);
2313 _dbus_return_if_fail (connection == preallocated->connection);
2315 _dbus_list_free_link (preallocated->queue_link);
2316 _dbus_counter_unref (preallocated->counter_link->data);
2317 _dbus_list_free_link (preallocated->counter_link);
2318 dbus_free (preallocated);
2321 /* Called with lock held, does not update dispatch status */
2323 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
2324 DBusPreallocatedSend *preallocated,
2325 DBusMessage *message,
2326 dbus_uint32_t *client_serial)
2328 dbus_uint32_t serial;
2331 preallocated->queue_link->data = message;
2332 _dbus_list_prepend_link (&connection->outgoing_messages,
2333 preallocated->queue_link);
2335 _dbus_message_add_size_counter_link (message,
2336 preallocated->counter_link);
2338 dbus_free (preallocated);
2339 preallocated = NULL;
2341 dbus_message_ref (message);
2343 connection->n_outgoing += 1;
2345 sig = dbus_message_get_signature (message);
2347 _dbus_verbose ("Message %p (%d %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
2349 dbus_message_get_type (message),
2350 dbus_message_get_path (message) ?
2351 dbus_message_get_path (message) :
2353 dbus_message_get_interface (message) ?
2354 dbus_message_get_interface (message) :
2356 dbus_message_get_member (message) ?
2357 dbus_message_get_member (message) :
2360 dbus_message_get_destination (message) ?
2361 dbus_message_get_destination (message) :
2364 connection->n_outgoing);
2366 if (dbus_message_get_serial (message) == 0)
2368 serial = _dbus_connection_get_next_client_serial (connection);
2369 _dbus_message_set_serial (message, serial);
2371 *client_serial = serial;
2376 *client_serial = dbus_message_get_serial (message);
2379 _dbus_verbose ("Message %p serial is %u\n",
2380 message, dbus_message_get_serial (message));
2382 _dbus_message_lock (message);
2384 /* Now we need to run an iteration to hopefully just write the messages
2385 * out immediately, and otherwise get them queued up
2387 _dbus_connection_do_iteration_unlocked (connection,
2388 DBUS_ITERATION_DO_WRITING,
2391 /* If stuff is still queued up, be sure we wake up the main loop */
2392 if (connection->n_outgoing > 0)
2393 _dbus_connection_wakeup_mainloop (connection);
2397 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2398 DBusPreallocatedSend *preallocated,
2399 DBusMessage *message,
2400 dbus_uint32_t *client_serial)
2402 DBusDispatchStatus status;
2404 HAVE_LOCK_CHECK (connection);
2406 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2408 message, client_serial);
2410 _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
2411 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2413 /* this calls out to user code */
2414 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2418 * Sends a message using preallocated resources. This function cannot fail.
2419 * It works identically to dbus_connection_send() in other respects.
2420 * Preallocated resources comes from dbus_connection_preallocate_send().
2421 * This function "consumes" the preallocated resources, they need not
2422 * be freed separately.
2424 * @param connection the connection
2425 * @param preallocated the preallocated resources
2426 * @param message the message to send
2427 * @param client_serial return location for client serial assigned to the message
2430 dbus_connection_send_preallocated (DBusConnection *connection,
2431 DBusPreallocatedSend *preallocated,
2432 DBusMessage *message,
2433 dbus_uint32_t *client_serial)
2435 _dbus_return_if_fail (connection != NULL);
2436 _dbus_return_if_fail (preallocated != NULL);
2437 _dbus_return_if_fail (message != NULL);
2438 _dbus_return_if_fail (preallocated->connection == connection);
2439 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
2440 dbus_message_get_member (message) != NULL);
2441 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
2442 (dbus_message_get_interface (message) != NULL &&
2443 dbus_message_get_member (message) != NULL));
2445 CONNECTION_LOCK (connection);
2446 _dbus_connection_send_preallocated_and_unlock (connection,
2448 message, client_serial);
2452 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
2453 DBusMessage *message,
2454 dbus_uint32_t *client_serial)
2456 DBusPreallocatedSend *preallocated;
2458 _dbus_assert (connection != NULL);
2459 _dbus_assert (message != NULL);
2461 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2462 if (preallocated == NULL)
2465 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2473 _dbus_connection_send_and_unlock (DBusConnection *connection,
2474 DBusMessage *message,
2475 dbus_uint32_t *client_serial)
2477 DBusPreallocatedSend *preallocated;
2479 _dbus_assert (connection != NULL);
2480 _dbus_assert (message != NULL);
2482 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2483 if (preallocated == NULL)
2485 CONNECTION_UNLOCK (connection);
2489 _dbus_connection_send_preallocated_and_unlock (connection,
2497 * Adds a message to the outgoing message queue. Does not block to
2498 * write the message to the network; that happens asynchronously. To
2499 * force the message to be written, call dbus_connection_flush().
2500 * Because this only queues the message, the only reason it can
2501 * fail is lack of memory. Even if the connection is disconnected,
2502 * no error will be returned.
2504 * If the function fails due to lack of memory, it returns #FALSE.
2505 * The function will never fail for other reasons; even if the
2506 * connection is disconnected, you can queue an outgoing message,
2507 * though obviously it won't be sent.
2509 * @param connection the connection.
2510 * @param message the message to write.
2511 * @param client_serial return location for client serial.
2512 * @returns #TRUE on success.
2515 dbus_connection_send (DBusConnection *connection,
2516 DBusMessage *message,
2517 dbus_uint32_t *client_serial)
2519 _dbus_return_val_if_fail (connection != NULL, FALSE);
2520 _dbus_return_val_if_fail (message != NULL, FALSE);
2522 CONNECTION_LOCK (connection);
2524 return _dbus_connection_send_and_unlock (connection,
2530 reply_handler_timeout (void *data)
2532 DBusConnection *connection;
2533 DBusDispatchStatus status;
2534 DBusPendingCall *pending = data;
2536 connection = _dbus_pending_call_get_connection_and_lock (pending);
2538 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2540 _dbus_connection_remove_timeout_unlocked (connection,
2541 _dbus_pending_call_get_timeout_unlocked (pending));
2542 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2544 _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
2545 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2547 /* Unlocks, and calls out to user code */
2548 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2554 * Queues a message to send, as with dbus_connection_send_message(),
2555 * but also returns a #DBusPendingCall used to receive a reply to the
2556 * message. If no reply is received in the given timeout_milliseconds,
2557 * this function expires the pending reply and generates a synthetic
2558 * error reply (generated in-process, not by the remote application)
2559 * indicating that a timeout occurred.
2561 * A #DBusPendingCall will see a reply message after any filters, but
2562 * before any object instances or other handlers. A #DBusPendingCall
2563 * will always see exactly one reply message, unless it's cancelled
2564 * with dbus_pending_call_cancel().
2566 * If a filter filters out the reply before the handler sees it, the
2567 * reply is immediately timed out and a timeout error reply is
2568 * generated. If a filter removes the timeout error reply then the
2569 * #DBusPendingCall will get confused. Filtering the timeout error
2570 * is thus considered a bug and will print a warning.
2572 * If #NULL is passed for the pending_return, the #DBusPendingCall
2573 * will still be generated internally, and used to track
2574 * the message reply timeout. This means a timeout error will
2575 * occur if no reply arrives, unlike with dbus_connection_send().
2577 * If -1 is passed for the timeout, a sane default timeout is used. -1
2578 * is typically the best value for the timeout for this reason, unless
2579 * you want a very short or very long timeout. There is no way to
2580 * avoid a timeout entirely, other than passing INT_MAX for the
2581 * timeout to postpone it indefinitely.
2583 * @param connection the connection
2584 * @param message the message to send
2585 * @param pending_return return location for a #DBusPendingCall object, or #NULLif connection is disconnected
2586 * @param timeout_milliseconds timeout in milliseconds or -1 for default
2587 * @returns #FALSE if no memory, #TRUE otherwise.
2591 dbus_connection_send_with_reply (DBusConnection *connection,
2592 DBusMessage *message,
2593 DBusPendingCall **pending_return,
2594 int timeout_milliseconds)
2596 DBusPendingCall *pending;
2597 dbus_int32_t serial = -1;
2598 DBusDispatchStatus status;
2600 _dbus_return_val_if_fail (connection != NULL, FALSE);
2601 _dbus_return_val_if_fail (message != NULL, FALSE);
2602 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
2605 *pending_return = NULL;
2607 CONNECTION_LOCK (connection);
2609 if (!_dbus_connection_get_is_connected_unlocked (connection))
2611 CONNECTION_UNLOCK (connection);
2613 *pending_return = NULL;
2618 pending = _dbus_pending_call_new_unlocked (connection,
2619 timeout_milliseconds,
2620 reply_handler_timeout);
2622 if (pending == NULL)
2624 CONNECTION_UNLOCK (connection);
2628 /* Assign a serial to the message */
2629 serial = dbus_message_get_serial (message);
2632 serial = _dbus_connection_get_next_client_serial (connection);
2633 _dbus_message_set_serial (message, serial);
2636 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
2639 /* Insert the serial in the pending replies hash;
2640 * hash takes a refcount on DBusPendingCall.
2641 * Also, add the timeout.
2643 if (!_dbus_connection_attach_pending_call_unlocked (connection,
2647 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
2649 _dbus_connection_detach_pending_call_and_unlock (connection,
2651 goto error_unlocked;
2655 *pending_return = pending; /* hand off refcount */
2658 _dbus_connection_detach_pending_call_unlocked (connection, pending);
2659 /* we still have a ref to the pending call in this case, we unref
2660 * after unlocking, below
2664 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2666 /* this calls out to user code */
2667 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2669 if (pending_return == NULL)
2670 dbus_pending_call_unref (pending);
2675 CONNECTION_UNLOCK (connection);
2677 dbus_pending_call_unref (pending);
2681 /* This is slightly strange since we can pop a message here without
2682 * the dispatch lock.
2685 check_for_reply_unlocked (DBusConnection *connection,
2686 dbus_uint32_t client_serial)
2690 HAVE_LOCK_CHECK (connection);
2692 link = _dbus_list_get_first_link (&connection->incoming_messages);
2694 while (link != NULL)
2696 DBusMessage *reply = link->data;
2698 if (dbus_message_get_reply_serial (reply) == client_serial)
2700 _dbus_list_remove_link (&connection->incoming_messages, link);
2701 connection->n_incoming -= 1;
2704 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2711 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2713 /* We can't iterate over the hash in the normal way since we'll be
2714 * dropping the lock for each item. So we restart the
2715 * iter each time as we drain the hash table.
2718 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2720 DBusPendingCall *pending;
2723 _dbus_hash_iter_init (connection->pending_replies, &iter);
2724 _dbus_hash_iter_next (&iter);
2726 pending = _dbus_hash_iter_get_value (&iter);
2727 _dbus_pending_call_ref_unlocked (pending);
2729 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2731 _dbus_connection_remove_timeout_unlocked (connection,
2732 _dbus_pending_call_get_timeout_unlocked (pending));
2733 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2734 _dbus_hash_iter_remove_entry (&iter);
2736 _dbus_pending_call_unref_and_unlock (pending);
2737 CONNECTION_LOCK (connection);
2739 HAVE_LOCK_CHECK (connection);
2743 complete_pending_call_and_unlock (DBusConnection *connection,
2744 DBusPendingCall *pending,
2745 DBusMessage *message)
2747 _dbus_pending_call_set_reply_unlocked (pending, message);
2748 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2749 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2751 /* Must be called unlocked since it invokes app callback */
2752 _dbus_pending_call_complete (pending);
2753 dbus_pending_call_unref (pending);
2757 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2758 DBusPendingCall *pending)
2761 DBusDispatchStatus status;
2763 reply = check_for_reply_unlocked (connection,
2764 _dbus_pending_call_get_reply_serial_unlocked (pending));
2767 _dbus_verbose ("%s checked for reply\n", _DBUS_FUNCTION_NAME);
2769 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2771 complete_pending_call_and_unlock (connection, pending, reply);
2772 dbus_message_unref (reply);
2774 CONNECTION_LOCK (connection);
2775 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2776 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2777 dbus_pending_call_unref (pending);
2786 * When a function that blocks has been called with a timeout, and we
2787 * run out of memory, the time to wait for memory is based on the
2788 * timeout. If the caller was willing to block a long time we wait a
2789 * relatively long time for memory, if they were only willing to block
2790 * briefly then we retry for memory at a rapid rate.
2792 * @timeout_milliseconds the timeout requested for blocking
2795 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2797 if (timeout_milliseconds == -1)
2798 _dbus_sleep_milliseconds (1000);
2799 else if (timeout_milliseconds < 100)
2800 ; /* just busy loop */
2801 else if (timeout_milliseconds <= 1000)
2802 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2804 _dbus_sleep_milliseconds (1000);
2807 static DBusMessage *
2808 generate_local_error_message (dbus_uint32_t serial,
2812 DBusMessage *message;
2813 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2817 if (!dbus_message_set_error_name (message, error_name))
2819 dbus_message_unref (message);
2824 dbus_message_set_no_reply (message, TRUE);
2826 if (!dbus_message_set_reply_serial (message,
2829 dbus_message_unref (message);
2834 if (error_msg != NULL)
2836 DBusMessageIter iter;
2838 dbus_message_iter_init_append (message, &iter);
2839 if (!dbus_message_iter_append_basic (&iter,
2843 dbus_message_unref (message);
2854 * Blocks until a pending call times out or gets a reply.
2856 * Does not re-enter the main loop or run filter/path-registered
2857 * callbacks. The reply to the message will not be seen by
2860 * Returns immediately if pending call already got a reply.
2862 * @todo could use performance improvements (it keeps scanning
2863 * the whole message queue for example)
2865 * @param pending the pending call we block for a reply on
2868 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2870 long start_tv_sec, start_tv_usec;
2871 long end_tv_sec, end_tv_usec;
2872 long tv_sec, tv_usec;
2873 DBusDispatchStatus status;
2874 DBusConnection *connection;
2875 dbus_uint32_t client_serial;
2876 int timeout_milliseconds;
2878 _dbus_assert (pending != NULL);
2880 if (dbus_pending_call_get_completed (pending))
2883 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2885 connection = _dbus_pending_call_get_connection_and_lock (pending);
2887 /* Flush message queue - note, can affect dispatch status */
2888 _dbus_connection_flush_unlocked (connection);
2890 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2892 /* note that timeout_milliseconds is limited to a smallish value
2893 * in _dbus_pending_call_new() so overflows aren't possible
2896 timeout_milliseconds = dbus_timeout_get_interval (_dbus_pending_call_get_timeout_unlocked (pending));
2898 _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
2899 end_tv_sec = start_tv_sec + timeout_milliseconds / 1000;
2900 end_tv_usec = start_tv_usec + (timeout_milliseconds % 1000) * 1000;
2901 end_tv_sec += end_tv_usec / _DBUS_USEC_PER_SECOND;
2902 end_tv_usec = end_tv_usec % _DBUS_USEC_PER_SECOND;
2904 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec to %ld sec %ld usec\n",
2905 timeout_milliseconds,
2907 start_tv_sec, start_tv_usec,
2908 end_tv_sec, end_tv_usec);
2910 /* check to see if we already got the data off the socket */
2911 /* from another blocked pending call */
2912 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2915 /* Now we wait... */
2916 /* always block at least once as we know we don't have the reply yet */
2917 _dbus_connection_do_iteration_unlocked (connection,
2918 DBUS_ITERATION_DO_READING |
2919 DBUS_ITERATION_BLOCK,
2920 timeout_milliseconds);
2924 _dbus_verbose ("%s top of recheck\n", _DBUS_FUNCTION_NAME);
2926 HAVE_LOCK_CHECK (connection);
2928 /* queue messages and get status */
2930 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2932 /* the get_completed() is in case a dispatch() while we were blocking
2933 * got the reply instead of us.
2935 if (_dbus_pending_call_get_completed_unlocked (pending))
2937 _dbus_verbose ("Pending call completed by dispatch in %s\n", _DBUS_FUNCTION_NAME);
2938 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2939 dbus_pending_call_unref (pending);
2943 if (status == DBUS_DISPATCH_DATA_REMAINS) {
2944 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2948 _dbus_get_current_time (&tv_sec, &tv_usec);
2950 if (!_dbus_connection_get_is_connected_unlocked (connection))
2952 DBusMessage *error_msg;
2954 error_msg = generate_local_error_message (client_serial,
2955 DBUS_ERROR_DISCONNECTED,
2956 "Connection was disconnected before a reply was received");
2958 /* on OOM error_msg is set to NULL */
2959 complete_pending_call_and_unlock (connection, pending, error_msg);
2960 dbus_pending_call_unref (pending);
2963 else if (tv_sec < start_tv_sec)
2964 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2965 else if (connection->disconnect_message_link == NULL)
2966 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2967 else if (tv_sec < end_tv_sec ||
2968 (tv_sec == end_tv_sec && tv_usec < end_tv_usec))
2970 timeout_milliseconds = (end_tv_sec - tv_sec) * 1000 +
2971 (end_tv_usec - tv_usec) / 1000;
2972 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds);
2973 _dbus_assert (timeout_milliseconds >= 0);
2975 if (status == DBUS_DISPATCH_NEED_MEMORY)
2977 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2978 * we may already have a reply in the buffer and just can't process
2981 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2983 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
2987 /* block again, we don't have the reply buffered yet. */
2988 _dbus_connection_do_iteration_unlocked (connection,
2989 DBUS_ITERATION_DO_READING |
2990 DBUS_ITERATION_BLOCK,
2991 timeout_milliseconds);
2994 goto recheck_status;
2997 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %ld milliseconds and got no reply\n",
2998 (tv_sec - start_tv_sec) * 1000 + (tv_usec - start_tv_usec) / 1000);
3000 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
3002 /* unlock and call user code */
3003 complete_pending_call_and_unlock (connection, pending, NULL);
3005 /* update user code on dispatch status */
3006 CONNECTION_LOCK (connection);
3007 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3008 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3009 dbus_pending_call_unref (pending);
3013 * Sends a message and blocks a certain time period while waiting for
3014 * a reply. This function does not reenter the main loop,
3015 * i.e. messages other than the reply are queued up but not
3016 * processed. This function is used to do non-reentrant "method
3019 * If a normal reply is received, it is returned, and removed from the
3020 * incoming message queue. If it is not received, #NULL is returned
3021 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3022 * received, it is converted to a #DBusError and returned as an error,
3023 * then the reply message is deleted. If something else goes wrong,
3024 * result is set to whatever is appropriate, such as
3025 * #DBUS_ERROR_NO_MEMORY or #DBUS_ERROR_DISCONNECTED.
3027 * @param connection the connection
3028 * @param message the message to send
3029 * @param timeout_milliseconds timeout in milliseconds or -1 for default
3030 * @param error return location for error message
3031 * @returns the message that is the reply or #NULL with an error code if the
3035 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3036 DBusMessage *message,
3037 int timeout_milliseconds,
3041 DBusPendingCall *pending;
3043 _dbus_return_val_if_fail (connection != NULL, NULL);
3044 _dbus_return_val_if_fail (message != NULL, NULL);
3045 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3046 _dbus_return_val_if_error_is_set (error, NULL);
3048 if (!dbus_connection_send_with_reply (connection, message,
3049 &pending, timeout_milliseconds))
3051 _DBUS_SET_OOM (error);
3055 _dbus_assert (pending != NULL);
3057 dbus_pending_call_block (pending);
3059 reply = dbus_pending_call_steal_reply (pending);
3060 dbus_pending_call_unref (pending);
3062 /* call_complete_and_unlock() called from pending_call_block() should
3063 * always fill this in.
3065 _dbus_assert (reply != NULL);
3067 if (dbus_set_error_from_message (error, reply))
3069 dbus_message_unref (reply);
3077 * Blocks until the outgoing message queue is empty.
3078 * Assumes connection lock already held.
3080 * If you call this, you MUST call update_dispatch_status afterword...
3082 * @param connection the connection.
3085 _dbus_connection_flush_unlocked (DBusConnection *connection)
3087 /* We have to specify DBUS_ITERATION_DO_READING here because
3088 * otherwise we could have two apps deadlock if they are both doing
3089 * a flush(), and the kernel buffers fill up. This could change the
3092 DBusDispatchStatus status;
3094 HAVE_LOCK_CHECK (connection);
3096 while (connection->n_outgoing > 0 &&
3097 _dbus_connection_get_is_connected_unlocked (connection))
3099 _dbus_verbose ("doing iteration in %s\n", _DBUS_FUNCTION_NAME);
3100 HAVE_LOCK_CHECK (connection);
3101 _dbus_connection_do_iteration_unlocked (connection,
3102 DBUS_ITERATION_DO_READING |
3103 DBUS_ITERATION_DO_WRITING |
3104 DBUS_ITERATION_BLOCK,
3108 HAVE_LOCK_CHECK (connection);
3109 _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
3110 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3112 HAVE_LOCK_CHECK (connection);
3117 * Blocks until the outgoing message queue is empty.
3119 * @param connection the connection.
3122 dbus_connection_flush (DBusConnection *connection)
3124 /* We have to specify DBUS_ITERATION_DO_READING here because
3125 * otherwise we could have two apps deadlock if they are both doing
3126 * a flush(), and the kernel buffers fill up. This could change the
3129 DBusDispatchStatus status;
3131 _dbus_return_if_fail (connection != NULL);
3133 CONNECTION_LOCK (connection);
3135 status = _dbus_connection_flush_unlocked (connection);
3137 HAVE_LOCK_CHECK (connection);
3138 /* Unlocks and calls out to user code */
3139 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3141 _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
3145 * This function is intended for use with applications that don't want
3146 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3147 * example usage would be:
3150 * while (dbus_connection_read_write_dispatch (connection, -1))
3151 * ; // empty loop body
3154 * In this usage you would normally have set up a filter function to look
3155 * at each message as it is dispatched. The loop terminates when the last
3156 * message from the connection (the disconnected signal) is processed.
3158 * If there are messages to dispatch and the dispatch flag is set, this
3159 * function will dbus_connection_dispatch() once, and return. If there are no
3160 * messages to dispatch, this function will block until it can read or write,
3161 * then read or write, then return.
3163 * The way to think of this function is that it either makes some sort
3164 * of progress, or it blocks.
3166 * The return value indicates whether the disconnect message has been
3167 * processed, NOT whether the connection is connected. This is
3168 * important because even after disconnecting, you want to process any
3169 * messages you received prior to the disconnect.
3171 * @param connection the connection
3172 * @param timeout_milliseconds max time to block or -1 for infinite
3173 * @param dispatch dispatch new messages or leave them on the incoming queue
3174 * @returns #TRUE if the disconnect message has not been processed
3177 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3178 int timeout_milliseconds,
3179 dbus_bool_t dispatch)
3181 DBusDispatchStatus dstatus;
3182 dbus_bool_t dispatched_disconnected;
3184 dstatus = dbus_connection_get_dispatch_status (connection);
3186 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3188 _dbus_verbose ("doing dispatch in %s\n", _DBUS_FUNCTION_NAME);
3189 dbus_connection_dispatch (connection);
3190 CONNECTION_LOCK (connection);
3192 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3194 _dbus_verbose ("pausing for memory in %s\n", _DBUS_FUNCTION_NAME);
3195 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3196 CONNECTION_LOCK (connection);
3200 CONNECTION_LOCK (connection);
3201 if (_dbus_connection_get_is_connected_unlocked (connection))
3203 _dbus_verbose ("doing iteration in %s\n", _DBUS_FUNCTION_NAME);
3204 _dbus_connection_do_iteration_unlocked (connection,
3205 DBUS_ITERATION_DO_READING |
3206 DBUS_ITERATION_DO_WRITING |
3207 DBUS_ITERATION_BLOCK,
3208 timeout_milliseconds);
3212 HAVE_LOCK_CHECK (connection);
3213 dispatched_disconnected = connection->n_incoming == 0 &&
3214 connection->disconnect_message_link == NULL;
3215 CONNECTION_UNLOCK (connection);
3216 return !dispatched_disconnected; /* TRUE if we have not processed disconnected */
3221 * This function is intended for use with applications that don't want
3222 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3223 * example usage would be:
3226 * while (dbus_connection_read_write_dispatch (connection, -1))
3227 * ; // empty loop body
3230 * In this usage you would normally have set up a filter function to look
3231 * at each message as it is dispatched. The loop terminates when the last
3232 * message from the connection (the disconnected signal) is processed.
3234 * If there are messages to dispatch, this function will
3235 * dbus_connection_dispatch() once, and return. If there are no
3236 * messages to dispatch, this function will block until it can read or
3237 * write, then read or write, then return.
3239 * The way to think of this function is that it either makes some sort
3240 * of progress, or it blocks.
3242 * The return value indicates whether the disconnect message has been
3243 * processed, NOT whether the connection is connected. This is
3244 * important because even after disconnecting, you want to process any
3245 * messages you received prior to the disconnect.
3247 * @param connection the connection
3248 * @param timeout_milliseconds max time to block or -1 for infinite
3249 * @returns #TRUE if the disconnect message has not been processed
3252 dbus_connection_read_write_dispatch (DBusConnection *connection,
3253 int timeout_milliseconds)
3255 _dbus_return_val_if_fail (connection != NULL, FALSE);
3256 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3257 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3261 * This function is intended for use with applications that don't want to
3262 * write a main loop and deal with #DBusWatch and #DBusTimeout.
3264 * If there are no messages to dispatch, this function will block until it can
3265 * read or write, then read or write, then return.
3267 * The return value indicates whether the disconnect message has been
3268 * processed, NOT whether the connection is connected. This is important
3269 * because even after disconnecting, you want to process any messages you
3270 * received prior to the disconnect.
3272 * @param connection the connection
3273 * @param timeout_milliseconds max time to block or -1 for infinite
3274 * @returns #TRUE if the disconnect message has not been processed
3277 dbus_connection_read_write (DBusConnection *connection,
3278 int timeout_milliseconds)
3280 _dbus_return_val_if_fail (connection != NULL, FALSE);
3281 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3282 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3285 /* We need to call this anytime we pop the head of the queue, and then
3286 * update_dispatch_status_and_unlock needs to be called afterward
3287 * which will "process" the disconnected message and set
3288 * disconnected_message_processed.
3291 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3292 DBusMessage *head_of_queue)
3294 HAVE_LOCK_CHECK (connection);
3296 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3297 if (connection->disconnect_message_link == NULL &&
3298 dbus_message_is_signal (head_of_queue,
3299 DBUS_INTERFACE_LOCAL,
3302 connection->disconnected_message_arrived = TRUE;
3307 * Returns the first-received message from the incoming message queue,
3308 * leaving it in the queue. If the queue is empty, returns #NULL.
3310 * The caller does not own a reference to the returned message, and
3311 * must either return it using dbus_connection_return_message() or
3312 * keep it after calling dbus_connection_steal_borrowed_message(). No
3313 * one can get at the message while its borrowed, so return it as
3314 * quickly as possible and don't keep a reference to it after
3315 * returning it. If you need to keep the message, make a copy of it.
3317 * dbus_connection_dispatch() will block if called while a borrowed
3318 * message is outstanding; only one piece of code can be playing with
3319 * the incoming queue at a time. This function will block if called
3320 * during a dbus_connection_dispatch().
3322 * @param connection the connection.
3323 * @returns next message in the incoming queue.
3326 dbus_connection_borrow_message (DBusConnection *connection)
3328 DBusDispatchStatus status;
3329 DBusMessage *message;
3331 _dbus_return_val_if_fail (connection != NULL, NULL);
3333 _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3335 /* this is called for the side effect that it queues
3336 * up any messages from the transport
3338 status = dbus_connection_get_dispatch_status (connection);
3339 if (status != DBUS_DISPATCH_DATA_REMAINS)
3342 CONNECTION_LOCK (connection);
3344 _dbus_connection_acquire_dispatch (connection);
3346 /* While a message is outstanding, the dispatch lock is held */
3347 _dbus_assert (connection->message_borrowed == NULL);
3349 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3351 message = connection->message_borrowed;
3353 check_disconnected_message_arrived_unlocked (connection, message);
3355 /* Note that we KEEP the dispatch lock until the message is returned */
3356 if (message == NULL)
3357 _dbus_connection_release_dispatch (connection);
3359 CONNECTION_UNLOCK (connection);
3361 /* We don't update dispatch status until it's returned or stolen */
3367 * Used to return a message after peeking at it using
3368 * dbus_connection_borrow_message(). Only called if
3369 * message from dbus_connection_borrow_message() was non-#NULL.
3371 * @param connection the connection
3372 * @param message the message from dbus_connection_borrow_message()
3375 dbus_connection_return_message (DBusConnection *connection,
3376 DBusMessage *message)
3378 DBusDispatchStatus status;
3380 _dbus_return_if_fail (connection != NULL);
3381 _dbus_return_if_fail (message != NULL);
3382 _dbus_return_if_fail (message == connection->message_borrowed);
3383 _dbus_return_if_fail (connection->dispatch_acquired);
3385 CONNECTION_LOCK (connection);
3387 _dbus_assert (message == connection->message_borrowed);
3389 connection->message_borrowed = NULL;
3391 _dbus_connection_release_dispatch (connection);
3393 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3394 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3398 * Used to keep a message after peeking at it using
3399 * dbus_connection_borrow_message(). Before using this function, see
3400 * the caveats/warnings in the documentation for
3401 * dbus_connection_pop_message().
3403 * @param connection the connection
3404 * @param message the message from dbus_connection_borrow_message()
3407 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3408 DBusMessage *message)
3410 DBusMessage *pop_message;
3411 DBusDispatchStatus status;
3413 _dbus_return_if_fail (connection != NULL);
3414 _dbus_return_if_fail (message != NULL);
3415 _dbus_return_if_fail (message == connection->message_borrowed);
3416 _dbus_return_if_fail (connection->dispatch_acquired);
3418 CONNECTION_LOCK (connection);
3420 _dbus_assert (message == connection->message_borrowed);
3422 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3423 _dbus_assert (message == pop_message);
3425 connection->n_incoming -= 1;
3427 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3428 message, connection->n_incoming);
3430 connection->message_borrowed = NULL;
3432 _dbus_connection_release_dispatch (connection);
3434 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3435 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3438 /* See dbus_connection_pop_message, but requires the caller to own
3439 * the lock before calling. May drop the lock while running.
3442 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3444 HAVE_LOCK_CHECK (connection);
3446 _dbus_assert (connection->message_borrowed == NULL);
3448 if (connection->n_incoming > 0)
3452 link = _dbus_list_pop_first_link (&connection->incoming_messages);
3453 connection->n_incoming -= 1;
3455 _dbus_verbose ("Message %p (%d %s %s %s '%s') removed from incoming queue %p, %d incoming\n",
3457 dbus_message_get_type (link->data),
3458 dbus_message_get_path (link->data) ?
3459 dbus_message_get_path (link->data) :
3461 dbus_message_get_interface (link->data) ?
3462 dbus_message_get_interface (link->data) :
3464 dbus_message_get_member (link->data) ?
3465 dbus_message_get_member (link->data) :
3467 dbus_message_get_signature (link->data),
3468 connection, connection->n_incoming);
3470 check_disconnected_message_arrived_unlocked (connection, link->data);
3478 /* See dbus_connection_pop_message, but requires the caller to own
3479 * the lock before calling. May drop the lock while running.
3482 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3486 HAVE_LOCK_CHECK (connection);
3488 link = _dbus_connection_pop_message_link_unlocked (connection);
3492 DBusMessage *message;
3494 message = link->data;
3496 _dbus_list_free_link (link);
3505 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
3506 DBusList *message_link)
3508 HAVE_LOCK_CHECK (connection);
3510 _dbus_assert (message_link != NULL);
3511 /* You can't borrow a message while a link is outstanding */
3512 _dbus_assert (connection->message_borrowed == NULL);
3513 /* We had to have the dispatch lock across the pop/putback */
3514 _dbus_assert (connection->dispatch_acquired);
3516 _dbus_list_prepend_link (&connection->incoming_messages,
3518 connection->n_incoming += 1;
3520 _dbus_verbose ("Message %p (%d %s %s '%s') put back into queue %p, %d incoming\n",
3522 dbus_message_get_type (message_link->data),
3523 dbus_message_get_interface (message_link->data) ?
3524 dbus_message_get_interface (message_link->data) :
3526 dbus_message_get_member (message_link->data) ?
3527 dbus_message_get_member (message_link->data) :
3529 dbus_message_get_signature (message_link->data),
3530 connection, connection->n_incoming);
3534 * Returns the first-received message from the incoming message queue,
3535 * removing it from the queue. The caller owns a reference to the
3536 * returned message. If the queue is empty, returns #NULL.
3538 * This function bypasses any message handlers that are registered,
3539 * and so using it is usually wrong. Instead, let the main loop invoke
3540 * dbus_connection_dispatch(). Popping messages manually is only
3541 * useful in very simple programs that don't share a #DBusConnection
3542 * with any libraries or other modules.
3544 * There is a lock that covers all ways of accessing the incoming message
3545 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
3546 * dbus_connection_borrow_message(), etc. will all block while one of the others
3547 * in the group is running.
3549 * @param connection the connection.
3550 * @returns next message in the incoming queue.
3553 dbus_connection_pop_message (DBusConnection *connection)
3555 DBusMessage *message;
3556 DBusDispatchStatus status;
3558 _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3560 /* this is called for the side effect that it queues
3561 * up any messages from the transport
3563 status = dbus_connection_get_dispatch_status (connection);
3564 if (status != DBUS_DISPATCH_DATA_REMAINS)
3567 CONNECTION_LOCK (connection);
3568 _dbus_connection_acquire_dispatch (connection);
3569 HAVE_LOCK_CHECK (connection);
3571 message = _dbus_connection_pop_message_unlocked (connection);
3573 _dbus_verbose ("Returning popped message %p\n", message);
3575 _dbus_connection_release_dispatch (connection);
3577 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3578 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3584 * Acquire the dispatcher. This is a separate lock so the main
3585 * connection lock can be dropped to call out to application dispatch
3588 * @param connection the connection.
3591 _dbus_connection_acquire_dispatch (DBusConnection *connection)
3593 HAVE_LOCK_CHECK (connection);
3595 _dbus_connection_ref_unlocked (connection);
3596 CONNECTION_UNLOCK (connection);
3598 _dbus_verbose ("%s locking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3599 _dbus_mutex_lock (connection->dispatch_mutex);
3601 while (connection->dispatch_acquired)
3603 _dbus_verbose ("%s waiting for dispatch to be acquirable\n", _DBUS_FUNCTION_NAME);
3604 _dbus_condvar_wait (connection->dispatch_cond,
3605 connection->dispatch_mutex);
3608 _dbus_assert (!connection->dispatch_acquired);
3610 connection->dispatch_acquired = TRUE;
3612 _dbus_verbose ("%s unlocking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3613 _dbus_mutex_unlock (connection->dispatch_mutex);
3615 CONNECTION_LOCK (connection);
3616 _dbus_connection_unref_unlocked (connection);
3620 * Release the dispatcher when you're done with it. Only call
3621 * after you've acquired the dispatcher. Wakes up at most one
3622 * thread currently waiting to acquire the dispatcher.
3624 * @param connection the connection.
3627 _dbus_connection_release_dispatch (DBusConnection *connection)
3629 HAVE_LOCK_CHECK (connection);
3631 _dbus_verbose ("%s locking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3632 _dbus_mutex_lock (connection->dispatch_mutex);
3634 _dbus_assert (connection->dispatch_acquired);
3636 connection->dispatch_acquired = FALSE;
3637 _dbus_condvar_wake_one (connection->dispatch_cond);
3639 _dbus_verbose ("%s unlocking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3640 _dbus_mutex_unlock (connection->dispatch_mutex);
3644 _dbus_connection_failed_pop (DBusConnection *connection,
3645 DBusList *message_link)
3647 _dbus_list_prepend_link (&connection->incoming_messages,
3649 connection->n_incoming += 1;
3652 static DBusDispatchStatus
3653 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
3655 HAVE_LOCK_CHECK (connection);
3657 if (connection->n_incoming > 0)
3658 return DBUS_DISPATCH_DATA_REMAINS;
3659 else if (!_dbus_transport_queue_messages (connection->transport))
3660 return DBUS_DISPATCH_NEED_MEMORY;
3663 DBusDispatchStatus status;
3664 dbus_bool_t is_connected;
3666 status = _dbus_transport_get_dispatch_status (connection->transport);
3667 is_connected = _dbus_transport_get_is_connected (connection->transport);
3669 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
3670 DISPATCH_STATUS_NAME (status), is_connected);
3674 if (status == DBUS_DISPATCH_COMPLETE &&
3675 connection->disconnect_message_link)
3677 _dbus_verbose ("Sending disconnect message from %s\n",
3678 _DBUS_FUNCTION_NAME);
3680 /* If we have pending calls, queue their timeouts - we want the Disconnected
3681 * to be the last message, after these timeouts.
3683 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
3685 /* We haven't sent the disconnect message already,
3686 * and all real messages have been queued up.
3688 _dbus_connection_queue_synthesized_message_link (connection,
3689 connection->disconnect_message_link);
3690 connection->disconnect_message_link = NULL;
3692 status = DBUS_DISPATCH_DATA_REMAINS;
3695 /* Dump the outgoing queue, we aren't going to be able to
3696 * send it now, and we'd like accessors like
3697 * dbus_connection_get_outgoing_size() to be accurate.
3699 if (connection->n_outgoing > 0)
3703 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
3704 connection->n_outgoing);
3706 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
3708 _dbus_connection_message_sent (connection, link->data);
3713 if (status != DBUS_DISPATCH_COMPLETE)
3715 else if (connection->n_incoming > 0)
3716 return DBUS_DISPATCH_DATA_REMAINS;
3718 return DBUS_DISPATCH_COMPLETE;
3723 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
3724 DBusDispatchStatus new_status)
3726 dbus_bool_t changed;
3727 DBusDispatchStatusFunction function;
3730 HAVE_LOCK_CHECK (connection);
3732 _dbus_connection_ref_unlocked (connection);
3734 changed = new_status != connection->last_dispatch_status;
3736 connection->last_dispatch_status = new_status;
3738 function = connection->dispatch_status_function;
3739 data = connection->dispatch_status_data;
3741 if (connection->disconnected_message_arrived &&
3742 !connection->disconnected_message_processed)
3744 connection->disconnected_message_processed = TRUE;
3746 /* this does an unref, but we have a ref
3747 * so we should not run the finalizer here
3750 connection_forget_shared_unlocked (connection);
3752 if (connection->exit_on_disconnect)
3754 CONNECTION_UNLOCK (connection);
3756 _dbus_verbose ("Exiting on Disconnected signal\n");
3758 _dbus_assert_not_reached ("Call to exit() returned");
3762 /* We drop the lock */
3763 CONNECTION_UNLOCK (connection);
3765 if (changed && function)
3767 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
3768 connection, new_status,
3769 DISPATCH_STATUS_NAME (new_status));
3770 (* function) (connection, new_status, data);
3773 dbus_connection_unref (connection);
3777 * Gets the current state (what we would currently return
3778 * from dbus_connection_dispatch()) but doesn't actually
3779 * dispatch any messages.
3781 * @param connection the connection.
3782 * @returns current dispatch status
3785 dbus_connection_get_dispatch_status (DBusConnection *connection)
3787 DBusDispatchStatus status;
3789 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
3791 _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3793 CONNECTION_LOCK (connection);
3795 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3797 CONNECTION_UNLOCK (connection);
3803 * Filter funtion for handling the Peer standard interface.
3805 static DBusHandlerResult
3806 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
3807 DBusMessage *message)
3809 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
3811 /* This means we're letting the bus route this message */
3812 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3814 else if (dbus_message_is_method_call (message,
3815 DBUS_INTERFACE_PEER,
3821 ret = dbus_message_new_method_return (message);
3823 return DBUS_HANDLER_RESULT_NEED_MEMORY;
3825 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
3827 dbus_message_unref (ret);
3830 return DBUS_HANDLER_RESULT_NEED_MEMORY;
3832 return DBUS_HANDLER_RESULT_HANDLED;
3834 else if (dbus_message_is_method_call (message,
3835 DBUS_INTERFACE_PEER,
3842 ret = dbus_message_new_method_return (message);
3844 return DBUS_HANDLER_RESULT_NEED_MEMORY;
3847 _dbus_string_init (&uuid);
3848 if (_dbus_get_local_machine_uuid_encoded (&uuid))
3850 const char *v_STRING = _dbus_string_get_const_data (&uuid);
3851 if (dbus_message_append_args (ret,
3852 DBUS_TYPE_STRING, &v_STRING,
3855 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
3858 _dbus_string_free (&uuid);
3860 dbus_message_unref (ret);
3863 return DBUS_HANDLER_RESULT_NEED_MEMORY;
3865 return DBUS_HANDLER_RESULT_HANDLED;
3867 else if (dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
3869 /* We need to bounce anything else with this interface, otherwise apps
3870 * could start extending the interface and when we added extensions
3871 * here to DBusConnection we'd break those apps.
3877 ret = dbus_message_new_error (message,
3878 DBUS_ERROR_UNKNOWN_METHOD,
3879 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
3881 return DBUS_HANDLER_RESULT_NEED_MEMORY;
3883 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
3885 dbus_message_unref (ret);
3888 return DBUS_HANDLER_RESULT_NEED_MEMORY;
3890 return DBUS_HANDLER_RESULT_HANDLED;
3894 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3899 * Processes all builtin filter functions
3901 * If the spec specifies a standard interface
3902 * they should be processed from this method
3904 static DBusHandlerResult
3905 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
3906 DBusMessage *message)
3908 /* We just run one filter for now but have the option to run more
3909 if the spec calls for it in the future */
3911 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
3915 * Processes data buffered while handling watches, queueing zero or
3916 * more incoming messages. Then pops the first-received message from
3917 * the current incoming message queue, runs any handlers for it, and
3918 * unrefs the message. Returns a status indicating whether messages/data
3919 * remain, more memory is needed, or all data has been processed.
3921 * Even if the dispatch status is #DBUS_DISPATCH_DATA_REMAINS,
3922 * does not necessarily dispatch a message, as the data may
3923 * be part of authentication or the like.
3925 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
3927 * @todo FIXME what if we call out to application code to handle a
3928 * message, holding the dispatch lock, and the application code runs
3929 * the main loop and dispatches again? Probably deadlocks at the
3930 * moment. Maybe we want a dispatch status of DBUS_DISPATCH_IN_PROGRESS,
3931 * and then the GSource etc. could handle the situation? Right now
3932 * our GSource is NO_RECURSE
3934 * @param connection the connection
3935 * @returns dispatch status
3938 dbus_connection_dispatch (DBusConnection *connection)
3940 DBusMessage *message;
3941 DBusList *link, *filter_list_copy, *message_link;
3942 DBusHandlerResult result;
3943 DBusPendingCall *pending;
3944 dbus_int32_t reply_serial;
3945 DBusDispatchStatus status;
3947 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
3949 _dbus_verbose ("%s\n", _DBUS_FUNCTION_NAME);
3951 CONNECTION_LOCK (connection);
3952 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3953 if (status != DBUS_DISPATCH_DATA_REMAINS)
3955 /* unlocks and calls out to user code */
3956 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3960 /* We need to ref the connection since the callback could potentially
3961 * drop the last ref to it
3963 _dbus_connection_ref_unlocked (connection);
3965 _dbus_connection_acquire_dispatch (connection);
3966 HAVE_LOCK_CHECK (connection);
3968 message_link = _dbus_connection_pop_message_link_unlocked (connection);
3969 if (message_link == NULL)
3971 /* another thread dispatched our stuff */
3973 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
3975 _dbus_connection_release_dispatch (connection);
3977 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3979 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3981 dbus_connection_unref (connection);
3986 message = message_link->data;
3988 _dbus_verbose (" dispatching message %p (%d %s %s '%s')\n",
3990 dbus_message_get_type (message),
3991 dbus_message_get_interface (message) ?
3992 dbus_message_get_interface (message) :
3994 dbus_message_get_member (message) ?
3995 dbus_message_get_member (message) :
3997 dbus_message_get_signature (message));
3999 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4001 /* Pending call handling must be first, because if you do
4002 * dbus_connection_send_with_reply_and_block() or
4003 * dbus_pending_call_block() then no handlers/filters will be run on
4004 * the reply. We want consistent semantics in the case where we
4005 * dbus_connection_dispatch() the reply.
4008 reply_serial = dbus_message_get_reply_serial (message);
4009 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4013 _dbus_verbose ("Dispatching a pending reply\n");
4014 complete_pending_call_and_unlock (connection, pending, message);
4015 pending = NULL; /* it's probably unref'd */
4017 CONNECTION_LOCK (connection);
4018 _dbus_verbose ("pending call completed in dispatch\n");
4019 result = DBUS_HANDLER_RESULT_HANDLED;
4023 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4024 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4027 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4029 _dbus_connection_release_dispatch (connection);
4030 HAVE_LOCK_CHECK (connection);
4032 _dbus_connection_failed_pop (connection, message_link);
4034 /* unlocks and calls user code */
4035 _dbus_connection_update_dispatch_status_and_unlock (connection,
4036 DBUS_DISPATCH_NEED_MEMORY);
4039 dbus_pending_call_unref (pending);
4040 dbus_connection_unref (connection);
4042 return DBUS_DISPATCH_NEED_MEMORY;
4045 _dbus_list_foreach (&filter_list_copy,
4046 (DBusForeachFunction)_dbus_message_filter_ref,
4049 /* We're still protected from dispatch() reentrancy here
4050 * since we acquired the dispatcher
4052 CONNECTION_UNLOCK (connection);
4054 link = _dbus_list_get_first_link (&filter_list_copy);
4055 while (link != NULL)
4057 DBusMessageFilter *filter = link->data;
4058 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4060 if (filter->function == NULL)
4062 _dbus_verbose (" filter was removed in a callback function\n");
4067 _dbus_verbose (" running filter on message %p\n", message);
4068 result = (* filter->function) (connection, message, filter->user_data);
4070 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4076 _dbus_list_foreach (&filter_list_copy,
4077 (DBusForeachFunction)_dbus_message_filter_unref,
4079 _dbus_list_clear (&filter_list_copy);
4081 CONNECTION_LOCK (connection);
4083 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4085 _dbus_verbose ("No memory in %s\n", _DBUS_FUNCTION_NAME);
4088 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4090 _dbus_verbose ("filter handled message in dispatch\n");
4094 /* We're still protected from dispatch() reentrancy here
4095 * since we acquired the dispatcher
4097 _dbus_verbose (" running object path dispatch on message %p (%d %s %s '%s')\n",
4099 dbus_message_get_type (message),
4100 dbus_message_get_interface (message) ?
4101 dbus_message_get_interface (message) :
4103 dbus_message_get_member (message) ?
4104 dbus_message_get_member (message) :
4106 dbus_message_get_signature (message));
4108 HAVE_LOCK_CHECK (connection);
4109 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4112 CONNECTION_LOCK (connection);
4114 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4116 _dbus_verbose ("object tree handled message in dispatch\n");
4120 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4124 DBusPreallocatedSend *preallocated;
4126 _dbus_verbose (" sending error %s\n",
4127 DBUS_ERROR_UNKNOWN_METHOD);
4129 if (!_dbus_string_init (&str))
4131 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4132 _dbus_verbose ("no memory for error string in dispatch\n");
4136 if (!_dbus_string_append_printf (&str,
4137 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4138 dbus_message_get_member (message),
4139 dbus_message_get_signature (message),
4140 dbus_message_get_interface (message)))
4142 _dbus_string_free (&str);
4143 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4144 _dbus_verbose ("no memory for error string in dispatch\n");
4148 reply = dbus_message_new_error (message,
4149 DBUS_ERROR_UNKNOWN_METHOD,
4150 _dbus_string_get_const_data (&str));
4151 _dbus_string_free (&str);
4155 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4156 _dbus_verbose ("no memory for error reply in dispatch\n");
4160 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4162 if (preallocated == NULL)
4164 dbus_message_unref (reply);
4165 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4166 _dbus_verbose ("no memory for error send in dispatch\n");
4170 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4173 dbus_message_unref (reply);
4175 result = DBUS_HANDLER_RESULT_HANDLED;
4178 _dbus_verbose (" done dispatching %p (%d %s %s '%s') on connection %p\n", message,
4179 dbus_message_get_type (message),
4180 dbus_message_get_interface (message) ?
4181 dbus_message_get_interface (message) :
4183 dbus_message_get_member (message) ?
4184 dbus_message_get_member (message) :
4186 dbus_message_get_signature (message),
4190 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4192 _dbus_verbose ("out of memory in %s\n", _DBUS_FUNCTION_NAME);
4194 /* Put message back, and we'll start over.
4195 * Yes this means handlers must be idempotent if they
4196 * don't return HANDLED; c'est la vie.
4198 _dbus_connection_putback_message_link_unlocked (connection,
4203 _dbus_verbose (" ... done dispatching in %s\n", _DBUS_FUNCTION_NAME);
4205 _dbus_list_free_link (message_link);
4206 dbus_message_unref (message); /* don't want the message to count in max message limits
4207 * in computing dispatch status below
4211 _dbus_connection_release_dispatch (connection);
4212 HAVE_LOCK_CHECK (connection);
4214 _dbus_verbose ("%s before final status update\n", _DBUS_FUNCTION_NAME);
4215 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4217 /* unlocks and calls user code */
4218 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4220 dbus_connection_unref (connection);
4226 * Sets the watch functions for the connection. These functions are
4227 * responsible for making the application's main loop aware of file
4228 * descriptors that need to be monitored for events, using select() or
4229 * poll(). When using Qt, typically the DBusAddWatchFunction would
4230 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4231 * could call g_io_add_watch(), or could be used as part of a more
4232 * elaborate GSource. Note that when a watch is added, it may
4235 * The DBusWatchToggledFunction notifies the application that the
4236 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4237 * to check this. A disabled watch should have no effect, and enabled
4238 * watch should be added to the main loop. This feature is used
4239 * instead of simply adding/removing the watch because
4240 * enabling/disabling can be done without memory allocation. The
4241 * toggled function may be NULL if a main loop re-queries
4242 * dbus_watch_get_enabled() every time anyway.
4244 * The DBusWatch can be queried for the file descriptor to watch using
4245 * dbus_watch_get_fd(), and for the events to watch for using
4246 * dbus_watch_get_flags(). The flags returned by
4247 * dbus_watch_get_flags() will only contain DBUS_WATCH_READABLE and
4248 * DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR;
4249 * all watches implicitly include a watch for hangups, errors, and
4250 * other exceptional conditions.
4252 * Once a file descriptor becomes readable or writable, or an exception
4253 * occurs, dbus_watch_handle() should be called to
4254 * notify the connection of the file descriptor's condition.
4256 * dbus_watch_handle() cannot be called during the
4257 * DBusAddWatchFunction, as the connection will not be ready to handle
4260 * It is not allowed to reference a DBusWatch after it has been passed
4261 * to remove_function.
4263 * If #FALSE is returned due to lack of memory, the failure may be due
4264 * to a #FALSE return from the new add_function. If so, the
4265 * add_function may have been called successfully one or more times,
4266 * but the remove_function will also have been called to remove any
4267 * successful adds. i.e. if #FALSE is returned the net result
4268 * should be that dbus_connection_set_watch_functions() has no effect,
4269 * but the add_function and remove_function may have been called.
4271 * @todo We need to drop the lock when we call the
4272 * add/remove/toggled functions which can be a side effect
4273 * of setting the watch functions.
4275 * @param connection the connection.
4276 * @param add_function function to begin monitoring a new descriptor.
4277 * @param remove_function function to stop monitoring a descriptor.
4278 * @param toggled_function function to notify of enable/disable
4279 * @param data data to pass to add_function and remove_function.
4280 * @param free_data_function function to be called to free the data.
4281 * @returns #FALSE on failure (no memory)
4284 dbus_connection_set_watch_functions (DBusConnection *connection,
4285 DBusAddWatchFunction add_function,
4286 DBusRemoveWatchFunction remove_function,
4287 DBusWatchToggledFunction toggled_function,
4289 DBusFreeFunction free_data_function)
4292 DBusWatchList *watches;
4294 _dbus_return_val_if_fail (connection != NULL, FALSE);
4296 CONNECTION_LOCK (connection);
4298 #ifndef DBUS_DISABLE_CHECKS
4299 if (connection->watches == NULL)
4301 _dbus_warn ("Re-entrant call to %s is not allowed\n",
4302 _DBUS_FUNCTION_NAME);
4307 /* ref connection for slightly better reentrancy */
4308 _dbus_connection_ref_unlocked (connection);
4310 /* This can call back into user code, and we need to drop the
4311 * connection lock when it does. This is kind of a lame
4314 watches = connection->watches;
4315 connection->watches = NULL;
4316 CONNECTION_UNLOCK (connection);
4318 retval = _dbus_watch_list_set_functions (watches,
4319 add_function, remove_function,
4321 data, free_data_function);
4322 CONNECTION_LOCK (connection);
4323 connection->watches = watches;
4325 CONNECTION_UNLOCK (connection);
4326 /* drop our paranoid refcount */
4327 dbus_connection_unref (connection);
4333 * Sets the timeout functions for the connection. These functions are
4334 * responsible for making the application's main loop aware of timeouts.
4335 * When using Qt, typically the DBusAddTimeoutFunction would create a
4336 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4339 * The DBusTimeoutToggledFunction notifies the application that the
4340 * timeout has been enabled or disabled. Call
4341 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4342 * have no effect, and enabled timeout should be added to the main
4343 * loop. This feature is used instead of simply adding/removing the
4344 * timeout because enabling/disabling can be done without memory
4345 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4346 * to enable and disable. The toggled function may be NULL if a main
4347 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4348 * Whenever a timeout is toggled, its interval may change.
4350 * The DBusTimeout can be queried for the timer interval using
4351 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4352 * repeatedly, each time the interval elapses, starting after it has
4353 * elapsed once. The timeout stops firing when it is removed with the
4354 * given remove_function. The timer interval may change whenever the
4355 * timeout is added, removed, or toggled.
4357 * @param connection the connection.
4358 * @param add_function function to add a timeout.
4359 * @param remove_function function to remove a timeout.
4360 * @param toggled_function function to notify of enable/disable
4361 * @param data data to pass to add_function and remove_function.
4362 * @param free_data_function function to be called to free the data.
4363 * @returns #FALSE on failure (no memory)
4366 dbus_connection_set_timeout_functions (DBusConnection *connection,
4367 DBusAddTimeoutFunction add_function,
4368 DBusRemoveTimeoutFunction remove_function,
4369 DBusTimeoutToggledFunction toggled_function,
4371 DBusFreeFunction free_data_function)
4374 DBusTimeoutList *timeouts;
4376 _dbus_return_val_if_fail (connection != NULL, FALSE);
4378 CONNECTION_LOCK (connection);
4380 #ifndef DBUS_DISABLE_CHECKS
4381 if (connection->timeouts == NULL)
4383 _dbus_warn ("Re-entrant call to %s is not allowed\n",
4384 _DBUS_FUNCTION_NAME);
4389 /* ref connection for slightly better reentrancy */
4390 _dbus_connection_ref_unlocked (connection);
4392 timeouts = connection->timeouts;
4393 connection->timeouts = NULL;
4394 CONNECTION_UNLOCK (connection);
4396 retval = _dbus_timeout_list_set_functions (timeouts,
4397 add_function, remove_function,
4399 data, free_data_function);
4400 CONNECTION_LOCK (connection);
4401 connection->timeouts = timeouts;
4403 CONNECTION_UNLOCK (connection);
4404 /* drop our paranoid refcount */
4405 dbus_connection_unref (connection);
4411 * Sets the mainloop wakeup function for the connection. This function is
4412 * responsible for waking up the main loop (if its sleeping) when some some
4413 * change has happened to the connection that the mainloop needs to reconsider
4414 * (e.g. a message has been queued for writing).
4415 * When using Qt, this typically results in a call to QEventLoop::wakeUp().
4416 * When using GLib, it would call g_main_context_wakeup().
4419 * @param connection the connection.
4420 * @param wakeup_main_function function to wake up the mainloop
4421 * @param data data to pass wakeup_main_function
4422 * @param free_data_function function to be called to free the data.
4425 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
4426 DBusWakeupMainFunction wakeup_main_function,
4428 DBusFreeFunction free_data_function)
4431 DBusFreeFunction old_free_data;
4433 _dbus_return_if_fail (connection != NULL);
4435 CONNECTION_LOCK (connection);
4436 old_data = connection->wakeup_main_data;
4437 old_free_data = connection->free_wakeup_main_data;
4439 connection->wakeup_main_function = wakeup_main_function;
4440 connection->wakeup_main_data = data;
4441 connection->free_wakeup_main_data = free_data_function;
4443 CONNECTION_UNLOCK (connection);
4445 /* Callback outside the lock */
4447 (*old_free_data) (old_data);
4451 * Set a function to be invoked when the dispatch status changes.
4452 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
4453 * dbus_connection_dispatch() needs to be called to process incoming
4454 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
4455 * from inside the DBusDispatchStatusFunction. Indeed, almost
4456 * any reentrancy in this function is a bad idea. Instead,
4457 * the DBusDispatchStatusFunction should simply save an indication
4458 * that messages should be dispatched later, when the main loop
4461 * @param connection the connection
4462 * @param function function to call on dispatch status changes
4463 * @param data data for function
4464 * @param free_data_function free the function data
4467 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
4468 DBusDispatchStatusFunction function,
4470 DBusFreeFunction free_data_function)
4473 DBusFreeFunction old_free_data;
4475 _dbus_return_if_fail (connection != NULL);
4477 CONNECTION_LOCK (connection);
4478 old_data = connection->dispatch_status_data;
4479 old_free_data = connection->free_dispatch_status_data;
4481 connection->dispatch_status_function = function;
4482 connection->dispatch_status_data = data;
4483 connection->free_dispatch_status_data = free_data_function;
4485 CONNECTION_UNLOCK (connection);
4487 /* Callback outside the lock */
4489 (*old_free_data) (old_data);
4493 * Get the UNIX file descriptor of the connection, if any. This can
4494 * be used for SELinux access control checks with getpeercon() for
4495 * example. DO NOT read or write to the file descriptor, or try to
4496 * select() on it; use DBusWatch for main loop integration. Not all
4497 * connections will have a file descriptor. So for adding descriptors
4498 * to the main loop, use dbus_watch_get_fd() and so forth.
4500 * If the connection is socket-based, you can also use
4501 * dbus_connection_get_socket(), which will work on Windows too.
4502 * This function always fails on Windows.
4504 * Right now the returned descriptor is always a socket, but
4505 * that is not guaranteed.
4507 * @param connection the connection
4508 * @param fd return location for the file descriptor.
4509 * @returns #TRUE if fd is successfully obtained.
4512 dbus_connection_get_unix_fd (DBusConnection *connection,
4515 _dbus_return_val_if_fail (connection != NULL, FALSE);
4516 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
4519 /* FIXME do this on a lower level */
4523 return dbus_connection_get_socket(connection, fd);
4527 * Gets the underlying Windows or UNIX socket file descriptor
4528 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
4529 * select() on it; use DBusWatch for main loop integration. Not all
4530 * connections will have a socket. So for adding descriptors
4531 * to the main loop, use dbus_watch_get_fd() and so forth.
4533 * If the connection is not socket-based, this function will return FALSE,
4534 * even if the connection does have a file descriptor of some kind.
4535 * i.e. this function always returns specifically a socket file descriptor.
4537 * @param connection the connection
4538 * @param fd return location for the file descriptor.
4539 * @returns #TRUE if fd is successfully obtained.
4542 dbus_connection_get_socket(DBusConnection *connection,
4547 _dbus_return_val_if_fail (connection != NULL, FALSE);
4548 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
4550 CONNECTION_LOCK (connection);
4552 retval = _dbus_transport_get_socket_fd (connection->transport,
4555 CONNECTION_UNLOCK (connection);
4562 * Gets the UNIX user ID of the connection if any.
4563 * Returns #TRUE if the uid is filled in.
4564 * Always returns #FALSE on non-UNIX platforms.
4565 * Always returns #FALSE prior to authenticating the
4568 * @param connection the connection
4569 * @param uid return location for the user ID
4570 * @returns #TRUE if uid is filled in with a valid user ID
4573 dbus_connection_get_unix_user (DBusConnection *connection,
4578 _dbus_return_val_if_fail (connection != NULL, FALSE);
4579 _dbus_return_val_if_fail (uid != NULL, FALSE);
4582 /* FIXME this should be done at a lower level, but it's kind of hard,
4583 * just want to be sure we don't ship with this API returning
4584 * some weird internal fake uid for 1.0
4589 CONNECTION_LOCK (connection);
4591 if (!_dbus_transport_get_is_authenticated (connection->transport))
4594 result = _dbus_transport_get_unix_user (connection->transport,
4596 CONNECTION_UNLOCK (connection);
4602 * Gets the process ID of the connection if any.
4603 * Returns #TRUE if the uid is filled in.
4604 * Always returns #FALSE prior to authenticating the
4607 * @param connection the connection
4608 * @param pid return location for the process ID
4609 * @returns #TRUE if uid is filled in with a valid process ID
4612 dbus_connection_get_unix_process_id (DBusConnection *connection,
4617 _dbus_return_val_if_fail (connection != NULL, FALSE);
4618 _dbus_return_val_if_fail (pid != NULL, FALSE);
4621 /* FIXME this should be done at a lower level, but it's kind of hard,
4622 * just want to be sure we don't ship with this API returning
4623 * some weird internal fake uid for 1.0
4628 CONNECTION_LOCK (connection);
4630 if (!_dbus_transport_get_is_authenticated (connection->transport))
4633 result = _dbus_transport_get_unix_process_id (connection->transport,
4635 CONNECTION_UNLOCK (connection);
4641 * Sets a predicate function used to determine whether a given user ID
4642 * is allowed to connect. When an incoming connection has
4643 * authenticated with a particular user ID, this function is called;
4644 * if it returns #TRUE, the connection is allowed to proceed,
4645 * otherwise the connection is disconnected.
4647 * If the function is set to #NULL (as it is by default), then
4648 * only the same UID as the server process will be allowed to
4651 * On Windows, the function will be set and its free_data_function will
4652 * be invoked when the connection is freed or a new function is set.
4653 * However, the function will never be called, because there are
4654 * no UNIX user ids to pass to it.
4656 * @todo add a Windows API analogous to dbus_connection_set_unix_user_function()
4658 * @param connection the connection
4659 * @param function the predicate
4660 * @param data data to pass to the predicate
4661 * @param free_data_function function to free the data
4664 dbus_connection_set_unix_user_function (DBusConnection *connection,
4665 DBusAllowUnixUserFunction function,
4667 DBusFreeFunction free_data_function)
4669 void *old_data = NULL;
4670 DBusFreeFunction old_free_function = NULL;
4672 _dbus_return_if_fail (connection != NULL);
4674 CONNECTION_LOCK (connection);
4675 _dbus_transport_set_unix_user_function (connection->transport,
4676 function, data, free_data_function,
4677 &old_data, &old_free_function);
4678 CONNECTION_UNLOCK (connection);
4680 if (old_free_function != NULL)
4681 (* old_free_function) (old_data);
4686 * Normally #DBusConnection automatically handles all messages to the
4687 * org.freedesktop.DBus.Peer interface. However, the message bus wants
4688 * to be able to route methods on that interface through the bus and
4689 * to other applications. If routing peer messages is enabled, then
4690 * messages with the org.freedesktop.DBus.Peer interface that also
4691 * have a bus destination name set will not be automatically
4692 * handled by the #DBusConnection and instead will be dispatched
4693 * normally to the application.
4696 * If a normal application sets this flag, it can break things badly.
4697 * So don't set this unless you are the message bus.
4699 * @param connection the connection
4700 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
4703 dbus_connection_set_route_peer_messages (DBusConnection *connection,
4706 _dbus_return_if_fail (connection != NULL);
4708 CONNECTION_LOCK (connection);
4709 connection->route_peer_messages = TRUE;
4710 CONNECTION_UNLOCK (connection);
4714 * Adds a message filter. Filters are handlers that are run on all
4715 * incoming messages, prior to the objects registered with
4716 * dbus_connection_register_object_path(). Filters are run in the
4717 * order that they were added. The same handler can be added as a
4718 * filter more than once, in which case it will be run more than once.
4719 * Filters added during a filter callback won't be run on the message
4722 * @todo we don't run filters on messages while blocking without
4723 * entering the main loop, since filters are run as part of
4724 * dbus_connection_dispatch(). This is probably a feature, as filters
4725 * could create arbitrary reentrancy. But kind of sucks if you're
4726 * trying to filter METHOD_RETURN for some reason.
4728 * @param connection the connection
4729 * @param function function to handle messages
4730 * @param user_data user data to pass to the function
4731 * @param free_data_function function to use for freeing user data
4732 * @returns #TRUE on success, #FALSE if not enough memory.
4735 dbus_connection_add_filter (DBusConnection *connection,
4736 DBusHandleMessageFunction function,
4738 DBusFreeFunction free_data_function)
4740 DBusMessageFilter *filter;
4742 _dbus_return_val_if_fail (connection != NULL, FALSE);
4743 _dbus_return_val_if_fail (function != NULL, FALSE);
4745 filter = dbus_new0 (DBusMessageFilter, 1);
4749 filter->refcount.value = 1;
4751 CONNECTION_LOCK (connection);
4753 if (!_dbus_list_append (&connection->filter_list,
4756 _dbus_message_filter_unref (filter);
4757 CONNECTION_UNLOCK (connection);
4761 /* Fill in filter after all memory allocated,
4762 * so we don't run the free_user_data_function
4763 * if the add_filter() fails
4766 filter->function = function;
4767 filter->user_data = user_data;
4768 filter->free_user_data_function = free_data_function;
4770 CONNECTION_UNLOCK (connection);
4775 * Removes a previously-added message filter. It is a programming
4776 * error to call this function for a handler that has not been added
4777 * as a filter. If the given handler was added more than once, only
4778 * one instance of it will be removed (the most recently-added
4781 * @param connection the connection
4782 * @param function the handler to remove
4783 * @param user_data user data for the handler to remove
4787 dbus_connection_remove_filter (DBusConnection *connection,
4788 DBusHandleMessageFunction function,
4792 DBusMessageFilter *filter;
4794 _dbus_return_if_fail (connection != NULL);
4795 _dbus_return_if_fail (function != NULL);
4797 CONNECTION_LOCK (connection);
4801 link = _dbus_list_get_last_link (&connection->filter_list);
4802 while (link != NULL)
4804 filter = link->data;
4806 if (filter->function == function &&
4807 filter->user_data == user_data)
4809 _dbus_list_remove_link (&connection->filter_list, link);
4810 filter->function = NULL;
4815 link = _dbus_list_get_prev_link (&connection->filter_list, link);
4818 CONNECTION_UNLOCK (connection);
4820 #ifndef DBUS_DISABLE_CHECKS
4823 _dbus_warn ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
4824 function, user_data);
4829 /* Call application code */
4830 if (filter->free_user_data_function)
4831 (* filter->free_user_data_function) (filter->user_data);
4833 filter->free_user_data_function = NULL;
4834 filter->user_data = NULL;
4836 _dbus_message_filter_unref (filter);
4840 * Registers a handler for a given path in the object hierarchy.
4841 * The given vtable handles messages sent to exactly the given path.
4844 * @param connection the connection
4845 * @param path a '/' delimited string of path elements
4846 * @param vtable the virtual table
4847 * @param user_data data to pass to functions in the vtable
4848 * @returns #FALSE if not enough memory
4851 dbus_connection_register_object_path (DBusConnection *connection,
4853 const DBusObjectPathVTable *vtable,
4856 char **decomposed_path;
4859 _dbus_return_val_if_fail (connection != NULL, FALSE);
4860 _dbus_return_val_if_fail (path != NULL, FALSE);
4861 _dbus_return_val_if_fail (path[0] == '/', FALSE);
4862 _dbus_return_val_if_fail (vtable != NULL, FALSE);
4864 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
4867 CONNECTION_LOCK (connection);
4869 retval = _dbus_object_tree_register (connection->objects,
4871 (const char **) decomposed_path, vtable,
4874 CONNECTION_UNLOCK (connection);
4876 dbus_free_string_array (decomposed_path);
4882 * Registers a fallback handler for a given subsection of the object
4883 * hierarchy. The given vtable handles messages at or below the given
4884 * path. You can use this to establish a default message handling
4885 * policy for a whole "subdirectory."
4887 * @param connection the connection
4888 * @param path a '/' delimited string of path elements
4889 * @param vtable the virtual table
4890 * @param user_data data to pass to functions in the vtable
4891 * @returns #FALSE if not enough memory
4894 dbus_connection_register_fallback (DBusConnection *connection,
4896 const DBusObjectPathVTable *vtable,
4899 char **decomposed_path;
4902 _dbus_return_val_if_fail (connection != NULL, FALSE);
4903 _dbus_return_val_if_fail (path != NULL, FALSE);
4904 _dbus_return_val_if_fail (path[0] == '/', FALSE);
4905 _dbus_return_val_if_fail (vtable != NULL, FALSE);
4907 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
4910 CONNECTION_LOCK (connection);
4912 retval = _dbus_object_tree_register (connection->objects,
4914 (const char **) decomposed_path, vtable,
4917 CONNECTION_UNLOCK (connection);
4919 dbus_free_string_array (decomposed_path);
4925 * Unregisters the handler registered with exactly the given path.
4926 * It's a bug to call this function for a path that isn't registered.
4927 * Can unregister both fallback paths and object paths.
4929 * @param connection the connection
4930 * @param path a '/' delimited string of path elements
4931 * @returns #FALSE if not enough memory
4934 dbus_connection_unregister_object_path (DBusConnection *connection,
4937 char **decomposed_path;
4939 _dbus_return_val_if_fail (connection != NULL, FALSE);
4940 _dbus_return_val_if_fail (path != NULL, FALSE);
4941 _dbus_return_val_if_fail (path[0] == '/', FALSE);
4943 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
4946 CONNECTION_LOCK (connection);
4948 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
4950 dbus_free_string_array (decomposed_path);
4956 * Gets the user data passed to dbus_connection_register_object_path()
4957 * or dbus_connection_register_fallback(). If nothing was registered
4958 * at this path, the data is filled in with #NULL.
4960 * @param connection the connection
4961 * @param path the path you registered with
4962 * @param data_p location to store the user data, or #NULL
4963 * @returns #FALSE if not enough memory
4966 dbus_connection_get_object_path_data (DBusConnection *connection,
4970 char **decomposed_path;
4972 _dbus_return_val_if_fail (connection != NULL, FALSE);
4973 _dbus_return_val_if_fail (path != NULL, FALSE);
4974 _dbus_return_val_if_fail (data_p != NULL, FALSE);
4978 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
4981 CONNECTION_LOCK (connection);
4983 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
4985 CONNECTION_UNLOCK (connection);
4987 dbus_free_string_array (decomposed_path);
4993 * Lists the registered fallback handlers and object path handlers at
4994 * the given parent_path. The returned array should be freed with
4995 * dbus_free_string_array().
4997 * @param connection the connection
4998 * @param parent_path the path to list the child handlers of
4999 * @param child_entries returns #NULL-terminated array of children
5000 * @returns #FALSE if no memory to allocate the child entries
5003 dbus_connection_list_registered (DBusConnection *connection,
5004 const char *parent_path,
5005 char ***child_entries)
5007 char **decomposed_path;
5009 _dbus_return_val_if_fail (connection != NULL, FALSE);
5010 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5011 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5012 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5014 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5017 CONNECTION_LOCK (connection);
5019 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5020 (const char **) decomposed_path,
5022 dbus_free_string_array (decomposed_path);
5027 static DBusDataSlotAllocator slot_allocator;
5028 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
5031 * Allocates an integer ID to be used for storing application-specific
5032 * data on any DBusConnection. The allocated ID may then be used
5033 * with dbus_connection_set_data() and dbus_connection_get_data().
5034 * The passed-in slot must be initialized to -1, and is filled in
5035 * with the slot ID. If the passed-in slot is not -1, it's assumed
5036 * to be already allocated, and its refcount is incremented.
5038 * The allocated slot is global, i.e. all DBusConnection objects will
5039 * have a slot with the given integer ID reserved.
5041 * @param slot_p address of a global variable storing the slot
5042 * @returns #FALSE on failure (no memory)
5045 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5047 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5048 &_DBUS_LOCK_NAME (connection_slots),
5053 * Deallocates a global ID for connection data slots.
5054 * dbus_connection_get_data() and dbus_connection_set_data() may no
5055 * longer be used with this slot. Existing data stored on existing
5056 * DBusConnection objects will be freed when the connection is
5057 * finalized, but may not be retrieved (and may only be replaced if
5058 * someone else reallocates the slot). When the refcount on the
5059 * passed-in slot reaches 0, it is set to -1.
5061 * @param slot_p address storing the slot to deallocate
5064 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5066 _dbus_return_if_fail (*slot_p >= 0);
5068 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5072 * Stores a pointer on a DBusConnection, along
5073 * with an optional function to be used for freeing
5074 * the data when the data is set again, or when
5075 * the connection is finalized. The slot number
5076 * must have been allocated with dbus_connection_allocate_data_slot().
5078 * @param connection the connection
5079 * @param slot the slot number
5080 * @param data the data to store
5081 * @param free_data_func finalizer function for the data
5082 * @returns #TRUE if there was enough memory to store the data
5085 dbus_connection_set_data (DBusConnection *connection,
5088 DBusFreeFunction free_data_func)
5090 DBusFreeFunction old_free_func;
5094 _dbus_return_val_if_fail (connection != NULL, FALSE);
5095 _dbus_return_val_if_fail (slot >= 0, FALSE);
5097 CONNECTION_LOCK (connection);
5099 retval = _dbus_data_slot_list_set (&slot_allocator,
5100 &connection->slot_list,
5101 slot, data, free_data_func,
5102 &old_free_func, &old_data);
5104 CONNECTION_UNLOCK (connection);
5108 /* Do the actual free outside the connection lock */
5110 (* old_free_func) (old_data);
5117 * Retrieves data previously set with dbus_connection_set_data().
5118 * The slot must still be allocated (must not have been freed).
5120 * @param connection the connection
5121 * @param slot the slot to get data from
5122 * @returns the data, or #NULL if not found
5125 dbus_connection_get_data (DBusConnection *connection,
5130 _dbus_return_val_if_fail (connection != NULL, NULL);
5132 CONNECTION_LOCK (connection);
5134 res = _dbus_data_slot_list_get (&slot_allocator,
5135 &connection->slot_list,
5138 CONNECTION_UNLOCK (connection);
5144 * This function sets a global flag for whether dbus_connection_new()
5145 * will set SIGPIPE behavior to SIG_IGN.
5147 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
5150 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
5152 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
5156 * Specifies the maximum size message this connection is allowed to
5157 * receive. Larger messages will result in disconnecting the
5160 * @param connection a #DBusConnection
5161 * @param size maximum message size the connection can receive, in bytes
5164 dbus_connection_set_max_message_size (DBusConnection *connection,
5167 _dbus_return_if_fail (connection != NULL);
5169 CONNECTION_LOCK (connection);
5170 _dbus_transport_set_max_message_size (connection->transport,
5172 CONNECTION_UNLOCK (connection);
5176 * Gets the value set by dbus_connection_set_max_message_size().
5178 * @param connection the connection
5179 * @returns the max size of a single message
5182 dbus_connection_get_max_message_size (DBusConnection *connection)
5186 _dbus_return_val_if_fail (connection != NULL, 0);
5188 CONNECTION_LOCK (connection);
5189 res = _dbus_transport_get_max_message_size (connection->transport);
5190 CONNECTION_UNLOCK (connection);
5195 * Sets the maximum total number of bytes that can be used for all messages
5196 * received on this connection. Messages count toward the maximum until
5197 * they are finalized. When the maximum is reached, the connection will
5198 * not read more data until some messages are finalized.
5200 * The semantics of the maximum are: if outstanding messages are
5201 * already above the maximum, additional messages will not be read.
5202 * The semantics are not: if the next message would cause us to exceed
5203 * the maximum, we don't read it. The reason is that we don't know the
5204 * size of a message until after we read it.
5206 * Thus, the max live messages size can actually be exceeded
5207 * by up to the maximum size of a single message.
5209 * Also, if we read say 1024 bytes off the wire in a single read(),
5210 * and that contains a half-dozen small messages, we may exceed the
5211 * size max by that amount. But this should be inconsequential.
5213 * This does imply that we can't call read() with a buffer larger
5214 * than we're willing to exceed this limit by.
5216 * @param connection the connection
5217 * @param size the maximum size in bytes of all outstanding messages
5220 dbus_connection_set_max_received_size (DBusConnection *connection,
5223 _dbus_return_if_fail (connection != NULL);
5225 CONNECTION_LOCK (connection);
5226 _dbus_transport_set_max_received_size (connection->transport,
5228 CONNECTION_UNLOCK (connection);
5232 * Gets the value set by dbus_connection_set_max_received_size().
5234 * @param connection the connection
5235 * @returns the max size of all live messages
5238 dbus_connection_get_max_received_size (DBusConnection *connection)
5242 _dbus_return_val_if_fail (connection != NULL, 0);
5244 CONNECTION_LOCK (connection);
5245 res = _dbus_transport_get_max_received_size (connection->transport);
5246 CONNECTION_UNLOCK (connection);
5251 * Gets the approximate size in bytes of all messages in the outgoing
5252 * message queue. The size is approximate in that you shouldn't use
5253 * it to decide how many bytes to read off the network or anything
5254 * of that nature, as optimizations may choose to tell small white lies
5255 * to avoid performance overhead.
5257 * @param connection the connection
5258 * @returns the number of bytes that have been queued up but not sent
5261 dbus_connection_get_outgoing_size (DBusConnection *connection)
5265 _dbus_return_val_if_fail (connection != NULL, 0);
5267 CONNECTION_LOCK (connection);
5268 res = _dbus_counter_get_value (connection->outgoing_counter);
5269 CONNECTION_UNLOCK (connection);
5274 * Obtains the machine UUID of the machine this process is running on.
5276 * The returned string must be freed with dbus_free().
5278 * This UUID is guaranteed to remain the same until the next reboot
5279 * (unless the sysadmin foolishly changes it and screws themselves).
5280 * It will usually remain the same across reboots also, but hardware
5281 * configuration changes or rebuilding the machine could break that.
5283 * The idea is that two processes with the same machine ID should be
5284 * able to use shared memory, UNIX domain sockets, process IDs, and other
5285 * features of the OS that require both processes to be running
5286 * on the same OS kernel instance.
5288 * The machine ID can also be used to create unique per-machine
5289 * instances. For example, you could use it in bus names or
5290 * X selection names.
5292 * The machine ID is preferred over the machine hostname, because
5293 * the hostname is frequently set to "localhost.localdomain" and
5294 * may also change at runtime.
5296 * You can get the machine ID of a remote application by invoking the
5297 * method GetMachineId from interface org.freedesktop.DBus.Peer.
5299 * If the remote application has the same machine ID as the one
5300 * returned by this function, then the remote application is on the
5301 * same machine as your application.
5303 * @returns a 32-byte-long hex-encoded UUID string, or #NULL if insufficient memory
5306 dbus_get_local_machine_id (void)
5312 _dbus_string_init (&uuid);
5313 if (!_dbus_get_local_machine_uuid_encoded (&uuid) ||
5314 !_dbus_string_steal_data (&uuid, &s))
5316 _dbus_string_free (&uuid);
5321 _dbus_string_free (&uuid);