1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-connection.c DBusConnection object
4 * Copyright (C) 2002-2006 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-shared.h"
26 #include "dbus-connection.h"
27 #include "dbus-list.h"
28 #include "dbus-timeout.h"
29 #include "dbus-transport.h"
30 #include "dbus-watch.h"
31 #include "dbus-connection-internal.h"
32 #include "dbus-pending-call-internal.h"
33 #include "dbus-list.h"
34 #include "dbus-hash.h"
35 #include "dbus-message-internal.h"
36 #include "dbus-message-private.h"
37 #include "dbus-threads.h"
38 #include "dbus-protocol.h"
39 #include "dbus-dataslot.h"
40 #include "dbus-string.h"
41 #include "dbus-pending-call.h"
42 #include "dbus-object-tree.h"
43 #include "dbus-threads-internal.h"
45 #include "dbus-marshal-basic.h"
47 #ifdef DBUS_DISABLE_CHECKS
48 #define TOOK_LOCK_CHECK(connection)
49 #define RELEASING_LOCK_CHECK(connection)
50 #define HAVE_LOCK_CHECK(connection)
52 #define TOOK_LOCK_CHECK(connection) do { \
53 _dbus_assert (!(connection)->have_connection_lock); \
54 (connection)->have_connection_lock = TRUE; \
56 #define RELEASING_LOCK_CHECK(connection) do { \
57 _dbus_assert ((connection)->have_connection_lock); \
58 (connection)->have_connection_lock = FALSE; \
60 #define HAVE_LOCK_CHECK(connection) _dbus_assert ((connection)->have_connection_lock)
61 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
66 #define CONNECTION_LOCK(connection) do { \
67 if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
68 _dbus_mutex_lock ((connection)->mutex); \
69 TOOK_LOCK_CHECK (connection); \
72 #define CONNECTION_UNLOCK(connection) do { \
73 if (TRACE_LOCKS) { _dbus_verbose ("UNLOCK\n"); } \
74 RELEASING_LOCK_CHECK (connection); \
75 _dbus_mutex_unlock ((connection)->mutex); \
78 #define DISPATCH_STATUS_NAME(s) \
79 ((s) == DBUS_DISPATCH_COMPLETE ? "complete" : \
80 (s) == DBUS_DISPATCH_DATA_REMAINS ? "data remains" : \
81 (s) == DBUS_DISPATCH_NEED_MEMORY ? "need memory" : \
85 * @defgroup DBusConnection DBusConnection
87 * @brief Connection to another application
89 * A DBusConnection represents a connection to another
90 * application. Messages can be sent and received via this connection.
91 * The other application may be a message bus; for convenience, the
92 * function dbus_bus_get() is provided to automatically open a
93 * connection to the well-known message buses.
95 * In brief a DBusConnection is a message queue associated with some
96 * message transport mechanism such as a socket. The connection
97 * maintains a queue of incoming messages and a queue of outgoing
100 * Several functions use the following terms:
102 * <li><b>read</b> means to fill the incoming message queue by reading from the socket</li>
103 * <li><b>write</b> means to drain the outgoing queue by writing to the socket</li>
104 * <li><b>dispatch</b> means to drain the incoming queue by invoking application-provided message handlers</li>
107 * The function dbus_connection_read_write_dispatch() for example does all
108 * three of these things, offering a simple alternative to a main loop.
110 * In an application with a main loop, the read/write/dispatch
111 * operations are usually separate.
113 * The connection provides #DBusWatch and #DBusTimeout objects to
114 * the main loop. These are used to know when reading, writing, or
115 * dispatching should be performed.
117 * Incoming messages are processed
118 * by calling dbus_connection_dispatch(). dbus_connection_dispatch()
119 * runs any handlers registered for the topmost message in the message
120 * queue, then discards the message, then returns.
122 * dbus_connection_get_dispatch_status() indicates whether
123 * messages are currently in the queue that need dispatching.
124 * dbus_connection_set_dispatch_status_function() allows
125 * you to set a function to be used to monitor the dispatch status.
127 * If you're using GLib or Qt add-on libraries for D-Bus, there are
128 * special convenience APIs in those libraries that hide
129 * all the details of dispatch and watch/timeout monitoring.
130 * For example, dbus_connection_setup_with_g_main().
132 * If you aren't using these add-on libraries, but want to process
133 * messages asynchronously, you must manually call
134 * dbus_connection_set_dispatch_status_function(),
135 * dbus_connection_set_watch_functions(),
136 * dbus_connection_set_timeout_functions() providing appropriate
137 * functions to integrate the connection with your application's main
138 * loop. This can be tricky to get right; main loops are not simple.
140 * If you don't need to be asynchronous, you can ignore #DBusWatch,
141 * #DBusTimeout, and dbus_connection_dispatch(). Instead,
142 * dbus_connection_read_write_dispatch() can be used.
144 * Or, in <em>very</em> simple applications,
145 * dbus_connection_pop_message() may be all you need, allowing you to
146 * avoid setting up any handler functions (see
147 * dbus_connection_add_filter(),
148 * dbus_connection_register_object_path() for more on handlers).
150 * When you use dbus_connection_send() or one of its variants to send
151 * a message, the message is added to the outgoing queue. It's
152 * actually written to the network later; either in
153 * dbus_watch_handle() invoked by your main loop, or in
154 * dbus_connection_flush() which blocks until it can write out the
155 * entire outgoing queue. The GLib/Qt add-on libraries again
156 * handle the details here for you by setting up watch functions.
158 * When a connection is disconnected, you are guaranteed to get a
159 * signal "Disconnected" from the interface
160 * #DBUS_INTERFACE_LOCAL, path
163 * You may not drop the last reference to a #DBusConnection
164 * until that connection has been disconnected.
166 * You may dispatch the unprocessed incoming message queue even if the
167 * connection is disconnected. However, "Disconnected" will always be
168 * the last message in the queue (obviously no messages are received
169 * after disconnection).
171 * After calling dbus_threads_init(), #DBusConnection has thread
172 * locks and drops them when invoking user callbacks, so in general is
173 * transparently threadsafe. However, #DBusMessage does NOT have
174 * thread locks; you must not send the same message to multiple
175 * #DBusConnection if those connections will be used from different threads,
178 * Also, if you dispatch or pop messages from multiple threads, it
179 * may work in the sense that it won't crash, but it's tough to imagine
180 * sane results; it will be completely unpredictable which messages
181 * go to which threads.
183 * It's recommended to dispatch from a single thread.
185 * The most useful function to call from multiple threads at once
186 * is dbus_connection_send_with_reply_and_block(). That is,
187 * multiple threads can make method calls at the same time.
189 * If you aren't using threads, you can use a main loop and
190 * dbus_pending_call_set_notify() to achieve a similar result.
194 * @defgroup DBusConnectionInternals DBusConnection implementation details
195 * @ingroup DBusInternals
196 * @brief Implementation details of DBusConnection
202 * Internal struct representing a message filter function
204 typedef struct DBusMessageFilter DBusMessageFilter;
207 * Internal struct representing a message filter function
209 struct DBusMessageFilter
211 DBusAtomic refcount; /**< Reference count */
212 DBusHandleMessageFunction function; /**< Function to call to filter */
213 void *user_data; /**< User data for the function */
214 DBusFreeFunction free_user_data_function; /**< Function to free the user data */
219 * Internals of DBusPreallocatedSend
221 struct DBusPreallocatedSend
223 DBusConnection *connection; /**< Connection we'd send the message to */
224 DBusList *queue_link; /**< Preallocated link in the queue */
225 DBusList *counter_link; /**< Preallocated link in the resource counter */
228 #ifdef HAVE_DECL_MSG_NOSIGNAL
229 static dbus_bool_t _dbus_modify_sigpipe = FALSE;
231 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
235 * Implementation details of DBusConnection. All fields are private.
237 struct DBusConnection
239 DBusAtomic refcount; /**< Reference count. */
241 DBusMutex *mutex; /**< Lock on the entire DBusConnection */
243 DBusMutex *dispatch_mutex; /**< Protects dispatch_acquired */
244 DBusCondVar *dispatch_cond; /**< Notify when dispatch_acquired is available */
245 DBusMutex *io_path_mutex; /**< Protects io_path_acquired */
246 DBusCondVar *io_path_cond; /**< Notify when io_path_acquired is available */
248 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
249 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
251 DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
252 * dispatch_acquired will be set by the borrower
255 int n_outgoing; /**< Length of outgoing queue. */
256 int n_incoming; /**< Length of incoming queue. */
258 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
260 DBusTransport *transport; /**< Object that sends/receives messages over network. */
261 DBusWatchList *watches; /**< Stores active watches. */
262 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
264 DBusList *filter_list; /**< List of filters. */
266 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
268 DBusHashTable *pending_replies; /**< Hash of message serials to #DBusPendingCall. */
270 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
271 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
273 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
274 void *wakeup_main_data; /**< Application data for wakeup_main_function */
275 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
277 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
278 void *dispatch_status_data; /**< Application data for dispatch_status_function */
279 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
281 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
283 DBusList *link_cache; /**< A cache of linked list links to prevent contention
284 * for the global linked list mempool lock
286 DBusObjectTree *objects; /**< Object path handlers registered with this connection */
288 char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
290 /* These two MUST be bools and not bitfields, because they are protected by a separate lock
291 * from connection->mutex and all bitfields in a word have to be read/written together.
292 * So you can't have a different lock for different bitfields in the same word.
294 dbus_bool_t dispatch_acquired; /**< Someone has dispatch path (can drain incoming queue) */
295 dbus_bool_t io_path_acquired; /**< Someone has transport io path (can use the transport to read/write messages) */
297 unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
299 unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
301 unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
303 unsigned int disconnected_message_arrived : 1; /**< We popped or are dispatching the disconnected message.
304 * if the disconnect_message_link is NULL then we queued it, but
305 * this flag is whether it got to the head of the queue.
307 unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
308 * such as closing the connection.
311 #ifndef DBUS_DISABLE_CHECKS
312 unsigned int have_connection_lock : 1; /**< Used to check locking */
315 #ifndef DBUS_DISABLE_CHECKS
316 int generation; /**< _dbus_current_generation that should correspond to this connection */
320 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
321 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
322 DBusDispatchStatus new_status);
323 static void _dbus_connection_last_unref (DBusConnection *connection);
324 static void _dbus_connection_acquire_dispatch (DBusConnection *connection);
325 static void _dbus_connection_release_dispatch (DBusConnection *connection);
326 static DBusDispatchStatus _dbus_connection_flush_unlocked (DBusConnection *connection);
327 static void _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection);
328 static dbus_bool_t _dbus_connection_get_is_connected_unlocked (DBusConnection *connection);
330 static DBusMessageFilter *
331 _dbus_message_filter_ref (DBusMessageFilter *filter)
333 _dbus_assert (filter->refcount.value > 0);
334 _dbus_atomic_inc (&filter->refcount);
340 _dbus_message_filter_unref (DBusMessageFilter *filter)
342 _dbus_assert (filter->refcount.value > 0);
344 if (_dbus_atomic_dec (&filter->refcount) == 1)
346 if (filter->free_user_data_function)
347 (* filter->free_user_data_function) (filter->user_data);
354 * Acquires the connection lock.
356 * @param connection the connection.
359 _dbus_connection_lock (DBusConnection *connection)
361 CONNECTION_LOCK (connection);
365 * Releases the connection lock.
367 * @param connection the connection.
370 _dbus_connection_unlock (DBusConnection *connection)
372 CONNECTION_UNLOCK (connection);
376 * Wakes up the main loop if it is sleeping
377 * Needed if we're e.g. queueing outgoing messages
378 * on a thread while the mainloop sleeps.
380 * @param connection the connection.
383 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
385 if (connection->wakeup_main_function)
386 (*connection->wakeup_main_function) (connection->wakeup_main_data);
389 #ifdef DBUS_BUILD_TESTS
390 /* For now this function isn't used */
392 * Adds a message to the incoming message queue, returning #FALSE
393 * if there's insufficient memory to queue the message.
394 * Does not take over refcount of the message.
396 * @param connection the connection.
397 * @param message the message to queue.
398 * @returns #TRUE on success.
401 _dbus_connection_queue_received_message (DBusConnection *connection,
402 DBusMessage *message)
406 link = _dbus_list_alloc_link (message);
410 dbus_message_ref (message);
411 _dbus_connection_queue_received_message_link (connection, link);
417 * Gets the locks so we can examine them
419 * @param connection the connection.
420 * @param mutex_loc return for the location of the main mutex pointer
421 * @param dispatch_mutex_loc return location of the dispatch mutex pointer
422 * @param io_path_mutex_loc return location of the io_path mutex pointer
423 * @param dispatch_cond_loc return location of the dispatch conditional
425 * @param io_path_cond_loc return location of the io_path conditional
429 _dbus_connection_test_get_locks (DBusConnection *connection,
430 DBusMutex **mutex_loc,
431 DBusMutex **dispatch_mutex_loc,
432 DBusMutex **io_path_mutex_loc,
433 DBusCondVar **dispatch_cond_loc,
434 DBusCondVar **io_path_cond_loc)
436 *mutex_loc = connection->mutex;
437 *dispatch_mutex_loc = connection->dispatch_mutex;
438 *io_path_mutex_loc = connection->io_path_mutex;
439 *dispatch_cond_loc = connection->dispatch_cond;
440 *io_path_cond_loc = connection->io_path_cond;
445 * Adds a message-containing list link to the incoming message queue,
446 * taking ownership of the link and the message's current refcount.
447 * Cannot fail due to lack of memory.
449 * @param connection the connection.
450 * @param link the message link to queue.
453 _dbus_connection_queue_received_message_link (DBusConnection *connection,
456 DBusPendingCall *pending;
457 dbus_uint32_t reply_serial;
458 DBusMessage *message;
460 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
462 _dbus_list_append_link (&connection->incoming_messages,
464 message = link->data;
466 /* If this is a reply we're waiting on, remove timeout for it */
467 reply_serial = dbus_message_get_reply_serial (message);
468 if (reply_serial != 0)
470 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
474 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
475 _dbus_connection_remove_timeout_unlocked (connection,
476 _dbus_pending_call_get_timeout_unlocked (pending));
478 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
484 connection->n_incoming += 1;
486 _dbus_connection_wakeup_mainloop (connection);
488 _dbus_verbose ("Message %p (%s %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
490 dbus_message_type_to_string (dbus_message_get_type (message)),
491 dbus_message_get_path (message) ?
492 dbus_message_get_path (message) :
494 dbus_message_get_interface (message) ?
495 dbus_message_get_interface (message) :
497 dbus_message_get_member (message) ?
498 dbus_message_get_member (message) :
500 dbus_message_get_signature (message),
501 dbus_message_get_reply_serial (message),
503 connection->n_incoming);}
506 * Adds a link + message to the incoming message queue.
507 * Can't fail. Takes ownership of both link and message.
509 * @param connection the connection.
510 * @param link the list node and message to queue.
514 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
517 HAVE_LOCK_CHECK (connection);
519 _dbus_list_append_link (&connection->incoming_messages, link);
521 connection->n_incoming += 1;
523 _dbus_connection_wakeup_mainloop (connection);
525 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
526 link->data, connection, connection->n_incoming);
531 * Checks whether there are messages in the outgoing message queue.
532 * Called with connection lock held.
534 * @param connection the connection.
535 * @returns #TRUE if the outgoing queue is non-empty.
538 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
540 HAVE_LOCK_CHECK (connection);
541 return connection->outgoing_messages != NULL;
545 * Checks whether there are messages in the outgoing message queue.
546 * Use dbus_connection_flush() to block until all outgoing
547 * messages have been written to the underlying transport
548 * (such as a socket).
550 * @param connection the connection.
551 * @returns #TRUE if the outgoing queue is non-empty.
554 dbus_connection_has_messages_to_send (DBusConnection *connection)
558 _dbus_return_val_if_fail (connection != NULL, FALSE);
560 CONNECTION_LOCK (connection);
561 v = _dbus_connection_has_messages_to_send_unlocked (connection);
562 CONNECTION_UNLOCK (connection);
568 * Gets the next outgoing message. The message remains in the
569 * queue, and the caller does not own a reference to it.
571 * @param connection the connection.
572 * @returns the message to be sent.
575 _dbus_connection_get_message_to_send (DBusConnection *connection)
577 HAVE_LOCK_CHECK (connection);
579 return _dbus_list_get_last (&connection->outgoing_messages);
583 * Notifies the connection that a message has been sent, so the
584 * message can be removed from the outgoing queue.
585 * Called with the connection lock held.
587 * @param connection the connection.
588 * @param message the message that was sent.
591 _dbus_connection_message_sent (DBusConnection *connection,
592 DBusMessage *message)
596 HAVE_LOCK_CHECK (connection);
598 /* This can be called before we even complete authentication, since
599 * it's called on disconnect to clean up the outgoing queue.
600 * It's also called as we successfully send each message.
603 link = _dbus_list_get_last_link (&connection->outgoing_messages);
604 _dbus_assert (link != NULL);
605 _dbus_assert (link->data == message);
607 /* Save this link in the link cache */
608 _dbus_list_unlink (&connection->outgoing_messages,
610 _dbus_list_prepend_link (&connection->link_cache, link);
612 connection->n_outgoing -= 1;
614 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
616 dbus_message_type_to_string (dbus_message_get_type (message)),
617 dbus_message_get_path (message) ?
618 dbus_message_get_path (message) :
620 dbus_message_get_interface (message) ?
621 dbus_message_get_interface (message) :
623 dbus_message_get_member (message) ?
624 dbus_message_get_member (message) :
626 dbus_message_get_signature (message),
627 connection, connection->n_outgoing);
629 /* Save this link in the link cache also */
630 _dbus_message_remove_counter (message, connection->outgoing_counter,
632 _dbus_list_prepend_link (&connection->link_cache, link);
634 dbus_message_unref (message);
637 /** Function to be called in protected_change_watch() with refcount held */
638 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
640 /** Function to be called in protected_change_watch() with refcount held */
641 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
643 /** Function to be called in protected_change_watch() with refcount held */
644 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
646 dbus_bool_t enabled);
649 protected_change_watch (DBusConnection *connection,
651 DBusWatchAddFunction add_function,
652 DBusWatchRemoveFunction remove_function,
653 DBusWatchToggleFunction toggle_function,
656 DBusWatchList *watches;
659 HAVE_LOCK_CHECK (connection);
661 /* This isn't really safe or reasonable; a better pattern is the "do everything, then
662 * drop lock and call out" one; but it has to be propagated up through all callers
665 watches = connection->watches;
668 connection->watches = NULL;
669 _dbus_connection_ref_unlocked (connection);
670 CONNECTION_UNLOCK (connection);
673 retval = (* add_function) (watches, watch);
674 else if (remove_function)
677 (* remove_function) (watches, watch);
682 (* toggle_function) (watches, watch, enabled);
685 CONNECTION_LOCK (connection);
686 connection->watches = watches;
687 _dbus_connection_unref_unlocked (connection);
697 * Adds a watch using the connection's DBusAddWatchFunction if
698 * available. Otherwise records the watch to be added when said
699 * function is available. Also re-adds the watch if the
700 * DBusAddWatchFunction changes. May fail due to lack of memory.
701 * Connection lock should be held when calling this.
703 * @param connection the connection.
704 * @param watch the watch to add.
705 * @returns #TRUE on success.
708 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
711 return protected_change_watch (connection, watch,
712 _dbus_watch_list_add_watch,
717 * Removes a watch using the connection's DBusRemoveWatchFunction
718 * if available. It's an error to call this function on a watch
719 * that was not previously added.
720 * Connection lock should be held when calling this.
722 * @param connection the connection.
723 * @param watch the watch to remove.
726 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
729 protected_change_watch (connection, watch,
731 _dbus_watch_list_remove_watch,
736 * Toggles a watch and notifies app via connection's
737 * DBusWatchToggledFunction if available. It's an error to call this
738 * function on a watch that was not previously added.
739 * Connection lock should be held when calling this.
741 * @param connection the connection.
742 * @param watch the watch to toggle.
743 * @param enabled whether to enable or disable
746 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
750 _dbus_assert (watch != NULL);
752 protected_change_watch (connection, watch,
754 _dbus_watch_list_toggle_watch,
758 /** Function to be called in protected_change_timeout() with refcount held */
759 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
760 DBusTimeout *timeout);
761 /** Function to be called in protected_change_timeout() with refcount held */
762 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
763 DBusTimeout *timeout);
764 /** Function to be called in protected_change_timeout() with refcount held */
765 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
766 DBusTimeout *timeout,
767 dbus_bool_t enabled);
770 protected_change_timeout (DBusConnection *connection,
771 DBusTimeout *timeout,
772 DBusTimeoutAddFunction add_function,
773 DBusTimeoutRemoveFunction remove_function,
774 DBusTimeoutToggleFunction toggle_function,
777 DBusTimeoutList *timeouts;
780 HAVE_LOCK_CHECK (connection);
782 /* This isn't really safe or reasonable; a better pattern is the "do everything, then
783 * drop lock and call out" one; but it has to be propagated up through all callers
786 timeouts = connection->timeouts;
789 connection->timeouts = NULL;
790 _dbus_connection_ref_unlocked (connection);
791 CONNECTION_UNLOCK (connection);
794 retval = (* add_function) (timeouts, timeout);
795 else if (remove_function)
798 (* remove_function) (timeouts, timeout);
803 (* toggle_function) (timeouts, timeout, enabled);
806 CONNECTION_LOCK (connection);
807 connection->timeouts = timeouts;
808 _dbus_connection_unref_unlocked (connection);
817 * Adds a timeout using the connection's DBusAddTimeoutFunction if
818 * available. Otherwise records the timeout to be added when said
819 * function is available. Also re-adds the timeout if the
820 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
821 * The timeout will fire repeatedly until removed.
822 * Connection lock should be held when calling this.
824 * @param connection the connection.
825 * @param timeout the timeout to add.
826 * @returns #TRUE on success.
829 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
830 DBusTimeout *timeout)
832 return protected_change_timeout (connection, timeout,
833 _dbus_timeout_list_add_timeout,
838 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
839 * if available. It's an error to call this function on a timeout
840 * that was not previously added.
841 * Connection lock should be held when calling this.
843 * @param connection the connection.
844 * @param timeout the timeout to remove.
847 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
848 DBusTimeout *timeout)
850 protected_change_timeout (connection, timeout,
852 _dbus_timeout_list_remove_timeout,
857 * Toggles a timeout and notifies app via connection's
858 * DBusTimeoutToggledFunction if available. It's an error to call this
859 * function on a timeout that was not previously added.
860 * Connection lock should be held when calling this.
862 * @param connection the connection.
863 * @param timeout the timeout to toggle.
864 * @param enabled whether to enable or disable
867 _dbus_connection_toggle_timeout_unlocked (DBusConnection *connection,
868 DBusTimeout *timeout,
871 protected_change_timeout (connection, timeout,
873 _dbus_timeout_list_toggle_timeout,
878 _dbus_connection_attach_pending_call_unlocked (DBusConnection *connection,
879 DBusPendingCall *pending)
881 dbus_uint32_t reply_serial;
882 DBusTimeout *timeout;
884 HAVE_LOCK_CHECK (connection);
886 reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
888 _dbus_assert (reply_serial != 0);
890 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
894 if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
897 if (!_dbus_hash_table_insert_int (connection->pending_replies,
901 _dbus_connection_remove_timeout_unlocked (connection, timeout);
903 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
904 HAVE_LOCK_CHECK (connection);
908 _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
912 if (!_dbus_hash_table_insert_int (connection->pending_replies,
916 HAVE_LOCK_CHECK (connection);
921 _dbus_pending_call_ref_unlocked (pending);
923 HAVE_LOCK_CHECK (connection);
929 free_pending_call_on_hash_removal (void *data)
931 DBusPendingCall *pending;
932 DBusConnection *connection;
939 connection = _dbus_pending_call_get_connection_unlocked (pending);
941 HAVE_LOCK_CHECK (connection);
943 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
945 _dbus_connection_remove_timeout_unlocked (connection,
946 _dbus_pending_call_get_timeout_unlocked (pending));
948 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
951 /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
952 * here, but the pending call finalizer could in principle call out to
953 * application code so we pretty much have to... some larger code reorg
956 _dbus_connection_ref_unlocked (connection);
957 _dbus_pending_call_unref_and_unlock (pending);
958 CONNECTION_LOCK (connection);
959 _dbus_connection_unref_unlocked (connection);
963 _dbus_connection_detach_pending_call_unlocked (DBusConnection *connection,
964 DBusPendingCall *pending)
966 /* This ends up unlocking to call the pending call finalizer, which is unexpected to
969 _dbus_hash_table_remove_int (connection->pending_replies,
970 _dbus_pending_call_get_reply_serial_unlocked (pending));
974 _dbus_connection_detach_pending_call_and_unlock (DBusConnection *connection,
975 DBusPendingCall *pending)
977 /* The idea here is to avoid finalizing the pending call
978 * with the lock held, since there's a destroy notifier
979 * in pending call that goes out to application code.
981 * There's an extra unlock inside the hash table
982 * "free pending call" function FIXME...
984 _dbus_pending_call_ref_unlocked (pending);
985 _dbus_hash_table_remove_int (connection->pending_replies,
986 _dbus_pending_call_get_reply_serial_unlocked (pending));
988 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
989 _dbus_connection_remove_timeout_unlocked (connection,
990 _dbus_pending_call_get_timeout_unlocked (pending));
992 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
994 _dbus_pending_call_unref_and_unlock (pending);
998 * Removes a pending call from the connection, such that
999 * the pending reply will be ignored. May drop the last
1000 * reference to the pending call.
1002 * @param connection the connection
1003 * @param pending the pending call
1006 _dbus_connection_remove_pending_call (DBusConnection *connection,
1007 DBusPendingCall *pending)
1009 CONNECTION_LOCK (connection);
1010 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
1014 * Acquire the transporter I/O path. This must be done before
1015 * doing any I/O in the transporter. May sleep and drop the
1016 * IO path mutex while waiting for the I/O path.
1018 * @param connection the connection.
1019 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1020 * @returns TRUE if the I/O path was acquired.
1023 _dbus_connection_acquire_io_path (DBusConnection *connection,
1024 int timeout_milliseconds)
1026 dbus_bool_t we_acquired;
1028 HAVE_LOCK_CHECK (connection);
1030 /* We don't want the connection to vanish */
1031 _dbus_connection_ref_unlocked (connection);
1033 /* We will only touch io_path_acquired which is protected by our mutex */
1034 CONNECTION_UNLOCK (connection);
1036 _dbus_verbose ("locking io_path_mutex\n");
1037 _dbus_mutex_lock (connection->io_path_mutex);
1039 _dbus_verbose ("start connection->io_path_acquired = %d timeout = %d\n",
1040 connection->io_path_acquired, timeout_milliseconds);
1042 we_acquired = FALSE;
1044 if (connection->io_path_acquired)
1046 if (timeout_milliseconds != -1)
1048 _dbus_verbose ("waiting %d for IO path to be acquirable\n",
1049 timeout_milliseconds);
1051 if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1052 connection->io_path_mutex,
1053 timeout_milliseconds))
1055 /* We timed out before anyone signaled. */
1056 /* (writing the loop to handle the !timedout case by
1057 * waiting longer if needed is a pain since dbus
1058 * wraps pthread_cond_timedwait to take a relative
1059 * time instead of absolute, something kind of stupid
1060 * on our part. for now it doesn't matter, we will just
1061 * end up back here eventually.)
1067 while (connection->io_path_acquired)
1069 _dbus_verbose ("waiting for IO path to be acquirable\n");
1070 _dbus_condvar_wait (connection->io_path_cond,
1071 connection->io_path_mutex);
1076 if (!connection->io_path_acquired)
1079 connection->io_path_acquired = TRUE;
1082 _dbus_verbose ("end connection->io_path_acquired = %d we_acquired = %d\n",
1083 connection->io_path_acquired, we_acquired);
1085 _dbus_verbose ("unlocking io_path_mutex\n");
1086 _dbus_mutex_unlock (connection->io_path_mutex);
1088 CONNECTION_LOCK (connection);
1090 HAVE_LOCK_CHECK (connection);
1092 _dbus_connection_unref_unlocked (connection);
1098 * Release the I/O path when you're done with it. Only call
1099 * after you've acquired the I/O. Wakes up at most one thread
1100 * currently waiting to acquire the I/O path.
1102 * @param connection the connection.
1105 _dbus_connection_release_io_path (DBusConnection *connection)
1107 HAVE_LOCK_CHECK (connection);
1109 _dbus_verbose ("locking io_path_mutex\n");
1110 _dbus_mutex_lock (connection->io_path_mutex);
1112 _dbus_assert (connection->io_path_acquired);
1114 _dbus_verbose ("start connection->io_path_acquired = %d\n",
1115 connection->io_path_acquired);
1117 connection->io_path_acquired = FALSE;
1118 _dbus_condvar_wake_one (connection->io_path_cond);
1120 _dbus_verbose ("unlocking io_path_mutex\n");
1121 _dbus_mutex_unlock (connection->io_path_mutex);
1125 * Queues incoming messages and sends outgoing messages for this
1126 * connection, optionally blocking in the process. Each call to
1127 * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1128 * time and then read or write data if possible.
1130 * The purpose of this function is to be able to flush outgoing
1131 * messages or queue up incoming messages without returning
1132 * control to the application and causing reentrancy weirdness.
1134 * The flags parameter allows you to specify whether to
1135 * read incoming messages, write outgoing messages, or both,
1136 * and whether to block if no immediate action is possible.
1138 * The timeout_milliseconds parameter does nothing unless the
1139 * iteration is blocking.
1141 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1142 * wasn't specified, then it's impossible to block, even if
1143 * you specify DBUS_ITERATION_BLOCK; in that case the function
1144 * returns immediately.
1146 * Called with connection lock held.
1148 * @param connection the connection.
1149 * @param flags iteration flags.
1150 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1153 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1155 int timeout_milliseconds)
1157 _dbus_verbose ("start\n");
1159 HAVE_LOCK_CHECK (connection);
1161 if (connection->n_outgoing == 0)
1162 flags &= ~DBUS_ITERATION_DO_WRITING;
1164 if (_dbus_connection_acquire_io_path (connection,
1165 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1167 HAVE_LOCK_CHECK (connection);
1169 _dbus_transport_do_iteration (connection->transport,
1170 flags, timeout_milliseconds);
1171 _dbus_connection_release_io_path (connection);
1174 HAVE_LOCK_CHECK (connection);
1176 _dbus_verbose ("end\n");
1180 * Creates a new connection for the given transport. A transport
1181 * represents a message stream that uses some concrete mechanism, such
1182 * as UNIX domain sockets. May return #NULL if insufficient
1183 * memory exists to create the connection.
1185 * @param transport the transport.
1186 * @returns the new connection, or #NULL on failure.
1189 _dbus_connection_new_for_transport (DBusTransport *transport)
1191 DBusConnection *connection;
1192 DBusWatchList *watch_list;
1193 DBusTimeoutList *timeout_list;
1194 DBusHashTable *pending_replies;
1195 DBusList *disconnect_link;
1196 DBusMessage *disconnect_message;
1197 DBusCounter *outgoing_counter;
1198 DBusObjectTree *objects;
1202 pending_replies = NULL;
1203 timeout_list = NULL;
1204 disconnect_link = NULL;
1205 disconnect_message = NULL;
1206 outgoing_counter = NULL;
1209 watch_list = _dbus_watch_list_new ();
1210 if (watch_list == NULL)
1213 timeout_list = _dbus_timeout_list_new ();
1214 if (timeout_list == NULL)
1218 _dbus_hash_table_new (DBUS_HASH_INT,
1220 (DBusFreeFunction)free_pending_call_on_hash_removal);
1221 if (pending_replies == NULL)
1224 connection = dbus_new0 (DBusConnection, 1);
1225 if (connection == NULL)
1228 _dbus_mutex_new_at_location (&connection->mutex);
1229 if (connection->mutex == NULL)
1232 _dbus_mutex_new_at_location (&connection->io_path_mutex);
1233 if (connection->io_path_mutex == NULL)
1236 _dbus_mutex_new_at_location (&connection->dispatch_mutex);
1237 if (connection->dispatch_mutex == NULL)
1240 _dbus_condvar_new_at_location (&connection->dispatch_cond);
1241 if (connection->dispatch_cond == NULL)
1244 _dbus_condvar_new_at_location (&connection->io_path_cond);
1245 if (connection->io_path_cond == NULL)
1248 disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1249 DBUS_INTERFACE_LOCAL,
1252 if (disconnect_message == NULL)
1255 disconnect_link = _dbus_list_alloc_link (disconnect_message);
1256 if (disconnect_link == NULL)
1259 outgoing_counter = _dbus_counter_new ();
1260 if (outgoing_counter == NULL)
1263 objects = _dbus_object_tree_new (connection);
1264 if (objects == NULL)
1267 if (_dbus_modify_sigpipe)
1268 _dbus_disable_sigpipe ();
1270 connection->refcount.value = 1;
1271 connection->transport = transport;
1272 connection->watches = watch_list;
1273 connection->timeouts = timeout_list;
1274 connection->pending_replies = pending_replies;
1275 connection->outgoing_counter = outgoing_counter;
1276 connection->filter_list = NULL;
1277 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1278 connection->objects = objects;
1279 connection->exit_on_disconnect = FALSE;
1280 connection->shareable = FALSE;
1281 connection->route_peer_messages = FALSE;
1282 connection->disconnected_message_arrived = FALSE;
1283 connection->disconnected_message_processed = FALSE;
1285 #ifndef DBUS_DISABLE_CHECKS
1286 connection->generation = _dbus_current_generation;
1289 _dbus_data_slot_list_init (&connection->slot_list);
1291 connection->client_serial = 1;
1293 connection->disconnect_message_link = disconnect_link;
1295 CONNECTION_LOCK (connection);
1297 if (!_dbus_transport_set_connection (transport, connection))
1299 CONNECTION_UNLOCK (connection);
1304 _dbus_transport_ref (transport);
1306 CONNECTION_UNLOCK (connection);
1311 if (disconnect_message != NULL)
1312 dbus_message_unref (disconnect_message);
1314 if (disconnect_link != NULL)
1315 _dbus_list_free_link (disconnect_link);
1317 if (connection != NULL)
1319 _dbus_condvar_free_at_location (&connection->io_path_cond);
1320 _dbus_condvar_free_at_location (&connection->dispatch_cond);
1321 _dbus_mutex_free_at_location (&connection->mutex);
1322 _dbus_mutex_free_at_location (&connection->io_path_mutex);
1323 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
1324 dbus_free (connection);
1326 if (pending_replies)
1327 _dbus_hash_table_unref (pending_replies);
1330 _dbus_watch_list_free (watch_list);
1333 _dbus_timeout_list_free (timeout_list);
1335 if (outgoing_counter)
1336 _dbus_counter_unref (outgoing_counter);
1339 _dbus_object_tree_unref (objects);
1345 * Increments the reference count of a DBusConnection.
1346 * Requires that the caller already holds the connection lock.
1348 * @param connection the connection.
1349 * @returns the connection.
1352 _dbus_connection_ref_unlocked (DBusConnection *connection)
1354 _dbus_assert (connection != NULL);
1355 _dbus_assert (connection->generation == _dbus_current_generation);
1357 HAVE_LOCK_CHECK (connection);
1359 #ifdef DBUS_HAVE_ATOMIC_INT
1360 _dbus_atomic_inc (&connection->refcount);
1362 _dbus_assert (connection->refcount.value > 0);
1363 connection->refcount.value += 1;
1370 * Decrements the reference count of a DBusConnection.
1371 * Requires that the caller already holds the connection lock.
1373 * @param connection the connection.
1376 _dbus_connection_unref_unlocked (DBusConnection *connection)
1378 dbus_bool_t last_unref;
1380 HAVE_LOCK_CHECK (connection);
1382 _dbus_assert (connection != NULL);
1384 /* The connection lock is better than the global
1385 * lock in the atomic increment fallback
1388 #ifdef DBUS_HAVE_ATOMIC_INT
1389 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1391 _dbus_assert (connection->refcount.value > 0);
1393 connection->refcount.value -= 1;
1394 last_unref = (connection->refcount.value == 0);
1396 printf ("unref_unlocked() connection %p count = %d\n", connection, connection->refcount.value);
1401 _dbus_connection_last_unref (connection);
1404 static dbus_uint32_t
1405 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1407 dbus_uint32_t serial;
1409 serial = connection->client_serial++;
1411 if (connection->client_serial == 0)
1412 connection->client_serial = 1;
1418 * A callback for use with dbus_watch_new() to create a DBusWatch.
1420 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1421 * and the virtual handle_watch in DBusTransport if we got rid of it.
1422 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1425 * @param watch the watch.
1426 * @param condition the current condition of the file descriptors being watched.
1427 * @param data must be a pointer to a #DBusConnection
1428 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1431 _dbus_connection_handle_watch (DBusWatch *watch,
1432 unsigned int condition,
1435 DBusConnection *connection;
1437 DBusDispatchStatus status;
1441 _dbus_verbose ("start\n");
1443 CONNECTION_LOCK (connection);
1445 if (!_dbus_connection_acquire_io_path (connection, 1))
1447 /* another thread is handling the message */
1448 CONNECTION_UNLOCK (connection);
1452 HAVE_LOCK_CHECK (connection);
1453 retval = _dbus_transport_handle_watch (connection->transport,
1456 _dbus_connection_release_io_path (connection);
1458 HAVE_LOCK_CHECK (connection);
1460 _dbus_verbose ("middle\n");
1462 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1464 /* this calls out to user code */
1465 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1467 _dbus_verbose ("end\n");
1472 _DBUS_DEFINE_GLOBAL_LOCK (shared_connections);
1473 static DBusHashTable *shared_connections = NULL;
1474 static DBusList *shared_connections_no_guid = NULL;
1477 close_connection_on_shutdown (DBusConnection *connection)
1479 DBusMessage *message;
1481 dbus_connection_ref (connection);
1482 _dbus_connection_close_possibly_shared (connection);
1484 /* Churn through to the Disconnected message */
1485 while ((message = dbus_connection_pop_message (connection)))
1487 dbus_message_unref (message);
1489 dbus_connection_unref (connection);
1493 shared_connections_shutdown (void *data)
1497 _DBUS_LOCK (shared_connections);
1499 /* This is a little bit unpleasant... better ideas? */
1500 while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1502 DBusConnection *connection;
1505 _dbus_hash_iter_init (shared_connections, &iter);
1506 _dbus_hash_iter_next (&iter);
1508 connection = _dbus_hash_iter_get_value (&iter);
1510 _DBUS_UNLOCK (shared_connections);
1511 close_connection_on_shutdown (connection);
1512 _DBUS_LOCK (shared_connections);
1514 /* The connection should now be dead and not in our hash ... */
1515 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1518 _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1520 _dbus_hash_table_unref (shared_connections);
1521 shared_connections = NULL;
1523 if (shared_connections_no_guid != NULL)
1525 DBusConnection *connection;
1526 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1527 while (connection != NULL)
1529 _DBUS_UNLOCK (shared_connections);
1530 close_connection_on_shutdown (connection);
1531 _DBUS_LOCK (shared_connections);
1532 connection = _dbus_list_pop_first (&shared_connections_no_guid);
1536 shared_connections_no_guid = NULL;
1538 _DBUS_UNLOCK (shared_connections);
1542 connection_lookup_shared (DBusAddressEntry *entry,
1543 DBusConnection **result)
1545 _dbus_verbose ("checking for existing connection\n");
1549 _DBUS_LOCK (shared_connections);
1551 if (shared_connections == NULL)
1553 _dbus_verbose ("creating shared_connections hash table\n");
1555 shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1558 if (shared_connections == NULL)
1560 _DBUS_UNLOCK (shared_connections);
1564 if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1566 _dbus_hash_table_unref (shared_connections);
1567 shared_connections = NULL;
1568 _DBUS_UNLOCK (shared_connections);
1572 _dbus_verbose (" successfully created shared_connections\n");
1574 _DBUS_UNLOCK (shared_connections);
1575 return TRUE; /* no point looking up in the hash we just made */
1581 guid = dbus_address_entry_get_value (entry, "guid");
1585 DBusConnection *connection;
1587 connection = _dbus_hash_table_lookup_string (shared_connections,
1592 /* The DBusConnection can't be finalized without taking
1593 * the shared_connections lock to remove it from the
1594 * hash. So it's safe to ref the connection here.
1595 * However, it may be disconnected if the Disconnected
1596 * message hasn't been processed yet, in which case we
1597 * want to pretend it isn't in the hash and avoid
1600 * The idea is to avoid ever returning a disconnected connection
1601 * from dbus_connection_open(). We could just synchronously
1602 * drop our shared ref to the connection on connection disconnect,
1603 * and then assert here that the connection is connected, but
1604 * that causes reentrancy headaches.
1606 CONNECTION_LOCK (connection);
1607 if (_dbus_connection_get_is_connected_unlocked (connection))
1609 _dbus_connection_ref_unlocked (connection);
1610 *result = connection;
1611 _dbus_verbose ("looked up existing connection to server guid %s\n",
1616 _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1619 CONNECTION_UNLOCK (connection);
1623 _DBUS_UNLOCK (shared_connections);
1629 connection_record_shared_unlocked (DBusConnection *connection,
1633 char *guid_in_connection;
1635 HAVE_LOCK_CHECK (connection);
1636 _dbus_assert (connection->server_guid == NULL);
1637 _dbus_assert (connection->shareable);
1639 /* get a hard ref on this connection, even if
1640 * we won't in fact store it in the hash, we still
1641 * need to hold a ref on it until it's disconnected.
1643 _dbus_connection_ref_unlocked (connection);
1647 _DBUS_LOCK (shared_connections);
1649 if (!_dbus_list_prepend (&shared_connections_no_guid, connection))
1651 _DBUS_UNLOCK (shared_connections);
1655 _DBUS_UNLOCK (shared_connections);
1656 return TRUE; /* don't store in the hash */
1659 /* A separate copy of the key is required in the hash table, because
1660 * we don't have a lock on the connection when we are doing a hash
1664 guid_key = _dbus_strdup (guid);
1665 if (guid_key == NULL)
1668 guid_in_connection = _dbus_strdup (guid);
1669 if (guid_in_connection == NULL)
1671 dbus_free (guid_key);
1675 _DBUS_LOCK (shared_connections);
1676 _dbus_assert (shared_connections != NULL);
1678 if (!_dbus_hash_table_insert_string (shared_connections,
1679 guid_key, connection))
1681 dbus_free (guid_key);
1682 dbus_free (guid_in_connection);
1683 _DBUS_UNLOCK (shared_connections);
1687 connection->server_guid = guid_in_connection;
1689 _dbus_verbose ("stored connection to %s to be shared\n",
1690 connection->server_guid);
1692 _DBUS_UNLOCK (shared_connections);
1694 _dbus_assert (connection->server_guid != NULL);
1700 connection_forget_shared_unlocked (DBusConnection *connection)
1702 HAVE_LOCK_CHECK (connection);
1704 if (!connection->shareable)
1707 _DBUS_LOCK (shared_connections);
1709 if (connection->server_guid != NULL)
1711 _dbus_verbose ("dropping connection to %s out of the shared table\n",
1712 connection->server_guid);
1714 if (!_dbus_hash_table_remove_string (shared_connections,
1715 connection->server_guid))
1716 _dbus_assert_not_reached ("connection was not in the shared table");
1718 dbus_free (connection->server_guid);
1719 connection->server_guid = NULL;
1723 _dbus_list_remove (&shared_connections_no_guid, connection);
1726 _DBUS_UNLOCK (shared_connections);
1728 /* remove our reference held on all shareable connections */
1729 _dbus_connection_unref_unlocked (connection);
1732 static DBusConnection*
1733 connection_try_from_address_entry (DBusAddressEntry *entry,
1736 DBusTransport *transport;
1737 DBusConnection *connection;
1739 transport = _dbus_transport_open (entry, error);
1741 if (transport == NULL)
1743 _DBUS_ASSERT_ERROR_IS_SET (error);
1747 connection = _dbus_connection_new_for_transport (transport);
1749 _dbus_transport_unref (transport);
1751 if (connection == NULL)
1753 _DBUS_SET_OOM (error);
1757 #ifndef DBUS_DISABLE_CHECKS
1758 _dbus_assert (!connection->have_connection_lock);
1764 * If the shared parameter is true, then any existing connection will
1765 * be used (and if a new connection is created, it will be available
1766 * for use by others). If the shared parameter is false, a new
1767 * connection will always be created, and the new connection will
1768 * never be returned to other callers.
1770 * @param address the address
1771 * @param shared whether the connection is shared or private
1772 * @param error error return
1773 * @returns the connection or #NULL on error
1775 static DBusConnection*
1776 _dbus_connection_open_internal (const char *address,
1780 DBusConnection *connection;
1781 DBusAddressEntry **entries;
1782 DBusError tmp_error = DBUS_ERROR_INIT;
1783 DBusError first_error = DBUS_ERROR_INIT;
1786 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1788 _dbus_verbose ("opening %s connection to: %s\n",
1789 shared ? "shared" : "private", address);
1791 if (!dbus_parse_address (address, &entries, &len, error))
1794 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1798 for (i = 0; i < len; i++)
1802 if (!connection_lookup_shared (entries[i], &connection))
1803 _DBUS_SET_OOM (&tmp_error);
1806 if (connection == NULL)
1808 connection = connection_try_from_address_entry (entries[i],
1811 if (connection != NULL && shared)
1815 connection->shareable = TRUE;
1817 /* guid may be NULL */
1818 guid = dbus_address_entry_get_value (entries[i], "guid");
1820 CONNECTION_LOCK (connection);
1822 if (!connection_record_shared_unlocked (connection, guid))
1824 _DBUS_SET_OOM (&tmp_error);
1825 _dbus_connection_close_possibly_shared_and_unlock (connection);
1826 dbus_connection_unref (connection);
1830 CONNECTION_UNLOCK (connection);
1837 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1840 dbus_move_error (&tmp_error, &first_error);
1842 dbus_error_free (&tmp_error);
1845 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1846 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1848 if (connection == NULL)
1850 _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1851 dbus_move_error (&first_error, error);
1854 dbus_error_free (&first_error);
1856 dbus_address_entries_free (entries);
1861 * Closes a shared OR private connection, while dbus_connection_close() can
1862 * only be used on private connections. Should only be called by the
1863 * dbus code that owns the connection - an owner must be known,
1864 * the open/close state is like malloc/free, not like ref/unref.
1866 * @param connection the connection
1869 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1871 _dbus_assert (connection != NULL);
1872 _dbus_assert (connection->generation == _dbus_current_generation);
1874 CONNECTION_LOCK (connection);
1875 _dbus_connection_close_possibly_shared_and_unlock (connection);
1878 static DBusPreallocatedSend*
1879 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1881 DBusPreallocatedSend *preallocated;
1883 HAVE_LOCK_CHECK (connection);
1885 _dbus_assert (connection != NULL);
1887 preallocated = dbus_new (DBusPreallocatedSend, 1);
1888 if (preallocated == NULL)
1891 if (connection->link_cache != NULL)
1893 preallocated->queue_link =
1894 _dbus_list_pop_first_link (&connection->link_cache);
1895 preallocated->queue_link->data = NULL;
1899 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1900 if (preallocated->queue_link == NULL)
1904 if (connection->link_cache != NULL)
1906 preallocated->counter_link =
1907 _dbus_list_pop_first_link (&connection->link_cache);
1908 preallocated->counter_link->data = connection->outgoing_counter;
1912 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1913 if (preallocated->counter_link == NULL)
1917 _dbus_counter_ref (preallocated->counter_link->data);
1919 preallocated->connection = connection;
1921 return preallocated;
1924 _dbus_list_free_link (preallocated->queue_link);
1926 dbus_free (preallocated);
1931 /* Called with lock held, does not update dispatch status */
1933 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection *connection,
1934 DBusPreallocatedSend *preallocated,
1935 DBusMessage *message,
1936 dbus_uint32_t *client_serial)
1938 dbus_uint32_t serial;
1941 preallocated->queue_link->data = message;
1942 _dbus_list_prepend_link (&connection->outgoing_messages,
1943 preallocated->queue_link);
1945 _dbus_message_add_counter_link (message,
1946 preallocated->counter_link);
1948 dbus_free (preallocated);
1949 preallocated = NULL;
1951 dbus_message_ref (message);
1953 connection->n_outgoing += 1;
1955 sig = dbus_message_get_signature (message);
1957 _dbus_verbose ("Message %p (%s %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
1959 dbus_message_type_to_string (dbus_message_get_type (message)),
1960 dbus_message_get_path (message) ?
1961 dbus_message_get_path (message) :
1963 dbus_message_get_interface (message) ?
1964 dbus_message_get_interface (message) :
1966 dbus_message_get_member (message) ?
1967 dbus_message_get_member (message) :
1970 dbus_message_get_destination (message) ?
1971 dbus_message_get_destination (message) :
1974 connection->n_outgoing);
1976 if (dbus_message_get_serial (message) == 0)
1978 serial = _dbus_connection_get_next_client_serial (connection);
1979 dbus_message_set_serial (message, serial);
1981 *client_serial = serial;
1986 *client_serial = dbus_message_get_serial (message);
1989 _dbus_verbose ("Message %p serial is %u\n",
1990 message, dbus_message_get_serial (message));
1992 dbus_message_lock (message);
1994 /* Now we need to run an iteration to hopefully just write the messages
1995 * out immediately, and otherwise get them queued up
1997 _dbus_connection_do_iteration_unlocked (connection,
1998 DBUS_ITERATION_DO_WRITING,
2001 /* If stuff is still queued up, be sure we wake up the main loop */
2002 if (connection->n_outgoing > 0)
2003 _dbus_connection_wakeup_mainloop (connection);
2007 _dbus_connection_send_preallocated_and_unlock (DBusConnection *connection,
2008 DBusPreallocatedSend *preallocated,
2009 DBusMessage *message,
2010 dbus_uint32_t *client_serial)
2012 DBusDispatchStatus status;
2014 HAVE_LOCK_CHECK (connection);
2016 _dbus_connection_send_preallocated_unlocked_no_update (connection,
2018 message, client_serial);
2020 _dbus_verbose ("middle\n");
2021 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2023 /* this calls out to user code */
2024 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2028 * Like dbus_connection_send(), but assumes the connection
2029 * is already locked on function entry, and unlocks before returning.
2031 * @param connection the connection
2032 * @param message the message to send
2033 * @param client_serial return location for client serial of sent message
2034 * @returns #FALSE on out-of-memory
2037 _dbus_connection_send_and_unlock (DBusConnection *connection,
2038 DBusMessage *message,
2039 dbus_uint32_t *client_serial)
2041 DBusPreallocatedSend *preallocated;
2043 _dbus_assert (connection != NULL);
2044 _dbus_assert (message != NULL);
2046 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2047 if (preallocated == NULL)
2049 CONNECTION_UNLOCK (connection);
2053 _dbus_connection_send_preallocated_and_unlock (connection,
2061 * Used internally to handle the semantics of dbus_server_set_new_connection_function().
2062 * If the new connection function does not ref the connection, we want to close it.
2064 * A bit of a hack, probably the new connection function should have returned a value
2065 * for whether to close, or should have had to close the connection itself if it
2068 * But, this works OK as long as the new connection function doesn't do anything
2069 * crazy like keep the connection around without ref'ing it.
2071 * We have to lock the connection across refcount check and close in case
2072 * the new connection function spawns a thread that closes and unrefs.
2073 * In that case, if the app thread
2074 * closes and unrefs first, we'll harmlessly close again; if the app thread
2075 * still has the ref, we'll close and then the app will close harmlessly.
2076 * If the app unrefs without closing, the app is broken since if the
2077 * app refs from the new connection function it is supposed to also close.
2079 * If we didn't atomically check the refcount and close with the lock held
2080 * though, we could screw this up.
2082 * @param connection the connection
2085 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2087 CONNECTION_LOCK (connection);
2089 _dbus_assert (connection->refcount.value > 0);
2091 if (connection->refcount.value == 1)
2092 _dbus_connection_close_possibly_shared_and_unlock (connection);
2094 CONNECTION_UNLOCK (connection);
2099 * When a function that blocks has been called with a timeout, and we
2100 * run out of memory, the time to wait for memory is based on the
2101 * timeout. If the caller was willing to block a long time we wait a
2102 * relatively long time for memory, if they were only willing to block
2103 * briefly then we retry for memory at a rapid rate.
2105 * @timeout_milliseconds the timeout requested for blocking
2108 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2110 if (timeout_milliseconds == -1)
2111 _dbus_sleep_milliseconds (1000);
2112 else if (timeout_milliseconds < 100)
2113 ; /* just busy loop */
2114 else if (timeout_milliseconds <= 1000)
2115 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2117 _dbus_sleep_milliseconds (1000);
2120 static DBusMessage *
2121 generate_local_error_message (dbus_uint32_t serial,
2125 DBusMessage *message;
2126 message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2130 if (!dbus_message_set_error_name (message, error_name))
2132 dbus_message_unref (message);
2137 dbus_message_set_no_reply (message, TRUE);
2139 if (!dbus_message_set_reply_serial (message,
2142 dbus_message_unref (message);
2147 if (error_msg != NULL)
2149 DBusMessageIter iter;
2151 dbus_message_iter_init_append (message, &iter);
2152 if (!dbus_message_iter_append_basic (&iter,
2156 dbus_message_unref (message);
2167 /* This is slightly strange since we can pop a message here without
2168 * the dispatch lock.
2171 check_for_reply_unlocked (DBusConnection *connection,
2172 dbus_uint32_t client_serial)
2176 HAVE_LOCK_CHECK (connection);
2178 link = _dbus_list_get_first_link (&connection->incoming_messages);
2180 while (link != NULL)
2182 DBusMessage *reply = link->data;
2184 if (dbus_message_get_reply_serial (reply) == client_serial)
2186 _dbus_list_remove_link (&connection->incoming_messages, link);
2187 connection->n_incoming -= 1;
2190 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2197 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2199 /* We can't iterate over the hash in the normal way since we'll be
2200 * dropping the lock for each item. So we restart the
2201 * iter each time as we drain the hash table.
2204 while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2206 DBusPendingCall *pending;
2209 _dbus_hash_iter_init (connection->pending_replies, &iter);
2210 _dbus_hash_iter_next (&iter);
2212 pending = _dbus_hash_iter_get_value (&iter);
2213 _dbus_pending_call_ref_unlocked (pending);
2215 _dbus_pending_call_queue_timeout_error_unlocked (pending,
2218 if (_dbus_pending_call_is_timeout_added_unlocked (pending))
2219 _dbus_connection_remove_timeout_unlocked (connection,
2220 _dbus_pending_call_get_timeout_unlocked (pending));
2221 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2222 _dbus_hash_iter_remove_entry (&iter);
2224 _dbus_pending_call_unref_and_unlock (pending);
2225 CONNECTION_LOCK (connection);
2227 HAVE_LOCK_CHECK (connection);
2231 complete_pending_call_and_unlock (DBusConnection *connection,
2232 DBusPendingCall *pending,
2233 DBusMessage *message)
2235 _dbus_pending_call_set_reply_unlocked (pending, message);
2236 _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2237 _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2239 /* Must be called unlocked since it invokes app callback */
2240 _dbus_pending_call_complete (pending);
2241 dbus_pending_call_unref (pending);
2245 check_for_reply_and_update_dispatch_unlocked (DBusConnection *connection,
2246 DBusPendingCall *pending)
2249 DBusDispatchStatus status;
2251 reply = check_for_reply_unlocked (connection,
2252 _dbus_pending_call_get_reply_serial_unlocked (pending));
2255 _dbus_verbose ("checked for reply\n");
2257 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2259 complete_pending_call_and_unlock (connection, pending, reply);
2260 dbus_message_unref (reply);
2262 CONNECTION_LOCK (connection);
2263 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2264 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2265 dbus_pending_call_unref (pending);
2274 * Blocks until a pending call times out or gets a reply.
2276 * Does not re-enter the main loop or run filter/path-registered
2277 * callbacks. The reply to the message will not be seen by
2280 * Returns immediately if pending call already got a reply.
2282 * @todo could use performance improvements (it keeps scanning
2283 * the whole message queue for example)
2285 * @param pending the pending call we block for a reply on
2288 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2290 long start_tv_sec, start_tv_usec;
2291 long tv_sec, tv_usec;
2292 DBusDispatchStatus status;
2293 DBusConnection *connection;
2294 dbus_uint32_t client_serial;
2295 DBusTimeout *timeout;
2296 int timeout_milliseconds, elapsed_milliseconds;
2298 _dbus_assert (pending != NULL);
2300 if (dbus_pending_call_get_completed (pending))
2303 dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2305 connection = _dbus_pending_call_get_connection_and_lock (pending);
2307 /* Flush message queue - note, can affect dispatch status */
2308 _dbus_connection_flush_unlocked (connection);
2310 client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2312 /* note that timeout_milliseconds is limited to a smallish value
2313 * in _dbus_pending_call_new() so overflows aren't possible
2316 timeout = _dbus_pending_call_get_timeout_unlocked (pending);
2319 timeout_milliseconds = dbus_timeout_get_interval (timeout);
2320 _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
2322 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec\n",
2323 timeout_milliseconds,
2325 start_tv_sec, start_tv_usec);
2329 timeout_milliseconds = -1;
2331 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block for reply serial %u\n", client_serial);
2334 /* check to see if we already got the data off the socket */
2335 /* from another blocked pending call */
2336 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2339 /* Now we wait... */
2340 /* always block at least once as we know we don't have the reply yet */
2341 _dbus_connection_do_iteration_unlocked (connection,
2342 DBUS_ITERATION_DO_READING |
2343 DBUS_ITERATION_BLOCK,
2344 timeout_milliseconds);
2348 _dbus_verbose ("top of recheck\n");
2350 HAVE_LOCK_CHECK (connection);
2352 /* queue messages and get status */
2354 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2356 /* the get_completed() is in case a dispatch() while we were blocking
2357 * got the reply instead of us.
2359 if (_dbus_pending_call_get_completed_unlocked (pending))
2361 _dbus_verbose ("Pending call completed by dispatch\n");
2362 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2363 dbus_pending_call_unref (pending);
2367 if (status == DBUS_DISPATCH_DATA_REMAINS)
2369 if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2373 _dbus_get_current_time (&tv_sec, &tv_usec);
2374 elapsed_milliseconds = (tv_sec - start_tv_sec) * 1000 +
2375 (tv_usec - start_tv_usec) / 1000;
2377 if (!_dbus_connection_get_is_connected_unlocked (connection))
2379 DBusMessage *error_msg;
2381 error_msg = generate_local_error_message (client_serial,
2382 DBUS_ERROR_DISCONNECTED,
2383 "Connection was disconnected before a reply was received");
2385 /* on OOM error_msg is set to NULL */
2386 complete_pending_call_and_unlock (connection, pending, error_msg);
2387 dbus_pending_call_unref (pending);
2390 else if (connection->disconnect_message_link == NULL)
2391 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2392 else if (timeout == NULL)
2394 if (status == DBUS_DISPATCH_NEED_MEMORY)
2396 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2397 * we may already have a reply in the buffer and just can't process
2400 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2402 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2406 /* block again, we don't have the reply buffered yet. */
2407 _dbus_connection_do_iteration_unlocked (connection,
2408 DBUS_ITERATION_DO_READING |
2409 DBUS_ITERATION_BLOCK,
2410 timeout_milliseconds - elapsed_milliseconds);
2413 goto recheck_status;
2415 else if (tv_sec < start_tv_sec)
2416 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2417 else if (elapsed_milliseconds < timeout_milliseconds)
2419 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds - elapsed_milliseconds);
2421 if (status == DBUS_DISPATCH_NEED_MEMORY)
2423 /* Try sleeping a bit, as we aren't sure we need to block for reading,
2424 * we may already have a reply in the buffer and just can't process
2427 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2429 _dbus_memory_pause_based_on_timeout (timeout_milliseconds - elapsed_milliseconds);
2433 /* block again, we don't have the reply buffered yet. */
2434 _dbus_connection_do_iteration_unlocked (connection,
2435 DBUS_ITERATION_DO_READING |
2436 DBUS_ITERATION_BLOCK,
2437 timeout_milliseconds - elapsed_milliseconds);
2440 goto recheck_status;
2443 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %d milliseconds and got no reply\n",
2444 elapsed_milliseconds);
2446 _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2448 /* unlock and call user code */
2449 complete_pending_call_and_unlock (connection, pending, NULL);
2451 /* update user code on dispatch status */
2452 CONNECTION_LOCK (connection);
2453 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2454 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2455 dbus_pending_call_unref (pending);
2461 * @addtogroup DBusConnection
2467 * Gets a connection to a remote address. If a connection to the given
2468 * address already exists, returns the existing connection with its
2469 * reference count incremented. Otherwise, returns a new connection
2470 * and saves the new connection for possible re-use if a future call
2471 * to dbus_connection_open() asks to connect to the same server.
2473 * Use dbus_connection_open_private() to get a dedicated connection
2474 * not shared with other callers of dbus_connection_open().
2476 * If the open fails, the function returns #NULL, and provides a
2477 * reason for the failure in the error parameter. Pass #NULL for the
2478 * error parameter if you aren't interested in the reason for
2481 * Because this connection is shared, no user of the connection
2482 * may call dbus_connection_close(). However, when you are done with the
2483 * connection you should call dbus_connection_unref().
2485 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2486 * unless you have good reason; connections are expensive enough
2487 * that it's wasteful to create lots of connections to the same
2490 * @param address the address.
2491 * @param error address where an error can be returned.
2492 * @returns new connection, or #NULL on failure.
2495 dbus_connection_open (const char *address,
2498 DBusConnection *connection;
2500 _dbus_return_val_if_fail (address != NULL, NULL);
2501 _dbus_return_val_if_error_is_set (error, NULL);
2503 connection = _dbus_connection_open_internal (address,
2511 * Opens a new, dedicated connection to a remote address. Unlike
2512 * dbus_connection_open(), always creates a new connection.
2513 * This connection will not be saved or recycled by libdbus.
2515 * If the open fails, the function returns #NULL, and provides a
2516 * reason for the failure in the error parameter. Pass #NULL for the
2517 * error parameter if you aren't interested in the reason for
2520 * When you are done with this connection, you must
2521 * dbus_connection_close() to disconnect it,
2522 * and dbus_connection_unref() to free the connection object.
2524 * (The dbus_connection_close() can be skipped if the
2525 * connection is already known to be disconnected, for example
2526 * if you are inside a handler for the Disconnected signal.)
2528 * @note Prefer dbus_connection_open() to dbus_connection_open_private()
2529 * unless you have good reason; connections are expensive enough
2530 * that it's wasteful to create lots of connections to the same
2533 * @param address the address.
2534 * @param error address where an error can be returned.
2535 * @returns new connection, or #NULL on failure.
2538 dbus_connection_open_private (const char *address,
2541 DBusConnection *connection;
2543 _dbus_return_val_if_fail (address != NULL, NULL);
2544 _dbus_return_val_if_error_is_set (error, NULL);
2546 connection = _dbus_connection_open_internal (address,
2554 * Increments the reference count of a DBusConnection.
2556 * @param connection the connection.
2557 * @returns the connection.
2560 dbus_connection_ref (DBusConnection *connection)
2562 _dbus_return_val_if_fail (connection != NULL, NULL);
2563 _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2565 /* The connection lock is better than the global
2566 * lock in the atomic increment fallback
2569 #ifdef DBUS_HAVE_ATOMIC_INT
2570 _dbus_atomic_inc (&connection->refcount);
2572 CONNECTION_LOCK (connection);
2573 _dbus_assert (connection->refcount.value > 0);
2575 connection->refcount.value += 1;
2576 CONNECTION_UNLOCK (connection);
2583 free_outgoing_message (void *element,
2586 DBusMessage *message = element;
2587 DBusConnection *connection = data;
2589 _dbus_message_remove_counter (message,
2590 connection->outgoing_counter,
2592 dbus_message_unref (message);
2595 /* This is run without the mutex held, but after the last reference
2596 * to the connection has been dropped we should have no thread-related
2600 _dbus_connection_last_unref (DBusConnection *connection)
2604 _dbus_verbose ("Finalizing connection %p\n", connection);
2606 _dbus_assert (connection->refcount.value == 0);
2608 /* You have to disconnect the connection before unref:ing it. Otherwise
2609 * you won't get the disconnected message.
2611 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2612 _dbus_assert (connection->server_guid == NULL);
2614 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2615 _dbus_object_tree_free_all_unlocked (connection->objects);
2617 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2618 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2619 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2621 _dbus_watch_list_free (connection->watches);
2622 connection->watches = NULL;
2624 _dbus_timeout_list_free (connection->timeouts);
2625 connection->timeouts = NULL;
2627 _dbus_data_slot_list_free (&connection->slot_list);
2629 link = _dbus_list_get_first_link (&connection->filter_list);
2630 while (link != NULL)
2632 DBusMessageFilter *filter = link->data;
2633 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2635 filter->function = NULL;
2636 _dbus_message_filter_unref (filter); /* calls app callback */
2641 _dbus_list_clear (&connection->filter_list);
2643 /* ---- Done with stuff that invokes application callbacks */
2645 _dbus_object_tree_unref (connection->objects);
2647 _dbus_hash_table_unref (connection->pending_replies);
2648 connection->pending_replies = NULL;
2650 _dbus_list_clear (&connection->filter_list);
2652 _dbus_list_foreach (&connection->outgoing_messages,
2653 free_outgoing_message,
2655 _dbus_list_clear (&connection->outgoing_messages);
2657 _dbus_list_foreach (&connection->incoming_messages,
2658 (DBusForeachFunction) dbus_message_unref,
2660 _dbus_list_clear (&connection->incoming_messages);
2662 _dbus_counter_unref (connection->outgoing_counter);
2664 _dbus_transport_unref (connection->transport);
2666 if (connection->disconnect_message_link)
2668 DBusMessage *message = connection->disconnect_message_link->data;
2669 dbus_message_unref (message);
2670 _dbus_list_free_link (connection->disconnect_message_link);
2673 _dbus_list_clear (&connection->link_cache);
2675 _dbus_condvar_free_at_location (&connection->dispatch_cond);
2676 _dbus_condvar_free_at_location (&connection->io_path_cond);
2678 _dbus_mutex_free_at_location (&connection->io_path_mutex);
2679 _dbus_mutex_free_at_location (&connection->dispatch_mutex);
2681 _dbus_mutex_free_at_location (&connection->mutex);
2683 dbus_free (connection);
2687 * Decrements the reference count of a DBusConnection, and finalizes
2688 * it if the count reaches zero.
2690 * Note: it is a bug to drop the last reference to a connection that
2691 * is still connected.
2693 * For shared connections, libdbus will own a reference
2694 * as long as the connection is connected, so you can know that either
2695 * you don't have the last reference, or it's OK to drop the last reference.
2696 * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2697 * return shared connections.
2699 * For private connections, the creator of the connection must arrange for
2700 * dbus_connection_close() to be called prior to dropping the last reference.
2701 * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2703 * @param connection the connection.
2706 dbus_connection_unref (DBusConnection *connection)
2708 dbus_bool_t last_unref;
2710 _dbus_return_if_fail (connection != NULL);
2711 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2713 /* The connection lock is better than the global
2714 * lock in the atomic increment fallback
2717 #ifdef DBUS_HAVE_ATOMIC_INT
2718 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
2720 CONNECTION_LOCK (connection);
2722 _dbus_assert (connection->refcount.value > 0);
2724 connection->refcount.value -= 1;
2725 last_unref = (connection->refcount.value == 0);
2728 printf ("unref() connection %p count = %d\n", connection, connection->refcount.value);
2731 CONNECTION_UNLOCK (connection);
2736 #ifndef DBUS_DISABLE_CHECKS
2737 if (_dbus_transport_get_is_connected (connection->transport))
2739 _dbus_warn_check_failed ("The last reference on a connection was dropped without closing the connection. This is a bug in an application. See dbus_connection_unref() documentation for details.\n%s",
2740 connection->shareable ?
2741 "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2742 "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2746 _dbus_connection_last_unref (connection);
2751 * Note that the transport can disconnect itself (other end drops us)
2752 * and in that case this function never runs. So this function must
2753 * not do anything more than disconnect the transport and update the
2756 * If the transport self-disconnects, then we assume someone will
2757 * dispatch the connection to cause the dispatch status update.
2760 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2762 DBusDispatchStatus status;
2764 HAVE_LOCK_CHECK (connection);
2766 _dbus_verbose ("Disconnecting %p\n", connection);
2768 /* We need to ref because update_dispatch_status_and_unlock will unref
2769 * the connection if it was shared and libdbus was the only remaining
2772 _dbus_connection_ref_unlocked (connection);
2774 _dbus_transport_disconnect (connection->transport);
2776 /* This has the side effect of queuing the disconnect message link
2777 * (unless we don't have enough memory, possibly, so don't assert it).
2778 * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2779 * should never again return the newly-disconnected connection.
2781 * However, we only unref the shared connection and exit_on_disconnect when
2782 * the disconnect message reaches the head of the message queue,
2783 * NOT when it's first queued.
2785 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2787 /* This calls out to user code */
2788 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2790 /* Could also call out to user code */
2791 dbus_connection_unref (connection);
2795 * Closes a private connection, so no further data can be sent or received.
2796 * This disconnects the transport (such as a socket) underlying the
2799 * Attempts to send messages after closing a connection are safe, but will result in
2800 * error replies generated locally in libdbus.
2802 * This function does not affect the connection's reference count. It's
2803 * safe to close a connection more than once; all calls after the
2804 * first do nothing. It's impossible to "reopen" a connection, a
2805 * new connection must be created. This function may result in a call
2806 * to the DBusDispatchStatusFunction set with
2807 * dbus_connection_set_dispatch_status_function(), as the disconnect
2808 * message it generates needs to be dispatched.
2810 * If a connection is dropped by the remote application, it will
2813 * You must close a connection prior to releasing the last reference to
2814 * the connection. If you dbus_connection_unref() for the last time
2815 * without closing the connection, the results are undefined; it
2816 * is a bug in your program and libdbus will try to print a warning.
2818 * You may not close a shared connection. Connections created with
2819 * dbus_connection_open() or dbus_bus_get() are shared.
2820 * These connections are owned by libdbus, and applications should
2821 * only unref them, never close them. Applications can know it is
2822 * safe to unref these connections because libdbus will be holding a
2823 * reference as long as the connection is open. Thus, either the
2824 * connection is closed and it is OK to drop the last reference,
2825 * or the connection is open and the app knows it does not have the
2828 * Connections created with dbus_connection_open_private() or
2829 * dbus_bus_get_private() are not kept track of or referenced by
2830 * libdbus. The creator of these connections is responsible for
2831 * calling dbus_connection_close() prior to releasing the last
2832 * reference, if the connection is not already disconnected.
2834 * @param connection the private (unshared) connection to close
2837 dbus_connection_close (DBusConnection *connection)
2839 _dbus_return_if_fail (connection != NULL);
2840 _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2842 CONNECTION_LOCK (connection);
2844 #ifndef DBUS_DISABLE_CHECKS
2845 if (connection->shareable)
2847 CONNECTION_UNLOCK (connection);
2849 _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2854 _dbus_connection_close_possibly_shared_and_unlock (connection);
2858 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2860 HAVE_LOCK_CHECK (connection);
2861 return _dbus_transport_get_is_connected (connection->transport);
2865 * Gets whether the connection is currently open. A connection may
2866 * become disconnected when the remote application closes its end, or
2867 * exits; a connection may also be disconnected with
2868 * dbus_connection_close().
2870 * There are not separate states for "closed" and "disconnected," the two
2871 * terms are synonymous. This function should really be called
2872 * get_is_open() but for historical reasons is not.
2874 * @param connection the connection.
2875 * @returns #TRUE if the connection is still alive.
2878 dbus_connection_get_is_connected (DBusConnection *connection)
2882 _dbus_return_val_if_fail (connection != NULL, FALSE);
2884 CONNECTION_LOCK (connection);
2885 res = _dbus_connection_get_is_connected_unlocked (connection);
2886 CONNECTION_UNLOCK (connection);
2892 * Gets whether the connection was authenticated. (Note that
2893 * if the connection was authenticated then disconnected,
2894 * this function still returns #TRUE)
2896 * @param connection the connection
2897 * @returns #TRUE if the connection was ever authenticated
2900 dbus_connection_get_is_authenticated (DBusConnection *connection)
2904 _dbus_return_val_if_fail (connection != NULL, FALSE);
2906 CONNECTION_LOCK (connection);
2907 res = _dbus_transport_get_is_authenticated (connection->transport);
2908 CONNECTION_UNLOCK (connection);
2914 * Gets whether the connection is not authenticated as a specific
2915 * user. If the connection is not authenticated, this function
2916 * returns #TRUE, and if it is authenticated but as an anonymous user,
2917 * it returns #TRUE. If it is authenticated as a specific user, then
2918 * this returns #FALSE. (Note that if the connection was authenticated
2919 * as anonymous then disconnected, this function still returns #TRUE.)
2921 * If the connection is not anonymous, you can use
2922 * dbus_connection_get_unix_user() and
2923 * dbus_connection_get_windows_user() to see who it's authorized as.
2925 * If you want to prevent non-anonymous authorization, use
2926 * dbus_server_set_auth_mechanisms() to remove the mechanisms that
2927 * allow proving user identity (i.e. only allow the ANONYMOUS
2930 * @param connection the connection
2931 * @returns #TRUE if not authenticated or authenticated as anonymous
2934 dbus_connection_get_is_anonymous (DBusConnection *connection)
2938 _dbus_return_val_if_fail (connection != NULL, FALSE);
2940 CONNECTION_LOCK (connection);
2941 res = _dbus_transport_get_is_anonymous (connection->transport);
2942 CONNECTION_UNLOCK (connection);
2948 * Gets the ID of the server address we are authenticated to, if this
2949 * connection is on the client side. If the connection is on the
2950 * server side, this will always return #NULL - use dbus_server_get_id()
2951 * to get the ID of your own server, if you are the server side.
2953 * If a client-side connection is not authenticated yet, the ID may be
2954 * available if it was included in the server address, but may not be
2955 * available. The only way to be sure the server ID is available
2956 * is to wait for authentication to complete.
2958 * In general, each mode of connecting to a given server will have
2959 * its own ID. So for example, if the session bus daemon is listening
2960 * on UNIX domain sockets and on TCP, then each of those modalities
2961 * will have its own server ID.
2963 * If you want an ID that identifies an entire session bus, look at
2964 * dbus_bus_get_id() instead (which is just a convenience wrapper
2965 * around the org.freedesktop.DBus.GetId method invoked on the bus).
2967 * You can also get a machine ID; see dbus_get_local_machine_id() to
2968 * get the machine you are on. There isn't a convenience wrapper, but
2969 * you can invoke org.freedesktop.DBus.Peer.GetMachineId on any peer
2970 * to get the machine ID on the other end.
2972 * The D-Bus specification describes the server ID and other IDs in a
2975 * @param connection the connection
2976 * @returns the server ID or #NULL if no memory or the connection is server-side
2979 dbus_connection_get_server_id (DBusConnection *connection)
2983 _dbus_return_val_if_fail (connection != NULL, NULL);
2985 CONNECTION_LOCK (connection);
2986 id = _dbus_strdup (_dbus_transport_get_server_id (connection->transport));
2987 CONNECTION_UNLOCK (connection);
2993 * Tests whether a certain type can be send via the connection. This
2994 * will always return TRUE for all types, with the exception of
2995 * DBUS_TYPE_UNIX_FD. The function will return TRUE for
2996 * DBUS_TYPE_UNIX_FD only on systems that know Unix file descriptors
2997 * and can send them via the chosen transport and when the remote side
3000 * This function can be used to do runtime checking for types that
3001 * might be unknown to the specific D-Bus client implementation
3002 * version, i.e. it will return FALSE for all types this
3003 * implementation does not know.
3005 * @param connection the connection
3006 * @param type the type to check
3007 * @returns TRUE if the type may be send via the connection
3010 dbus_connection_can_send_type(DBusConnection *connection,
3013 _dbus_return_val_if_fail (connection != NULL, FALSE);
3015 if (!_dbus_type_is_valid(type))
3018 if (type != DBUS_TYPE_UNIX_FD)
3021 #ifdef HAVE_UNIX_FD_PASSING
3025 CONNECTION_LOCK(connection);
3026 b = _dbus_transport_can_pass_unix_fd(connection->transport);
3027 CONNECTION_UNLOCK(connection);
3037 * Set whether _exit() should be called when the connection receives a
3038 * disconnect signal. The call to _exit() comes after any handlers for
3039 * the disconnect signal run; handlers can cancel the exit by calling
3042 * By default, exit_on_disconnect is #FALSE; but for message bus
3043 * connections returned from dbus_bus_get() it will be toggled on
3046 * @param connection the connection
3047 * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
3050 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
3051 dbus_bool_t exit_on_disconnect)
3053 _dbus_return_if_fail (connection != NULL);
3055 CONNECTION_LOCK (connection);
3056 connection->exit_on_disconnect = exit_on_disconnect != FALSE;
3057 CONNECTION_UNLOCK (connection);
3061 * Preallocates resources needed to send a message, allowing the message
3062 * to be sent without the possibility of memory allocation failure.
3063 * Allows apps to create a future guarantee that they can send
3064 * a message regardless of memory shortages.
3066 * @param connection the connection we're preallocating for.
3067 * @returns the preallocated resources, or #NULL
3069 DBusPreallocatedSend*
3070 dbus_connection_preallocate_send (DBusConnection *connection)
3072 DBusPreallocatedSend *preallocated;
3074 _dbus_return_val_if_fail (connection != NULL, NULL);
3076 CONNECTION_LOCK (connection);
3079 _dbus_connection_preallocate_send_unlocked (connection);
3081 CONNECTION_UNLOCK (connection);
3083 return preallocated;
3087 * Frees preallocated message-sending resources from
3088 * dbus_connection_preallocate_send(). Should only
3089 * be called if the preallocated resources are not used
3090 * to send a message.
3092 * @param connection the connection
3093 * @param preallocated the resources
3096 dbus_connection_free_preallocated_send (DBusConnection *connection,
3097 DBusPreallocatedSend *preallocated)
3099 _dbus_return_if_fail (connection != NULL);
3100 _dbus_return_if_fail (preallocated != NULL);
3101 _dbus_return_if_fail (connection == preallocated->connection);
3103 _dbus_list_free_link (preallocated->queue_link);
3104 _dbus_counter_unref (preallocated->counter_link->data);
3105 _dbus_list_free_link (preallocated->counter_link);
3106 dbus_free (preallocated);
3110 * Sends a message using preallocated resources. This function cannot fail.
3111 * It works identically to dbus_connection_send() in other respects.
3112 * Preallocated resources comes from dbus_connection_preallocate_send().
3113 * This function "consumes" the preallocated resources, they need not
3114 * be freed separately.
3116 * @param connection the connection
3117 * @param preallocated the preallocated resources
3118 * @param message the message to send
3119 * @param client_serial return location for client serial assigned to the message
3122 dbus_connection_send_preallocated (DBusConnection *connection,
3123 DBusPreallocatedSend *preallocated,
3124 DBusMessage *message,
3125 dbus_uint32_t *client_serial)
3127 _dbus_return_if_fail (connection != NULL);
3128 _dbus_return_if_fail (preallocated != NULL);
3129 _dbus_return_if_fail (message != NULL);
3130 _dbus_return_if_fail (preallocated->connection == connection);
3131 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3132 dbus_message_get_member (message) != NULL);
3133 _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
3134 (dbus_message_get_interface (message) != NULL &&
3135 dbus_message_get_member (message) != NULL));
3137 CONNECTION_LOCK (connection);
3139 #ifdef HAVE_UNIX_FD_PASSING
3141 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3142 message->n_unix_fds > 0)
3144 /* Refuse to send fds on a connection that cannot handle
3145 them. Unfortunately we cannot return a proper error here, so
3146 the best we can is just return. */
3147 CONNECTION_UNLOCK (connection);
3153 _dbus_connection_send_preallocated_and_unlock (connection,
3155 message, client_serial);
3159 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
3160 DBusMessage *message,
3161 dbus_uint32_t *client_serial)
3163 DBusPreallocatedSend *preallocated;
3165 _dbus_assert (connection != NULL);
3166 _dbus_assert (message != NULL);
3168 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
3169 if (preallocated == NULL)
3172 _dbus_connection_send_preallocated_unlocked_no_update (connection,
3180 * Adds a message to the outgoing message queue. Does not block to
3181 * write the message to the network; that happens asynchronously. To
3182 * force the message to be written, call dbus_connection_flush() however
3183 * it is not necessary to call dbus_connection_flush() by hand; the
3184 * message will be sent the next time the main loop is run.
3185 * dbus_connection_flush() should only be used, for example, if
3186 * the application was expected to exit before running the main loop.
3188 * Because this only queues the message, the only reason it can
3189 * fail is lack of memory. Even if the connection is disconnected,
3190 * no error will be returned. If the function fails due to lack of memory,
3191 * it returns #FALSE. The function will never fail for other reasons; even
3192 * if the connection is disconnected, you can queue an outgoing message,
3193 * though obviously it won't be sent.
3195 * The message serial is used by the remote application to send a
3196 * reply; see dbus_message_get_serial() or the D-Bus specification.
3198 * dbus_message_unref() can be called as soon as this method returns
3199 * as the message queue will hold its own ref until the message is sent.
3201 * @param connection the connection.
3202 * @param message the message to write.
3203 * @param serial return location for message serial, or #NULL if you don't care
3204 * @returns #TRUE on success.
3207 dbus_connection_send (DBusConnection *connection,
3208 DBusMessage *message,
3209 dbus_uint32_t *serial)
3211 _dbus_return_val_if_fail (connection != NULL, FALSE);
3212 _dbus_return_val_if_fail (message != NULL, FALSE);
3214 CONNECTION_LOCK (connection);
3216 #ifdef HAVE_UNIX_FD_PASSING
3218 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3219 message->n_unix_fds > 0)
3221 /* Refuse to send fds on a connection that cannot handle
3222 them. Unfortunately we cannot return a proper error here, so
3223 the best we can is just return. */
3224 CONNECTION_UNLOCK (connection);
3230 return _dbus_connection_send_and_unlock (connection,
3236 reply_handler_timeout (void *data)
3238 DBusConnection *connection;
3239 DBusDispatchStatus status;
3240 DBusPendingCall *pending = data;
3242 connection = _dbus_pending_call_get_connection_and_lock (pending);
3244 _dbus_pending_call_queue_timeout_error_unlocked (pending,
3246 _dbus_connection_remove_timeout_unlocked (connection,
3247 _dbus_pending_call_get_timeout_unlocked (pending));
3248 _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
3250 _dbus_verbose ("middle\n");
3251 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3253 /* Unlocks, and calls out to user code */
3254 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3260 * Queues a message to send, as with dbus_connection_send(),
3261 * but also returns a #DBusPendingCall used to receive a reply to the
3262 * message. If no reply is received in the given timeout_milliseconds,
3263 * this function expires the pending reply and generates a synthetic
3264 * error reply (generated in-process, not by the remote application)
3265 * indicating that a timeout occurred.
3267 * A #DBusPendingCall will see a reply message before any filters or
3268 * registered object path handlers. See dbus_connection_dispatch() for
3269 * details on when handlers are run.
3271 * A #DBusPendingCall will always see exactly one reply message,
3272 * unless it's cancelled with dbus_pending_call_cancel().
3274 * If #NULL is passed for the pending_return, the #DBusPendingCall
3275 * will still be generated internally, and used to track
3276 * the message reply timeout. This means a timeout error will
3277 * occur if no reply arrives, unlike with dbus_connection_send().
3279 * If -1 is passed for the timeout, a sane default timeout is used. -1
3280 * is typically the best value for the timeout for this reason, unless
3281 * you want a very short or very long timeout. If INT_MAX is passed for
3282 * the timeout, no timeout will be set and the call will block forever.
3284 * @warning if the connection is disconnected or you try to send Unix
3285 * file descriptors on a connection that does not support them, the
3286 * #DBusPendingCall will be set to #NULL, so be careful with this.
3288 * @param connection the connection
3289 * @param message the message to send
3290 * @param pending_return return location for a #DBusPendingCall
3291 * object, or #NULL if connection is disconnected or when you try to
3292 * send Unix file descriptors on a connection that does not support
3294 * @param timeout_milliseconds timeout in milliseconds, -1 for default or INT_MAX for no timeout
3295 * @returns #FALSE if no memory, #TRUE otherwise.
3299 dbus_connection_send_with_reply (DBusConnection *connection,
3300 DBusMessage *message,
3301 DBusPendingCall **pending_return,
3302 int timeout_milliseconds)
3304 DBusPendingCall *pending;
3305 dbus_int32_t serial = -1;
3306 DBusDispatchStatus status;
3308 _dbus_return_val_if_fail (connection != NULL, FALSE);
3309 _dbus_return_val_if_fail (message != NULL, FALSE);
3310 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3313 *pending_return = NULL;
3315 CONNECTION_LOCK (connection);
3317 #ifdef HAVE_UNIX_FD_PASSING
3319 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3320 message->n_unix_fds > 0)
3322 /* Refuse to send fds on a connection that cannot handle
3323 them. Unfortunately we cannot return a proper error here, so
3324 the best we can do is return TRUE but leave *pending_return
3326 CONNECTION_UNLOCK (connection);
3332 if (!_dbus_connection_get_is_connected_unlocked (connection))
3334 CONNECTION_UNLOCK (connection);
3339 pending = _dbus_pending_call_new_unlocked (connection,
3340 timeout_milliseconds,
3341 reply_handler_timeout);
3343 if (pending == NULL)
3345 CONNECTION_UNLOCK (connection);
3349 /* Assign a serial to the message */
3350 serial = dbus_message_get_serial (message);
3353 serial = _dbus_connection_get_next_client_serial (connection);
3354 dbus_message_set_serial (message, serial);
3357 if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3360 /* Insert the serial in the pending replies hash;
3361 * hash takes a refcount on DBusPendingCall.
3362 * Also, add the timeout.
3364 if (!_dbus_connection_attach_pending_call_unlocked (connection,
3368 if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3370 _dbus_connection_detach_pending_call_and_unlock (connection,
3372 goto error_unlocked;
3376 *pending_return = pending; /* hand off refcount */
3379 _dbus_connection_detach_pending_call_unlocked (connection, pending);
3380 /* we still have a ref to the pending call in this case, we unref
3381 * after unlocking, below
3385 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3387 /* this calls out to user code */
3388 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3390 if (pending_return == NULL)
3391 dbus_pending_call_unref (pending);
3396 CONNECTION_UNLOCK (connection);
3398 dbus_pending_call_unref (pending);
3403 * Sends a message and blocks a certain time period while waiting for
3404 * a reply. This function does not reenter the main loop,
3405 * i.e. messages other than the reply are queued up but not
3406 * processed. This function is used to invoke method calls on a
3409 * If a normal reply is received, it is returned, and removed from the
3410 * incoming message queue. If it is not received, #NULL is returned
3411 * and the error is set to #DBUS_ERROR_NO_REPLY. If an error reply is
3412 * received, it is converted to a #DBusError and returned as an error,
3413 * then the reply message is deleted and #NULL is returned. If
3414 * something else goes wrong, result is set to whatever is
3415 * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3416 * #DBUS_ERROR_DISCONNECTED.
3418 * @warning While this function blocks the calling thread will not be
3419 * processing the incoming message queue. This means you can end up
3420 * deadlocked if the application you're talking to needs you to reply
3421 * to a method. To solve this, either avoid the situation, block in a
3422 * separate thread from the main connection-dispatching thread, or use
3423 * dbus_pending_call_set_notify() to avoid blocking.
3425 * @param connection the connection
3426 * @param message the message to send
3427 * @param timeout_milliseconds timeout in milliseconds, -1 for default or INT_MAX for no timeout.
3428 * @param error return location for error message
3429 * @returns the message that is the reply or #NULL with an error code if the
3433 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
3434 DBusMessage *message,
3435 int timeout_milliseconds,
3439 DBusPendingCall *pending;
3441 _dbus_return_val_if_fail (connection != NULL, NULL);
3442 _dbus_return_val_if_fail (message != NULL, NULL);
3443 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3444 _dbus_return_val_if_error_is_set (error, NULL);
3446 #ifdef HAVE_UNIX_FD_PASSING
3448 CONNECTION_LOCK (connection);
3449 if (!_dbus_transport_can_pass_unix_fd(connection->transport) &&
3450 message->n_unix_fds > 0)
3452 CONNECTION_UNLOCK (connection);
3453 dbus_set_error(error, DBUS_ERROR_FAILED, "Cannot send file descriptors on this connection.");
3456 CONNECTION_UNLOCK (connection);
3460 if (!dbus_connection_send_with_reply (connection, message,
3461 &pending, timeout_milliseconds))
3463 _DBUS_SET_OOM (error);
3467 if (pending == NULL)
3469 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3473 dbus_pending_call_block (pending);
3475 reply = dbus_pending_call_steal_reply (pending);
3476 dbus_pending_call_unref (pending);
3478 /* call_complete_and_unlock() called from pending_call_block() should
3479 * always fill this in.
3481 _dbus_assert (reply != NULL);
3483 if (dbus_set_error_from_message (error, reply))
3485 dbus_message_unref (reply);
3493 * Blocks until the outgoing message queue is empty.
3494 * Assumes connection lock already held.
3496 * If you call this, you MUST call update_dispatch_status afterword...
3498 * @param connection the connection.
3500 static DBusDispatchStatus
3501 _dbus_connection_flush_unlocked (DBusConnection *connection)
3503 /* We have to specify DBUS_ITERATION_DO_READING here because
3504 * otherwise we could have two apps deadlock if they are both doing
3505 * a flush(), and the kernel buffers fill up. This could change the
3508 DBusDispatchStatus status;
3510 HAVE_LOCK_CHECK (connection);
3512 while (connection->n_outgoing > 0 &&
3513 _dbus_connection_get_is_connected_unlocked (connection))
3515 _dbus_verbose ("doing iteration in\n");
3516 HAVE_LOCK_CHECK (connection);
3517 _dbus_connection_do_iteration_unlocked (connection,
3518 DBUS_ITERATION_DO_READING |
3519 DBUS_ITERATION_DO_WRITING |
3520 DBUS_ITERATION_BLOCK,
3524 HAVE_LOCK_CHECK (connection);
3525 _dbus_verbose ("middle\n");
3526 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3528 HAVE_LOCK_CHECK (connection);
3533 * Blocks until the outgoing message queue is empty.
3535 * @param connection the connection.
3538 dbus_connection_flush (DBusConnection *connection)
3540 /* We have to specify DBUS_ITERATION_DO_READING here because
3541 * otherwise we could have two apps deadlock if they are both doing
3542 * a flush(), and the kernel buffers fill up. This could change the
3545 DBusDispatchStatus status;
3547 _dbus_return_if_fail (connection != NULL);
3549 CONNECTION_LOCK (connection);
3551 status = _dbus_connection_flush_unlocked (connection);
3553 HAVE_LOCK_CHECK (connection);
3554 /* Unlocks and calls out to user code */
3555 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3557 _dbus_verbose ("end\n");
3561 * This function implements dbus_connection_read_write_dispatch() and
3562 * dbus_connection_read_write() (they pass a different value for the
3563 * dispatch parameter).
3565 * @param connection the connection
3566 * @param timeout_milliseconds max time to block or -1 for infinite
3567 * @param dispatch dispatch new messages or leave them on the incoming queue
3568 * @returns #TRUE if the disconnect message has not been processed
3571 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3572 int timeout_milliseconds,
3573 dbus_bool_t dispatch)
3575 DBusDispatchStatus dstatus;
3576 dbus_bool_t progress_possible;
3578 /* Need to grab a ref here in case we're a private connection and
3579 * the user drops the last ref in a handler we call; see bug
3580 * https://bugs.freedesktop.org/show_bug.cgi?id=15635
3582 dbus_connection_ref (connection);
3583 dstatus = dbus_connection_get_dispatch_status (connection);
3585 if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3587 _dbus_verbose ("doing dispatch\n");
3588 dbus_connection_dispatch (connection);
3589 CONNECTION_LOCK (connection);
3591 else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3593 _dbus_verbose ("pausing for memory\n");
3594 _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3595 CONNECTION_LOCK (connection);
3599 CONNECTION_LOCK (connection);
3600 if (_dbus_connection_get_is_connected_unlocked (connection))
3602 _dbus_verbose ("doing iteration\n");
3603 _dbus_connection_do_iteration_unlocked (connection,
3604 DBUS_ITERATION_DO_READING |
3605 DBUS_ITERATION_DO_WRITING |
3606 DBUS_ITERATION_BLOCK,
3607 timeout_milliseconds);
3611 HAVE_LOCK_CHECK (connection);
3612 /* If we can dispatch, we can make progress until the Disconnected message
3613 * has been processed; if we can only read/write, we can make progress
3614 * as long as the transport is open.
3617 progress_possible = connection->n_incoming != 0 ||
3618 connection->disconnect_message_link != NULL;
3620 progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3622 CONNECTION_UNLOCK (connection);
3624 dbus_connection_unref (connection);
3626 return progress_possible; /* TRUE if we can make more progress */
3631 * This function is intended for use with applications that don't want
3632 * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3633 * example usage would be:
3636 * while (dbus_connection_read_write_dispatch (connection, -1))
3637 * ; // empty loop body
3640 * In this usage you would normally have set up a filter function to look
3641 * at each message as it is dispatched. The loop terminates when the last
3642 * message from the connection (the disconnected signal) is processed.
3644 * If there are messages to dispatch, this function will
3645 * dbus_connection_dispatch() once, and return. If there are no
3646 * messages to dispatch, this function will block until it can read or
3647 * write, then read or write, then return.
3649 * The way to think of this function is that it either makes some sort
3650 * of progress, or it blocks. Note that, while it is blocked on I/O, it
3651 * cannot be interrupted (even by other threads), which makes this function
3652 * unsuitable for applications that do more than just react to received
3655 * The return value indicates whether the disconnect message has been
3656 * processed, NOT whether the connection is connected. This is
3657 * important because even after disconnecting, you want to process any
3658 * messages you received prior to the disconnect.
3660 * @param connection the connection
3661 * @param timeout_milliseconds max time to block or -1 for infinite
3662 * @returns #TRUE if the disconnect message has not been processed
3665 dbus_connection_read_write_dispatch (DBusConnection *connection,
3666 int timeout_milliseconds)
3668 _dbus_return_val_if_fail (connection != NULL, FALSE);
3669 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3670 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3674 * This function is intended for use with applications that don't want to
3675 * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3676 * dbus_connection_read_write_dispatch().
3678 * As long as the connection is open, this function will block until it can
3679 * read or write, then read or write, then return #TRUE.
3681 * If the connection is closed, the function returns #FALSE.
3683 * The return value indicates whether reading or writing is still
3684 * possible, i.e. whether the connection is connected.
3686 * Note that even after disconnection, messages may remain in the
3687 * incoming queue that need to be
3688 * processed. dbus_connection_read_write_dispatch() dispatches
3689 * incoming messages for you; with dbus_connection_read_write() you
3690 * have to arrange to drain the incoming queue yourself.
3692 * @param connection the connection
3693 * @param timeout_milliseconds max time to block or -1 for infinite
3694 * @returns #TRUE if still connected
3697 dbus_connection_read_write (DBusConnection *connection,
3698 int timeout_milliseconds)
3700 _dbus_return_val_if_fail (connection != NULL, FALSE);
3701 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3702 return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3705 /* We need to call this anytime we pop the head of the queue, and then
3706 * update_dispatch_status_and_unlock needs to be called afterward
3707 * which will "process" the disconnected message and set
3708 * disconnected_message_processed.
3711 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3712 DBusMessage *head_of_queue)
3714 HAVE_LOCK_CHECK (connection);
3716 /* checking that the link is NULL is an optimization to avoid the is_signal call */
3717 if (connection->disconnect_message_link == NULL &&
3718 dbus_message_is_signal (head_of_queue,
3719 DBUS_INTERFACE_LOCAL,
3722 connection->disconnected_message_arrived = TRUE;
3727 * Returns the first-received message from the incoming message queue,
3728 * leaving it in the queue. If the queue is empty, returns #NULL.
3730 * The caller does not own a reference to the returned message, and
3731 * must either return it using dbus_connection_return_message() or
3732 * keep it after calling dbus_connection_steal_borrowed_message(). No
3733 * one can get at the message while its borrowed, so return it as
3734 * quickly as possible and don't keep a reference to it after
3735 * returning it. If you need to keep the message, make a copy of it.
3737 * dbus_connection_dispatch() will block if called while a borrowed
3738 * message is outstanding; only one piece of code can be playing with
3739 * the incoming queue at a time. This function will block if called
3740 * during a dbus_connection_dispatch().
3742 * @param connection the connection.
3743 * @returns next message in the incoming queue.
3746 dbus_connection_borrow_message (DBusConnection *connection)
3748 DBusDispatchStatus status;
3749 DBusMessage *message;
3751 _dbus_return_val_if_fail (connection != NULL, NULL);
3753 _dbus_verbose ("start\n");
3755 /* this is called for the side effect that it queues
3756 * up any messages from the transport
3758 status = dbus_connection_get_dispatch_status (connection);
3759 if (status != DBUS_DISPATCH_DATA_REMAINS)
3762 CONNECTION_LOCK (connection);
3764 _dbus_connection_acquire_dispatch (connection);
3766 /* While a message is outstanding, the dispatch lock is held */
3767 _dbus_assert (connection->message_borrowed == NULL);
3769 connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3771 message = connection->message_borrowed;
3773 check_disconnected_message_arrived_unlocked (connection, message);
3775 /* Note that we KEEP the dispatch lock until the message is returned */
3776 if (message == NULL)
3777 _dbus_connection_release_dispatch (connection);
3779 CONNECTION_UNLOCK (connection);
3781 /* We don't update dispatch status until it's returned or stolen */
3787 * Used to return a message after peeking at it using
3788 * dbus_connection_borrow_message(). Only called if
3789 * message from dbus_connection_borrow_message() was non-#NULL.
3791 * @param connection the connection
3792 * @param message the message from dbus_connection_borrow_message()
3795 dbus_connection_return_message (DBusConnection *connection,
3796 DBusMessage *message)
3798 DBusDispatchStatus status;
3800 _dbus_return_if_fail (connection != NULL);
3801 _dbus_return_if_fail (message != NULL);
3802 _dbus_return_if_fail (message == connection->message_borrowed);
3803 _dbus_return_if_fail (connection->dispatch_acquired);
3805 CONNECTION_LOCK (connection);
3807 _dbus_assert (message == connection->message_borrowed);
3809 connection->message_borrowed = NULL;
3811 _dbus_connection_release_dispatch (connection);
3813 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3814 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3818 * Used to keep a message after peeking at it using
3819 * dbus_connection_borrow_message(). Before using this function, see
3820 * the caveats/warnings in the documentation for
3821 * dbus_connection_pop_message().
3823 * @param connection the connection
3824 * @param message the message from dbus_connection_borrow_message()
3827 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3828 DBusMessage *message)
3830 DBusMessage *pop_message;
3831 DBusDispatchStatus status;
3833 _dbus_return_if_fail (connection != NULL);
3834 _dbus_return_if_fail (message != NULL);
3835 _dbus_return_if_fail (message == connection->message_borrowed);
3836 _dbus_return_if_fail (connection->dispatch_acquired);
3838 CONNECTION_LOCK (connection);
3840 _dbus_assert (message == connection->message_borrowed);
3842 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3843 _dbus_assert (message == pop_message);
3845 connection->n_incoming -= 1;
3847 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3848 message, connection->n_incoming);
3850 connection->message_borrowed = NULL;
3852 _dbus_connection_release_dispatch (connection);
3854 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3855 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3858 /* See dbus_connection_pop_message, but requires the caller to own
3859 * the lock before calling. May drop the lock while running.
3862 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3864 HAVE_LOCK_CHECK (connection);
3866 _dbus_assert (connection->message_borrowed == NULL);
3868 if (connection->n_incoming > 0)
3872 link = _dbus_list_pop_first_link (&connection->incoming_messages);
3873 connection->n_incoming -= 1;
3875 _dbus_verbose ("Message %p (%s %s %s %s '%s') removed from incoming queue %p, %d incoming\n",
3877 dbus_message_type_to_string (dbus_message_get_type (link->data)),
3878 dbus_message_get_path (link->data) ?
3879 dbus_message_get_path (link->data) :
3881 dbus_message_get_interface (link->data) ?
3882 dbus_message_get_interface (link->data) :
3884 dbus_message_get_member (link->data) ?
3885 dbus_message_get_member (link->data) :
3887 dbus_message_get_signature (link->data),
3888 connection, connection->n_incoming);
3890 check_disconnected_message_arrived_unlocked (connection, link->data);
3898 /* See dbus_connection_pop_message, but requires the caller to own
3899 * the lock before calling. May drop the lock while running.
3902 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3906 HAVE_LOCK_CHECK (connection);
3908 link = _dbus_connection_pop_message_link_unlocked (connection);
3912 DBusMessage *message;
3914 message = link->data;
3916 _dbus_list_free_link (link);
3925 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
3926 DBusList *message_link)
3928 HAVE_LOCK_CHECK (connection);
3930 _dbus_assert (message_link != NULL);
3931 /* You can't borrow a message while a link is outstanding */
3932 _dbus_assert (connection->message_borrowed == NULL);
3933 /* We had to have the dispatch lock across the pop/putback */
3934 _dbus_assert (connection->dispatch_acquired);
3936 _dbus_list_prepend_link (&connection->incoming_messages,
3938 connection->n_incoming += 1;
3940 _dbus_verbose ("Message %p (%s %s %s '%s') put back into queue %p, %d incoming\n",
3942 dbus_message_type_to_string (dbus_message_get_type (message_link->data)),
3943 dbus_message_get_interface (message_link->data) ?
3944 dbus_message_get_interface (message_link->data) :
3946 dbus_message_get_member (message_link->data) ?
3947 dbus_message_get_member (message_link->data) :
3949 dbus_message_get_signature (message_link->data),
3950 connection, connection->n_incoming);
3954 * Returns the first-received message from the incoming message queue,
3955 * removing it from the queue. The caller owns a reference to the
3956 * returned message. If the queue is empty, returns #NULL.
3958 * This function bypasses any message handlers that are registered,
3959 * and so using it is usually wrong. Instead, let the main loop invoke
3960 * dbus_connection_dispatch(). Popping messages manually is only
3961 * useful in very simple programs that don't share a #DBusConnection
3962 * with any libraries or other modules.
3964 * There is a lock that covers all ways of accessing the incoming message
3965 * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
3966 * dbus_connection_borrow_message(), etc. will all block while one of the others
3967 * in the group is running.
3969 * @param connection the connection.
3970 * @returns next message in the incoming queue.
3973 dbus_connection_pop_message (DBusConnection *connection)
3975 DBusMessage *message;
3976 DBusDispatchStatus status;
3978 _dbus_verbose ("start\n");
3980 /* this is called for the side effect that it queues
3981 * up any messages from the transport
3983 status = dbus_connection_get_dispatch_status (connection);
3984 if (status != DBUS_DISPATCH_DATA_REMAINS)
3987 CONNECTION_LOCK (connection);
3988 _dbus_connection_acquire_dispatch (connection);
3989 HAVE_LOCK_CHECK (connection);
3991 message = _dbus_connection_pop_message_unlocked (connection);
3993 _dbus_verbose ("Returning popped message %p\n", message);
3995 _dbus_connection_release_dispatch (connection);
3997 status = _dbus_connection_get_dispatch_status_unlocked (connection);
3998 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4004 * Acquire the dispatcher. This is a separate lock so the main
4005 * connection lock can be dropped to call out to application dispatch
4008 * @param connection the connection.
4011 _dbus_connection_acquire_dispatch (DBusConnection *connection)
4013 HAVE_LOCK_CHECK (connection);
4015 _dbus_connection_ref_unlocked (connection);
4016 CONNECTION_UNLOCK (connection);
4018 _dbus_verbose ("locking dispatch_mutex\n");
4019 _dbus_mutex_lock (connection->dispatch_mutex);
4021 while (connection->dispatch_acquired)
4023 _dbus_verbose ("waiting for dispatch to be acquirable\n");
4024 _dbus_condvar_wait (connection->dispatch_cond,
4025 connection->dispatch_mutex);
4028 _dbus_assert (!connection->dispatch_acquired);
4030 connection->dispatch_acquired = TRUE;
4032 _dbus_verbose ("unlocking dispatch_mutex\n");
4033 _dbus_mutex_unlock (connection->dispatch_mutex);
4035 CONNECTION_LOCK (connection);
4036 _dbus_connection_unref_unlocked (connection);
4040 * Release the dispatcher when you're done with it. Only call
4041 * after you've acquired the dispatcher. Wakes up at most one
4042 * thread currently waiting to acquire the dispatcher.
4044 * @param connection the connection.
4047 _dbus_connection_release_dispatch (DBusConnection *connection)
4049 HAVE_LOCK_CHECK (connection);
4051 _dbus_verbose ("locking dispatch_mutex\n");
4052 _dbus_mutex_lock (connection->dispatch_mutex);
4054 _dbus_assert (connection->dispatch_acquired);
4056 connection->dispatch_acquired = FALSE;
4057 _dbus_condvar_wake_one (connection->dispatch_cond);
4059 _dbus_verbose ("unlocking dispatch_mutex\n");
4060 _dbus_mutex_unlock (connection->dispatch_mutex);
4064 _dbus_connection_failed_pop (DBusConnection *connection,
4065 DBusList *message_link)
4067 _dbus_list_prepend_link (&connection->incoming_messages,
4069 connection->n_incoming += 1;
4072 /* Note this may be called multiple times since we don't track whether we already did it */
4074 notify_disconnected_unlocked (DBusConnection *connection)
4076 HAVE_LOCK_CHECK (connection);
4078 /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
4079 * connection from dbus_bus_get(). We make the same guarantee for
4080 * dbus_connection_open() but in a different way since we don't want to
4081 * unref right here; we instead check for connectedness before returning
4082 * the connection from the hash.
4084 _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
4086 /* Dump the outgoing queue, we aren't going to be able to
4087 * send it now, and we'd like accessors like
4088 * dbus_connection_get_outgoing_size() to be accurate.
4090 if (connection->n_outgoing > 0)
4094 _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
4095 connection->n_outgoing);
4097 while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
4099 _dbus_connection_message_sent (connection, link->data);
4104 /* Note this may be called multiple times since we don't track whether we already did it */
4105 static DBusDispatchStatus
4106 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
4108 HAVE_LOCK_CHECK (connection);
4110 if (connection->disconnect_message_link != NULL)
4112 _dbus_verbose ("Sending disconnect message\n");
4114 /* If we have pending calls, queue their timeouts - we want the Disconnected
4115 * to be the last message, after these timeouts.
4117 connection_timeout_and_complete_all_pending_calls_unlocked (connection);
4119 /* We haven't sent the disconnect message already,
4120 * and all real messages have been queued up.
4122 _dbus_connection_queue_synthesized_message_link (connection,
4123 connection->disconnect_message_link);
4124 connection->disconnect_message_link = NULL;
4126 return DBUS_DISPATCH_DATA_REMAINS;
4129 return DBUS_DISPATCH_COMPLETE;
4132 static DBusDispatchStatus
4133 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
4135 HAVE_LOCK_CHECK (connection);
4137 if (connection->n_incoming > 0)
4138 return DBUS_DISPATCH_DATA_REMAINS;
4139 else if (!_dbus_transport_queue_messages (connection->transport))
4140 return DBUS_DISPATCH_NEED_MEMORY;
4143 DBusDispatchStatus status;
4144 dbus_bool_t is_connected;
4146 status = _dbus_transport_get_dispatch_status (connection->transport);
4147 is_connected = _dbus_transport_get_is_connected (connection->transport);
4149 _dbus_verbose ("dispatch status = %s is_connected = %d\n",
4150 DISPATCH_STATUS_NAME (status), is_connected);
4154 /* It's possible this would be better done by having an explicit
4155 * notification from _dbus_transport_disconnect() that would
4156 * synchronously do this, instead of waiting for the next dispatch
4157 * status check. However, probably not good to change until it causes
4160 notify_disconnected_unlocked (connection);
4162 /* I'm not sure this is needed; the idea is that we want to
4163 * queue the Disconnected only after we've read all the
4164 * messages, but if we're disconnected maybe we are guaranteed
4165 * to have read them all ?
4167 if (status == DBUS_DISPATCH_COMPLETE)
4168 status = notify_disconnected_and_dispatch_complete_unlocked (connection);
4171 if (status != DBUS_DISPATCH_COMPLETE)
4173 else if (connection->n_incoming > 0)
4174 return DBUS_DISPATCH_DATA_REMAINS;
4176 return DBUS_DISPATCH_COMPLETE;
4181 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
4182 DBusDispatchStatus new_status)
4184 dbus_bool_t changed;
4185 DBusDispatchStatusFunction function;
4188 HAVE_LOCK_CHECK (connection);
4190 _dbus_connection_ref_unlocked (connection);
4192 changed = new_status != connection->last_dispatch_status;
4194 connection->last_dispatch_status = new_status;
4196 function = connection->dispatch_status_function;
4197 data = connection->dispatch_status_data;
4199 if (connection->disconnected_message_arrived &&
4200 !connection->disconnected_message_processed)
4202 connection->disconnected_message_processed = TRUE;
4204 /* this does an unref, but we have a ref
4205 * so we should not run the finalizer here
4208 connection_forget_shared_unlocked (connection);
4210 if (connection->exit_on_disconnect)
4212 CONNECTION_UNLOCK (connection);
4214 _dbus_verbose ("Exiting on Disconnected signal\n");
4216 _dbus_assert_not_reached ("Call to exit() returned");
4220 /* We drop the lock */
4221 CONNECTION_UNLOCK (connection);
4223 if (changed && function)
4225 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
4226 connection, new_status,
4227 DISPATCH_STATUS_NAME (new_status));
4228 (* function) (connection, new_status, data);
4231 dbus_connection_unref (connection);
4235 * Gets the current state of the incoming message queue.
4236 * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
4237 * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
4238 * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
4239 * there could be data, but we can't know for sure without more
4242 * To process the incoming message queue, use dbus_connection_dispatch()
4243 * or (in rare cases) dbus_connection_pop_message().
4245 * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
4246 * have messages in the queue, or we have raw bytes buffered up
4247 * that need to be parsed. When these bytes are parsed, they
4248 * may not add up to an entire message. Thus, it's possible
4249 * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
4250 * have a message yet.
4252 * In particular this happens on initial connection, because all sorts
4253 * of authentication protocol stuff has to be parsed before the
4254 * first message arrives.
4256 * @param connection the connection.
4257 * @returns current dispatch status
4260 dbus_connection_get_dispatch_status (DBusConnection *connection)
4262 DBusDispatchStatus status;
4264 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4266 _dbus_verbose ("start\n");
4268 CONNECTION_LOCK (connection);
4270 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4272 CONNECTION_UNLOCK (connection);
4278 * Filter funtion for handling the Peer standard interface.
4280 static DBusHandlerResult
4281 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
4282 DBusMessage *message)
4284 if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
4286 /* This means we're letting the bus route this message */
4287 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4289 else if (dbus_message_is_method_call (message,
4290 DBUS_INTERFACE_PEER,
4296 ret = dbus_message_new_method_return (message);
4298 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4300 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4302 dbus_message_unref (ret);
4305 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4307 return DBUS_HANDLER_RESULT_HANDLED;
4309 else if (dbus_message_is_method_call (message,
4310 DBUS_INTERFACE_PEER,
4317 ret = dbus_message_new_method_return (message);
4319 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4322 _dbus_string_init (&uuid);
4323 if (_dbus_get_local_machine_uuid_encoded (&uuid))
4325 const char *v_STRING = _dbus_string_get_const_data (&uuid);
4326 if (dbus_message_append_args (ret,
4327 DBUS_TYPE_STRING, &v_STRING,
4330 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4333 _dbus_string_free (&uuid);
4335 dbus_message_unref (ret);
4338 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4340 return DBUS_HANDLER_RESULT_HANDLED;
4342 else if (dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4344 /* We need to bounce anything else with this interface, otherwise apps
4345 * could start extending the interface and when we added extensions
4346 * here to DBusConnection we'd break those apps.
4352 ret = dbus_message_new_error (message,
4353 DBUS_ERROR_UNKNOWN_METHOD,
4354 "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4356 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4358 sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4360 dbus_message_unref (ret);
4363 return DBUS_HANDLER_RESULT_NEED_MEMORY;
4365 return DBUS_HANDLER_RESULT_HANDLED;
4369 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4374 * Processes all builtin filter functions
4376 * If the spec specifies a standard interface
4377 * they should be processed from this method
4379 static DBusHandlerResult
4380 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4381 DBusMessage *message)
4383 /* We just run one filter for now but have the option to run more
4384 if the spec calls for it in the future */
4386 return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4390 * Processes any incoming data.
4392 * If there's incoming raw data that has not yet been parsed, it is
4393 * parsed, which may or may not result in adding messages to the
4396 * The incoming data buffer is filled when the connection reads from
4397 * its underlying transport (such as a socket). Reading usually
4398 * happens in dbus_watch_handle() or dbus_connection_read_write().
4400 * If there are complete messages in the incoming queue,
4401 * dbus_connection_dispatch() removes one message from the queue and
4402 * processes it. Processing has three steps.
4404 * First, any method replies are passed to #DBusPendingCall or
4405 * dbus_connection_send_with_reply_and_block() in order to
4406 * complete the pending method call.
4408 * Second, any filters registered with dbus_connection_add_filter()
4409 * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4410 * then processing stops after that filter.
4412 * Third, if the message is a method call it is forwarded to
4413 * any registered object path handlers added with
4414 * dbus_connection_register_object_path() or
4415 * dbus_connection_register_fallback().
4417 * A single call to dbus_connection_dispatch() will process at most
4418 * one message; it will not clear the entire message queue.
4420 * Be careful about calling dbus_connection_dispatch() from inside a
4421 * message handler, i.e. calling dbus_connection_dispatch()
4422 * recursively. If threads have been initialized with a recursive
4423 * mutex function, then this will not deadlock; however, it can
4424 * certainly confuse your application.
4426 * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4428 * @param connection the connection
4429 * @returns dispatch status, see dbus_connection_get_dispatch_status()
4432 dbus_connection_dispatch (DBusConnection *connection)
4434 DBusMessage *message;
4435 DBusList *link, *filter_list_copy, *message_link;
4436 DBusHandlerResult result;
4437 DBusPendingCall *pending;
4438 dbus_int32_t reply_serial;
4439 DBusDispatchStatus status;
4441 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4443 _dbus_verbose ("\n");
4445 CONNECTION_LOCK (connection);
4446 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4447 if (status != DBUS_DISPATCH_DATA_REMAINS)
4449 /* unlocks and calls out to user code */
4450 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4454 /* We need to ref the connection since the callback could potentially
4455 * drop the last ref to it
4457 _dbus_connection_ref_unlocked (connection);
4459 _dbus_connection_acquire_dispatch (connection);
4460 HAVE_LOCK_CHECK (connection);
4462 message_link = _dbus_connection_pop_message_link_unlocked (connection);
4463 if (message_link == NULL)
4465 /* another thread dispatched our stuff */
4467 _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4469 _dbus_connection_release_dispatch (connection);
4471 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4473 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4475 dbus_connection_unref (connection);
4480 message = message_link->data;
4482 _dbus_verbose (" dispatching message %p (%s %s %s '%s')\n",
4484 dbus_message_type_to_string (dbus_message_get_type (message)),
4485 dbus_message_get_interface (message) ?
4486 dbus_message_get_interface (message) :
4488 dbus_message_get_member (message) ?
4489 dbus_message_get_member (message) :
4491 dbus_message_get_signature (message));
4493 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4495 /* Pending call handling must be first, because if you do
4496 * dbus_connection_send_with_reply_and_block() or
4497 * dbus_pending_call_block() then no handlers/filters will be run on
4498 * the reply. We want consistent semantics in the case where we
4499 * dbus_connection_dispatch() the reply.
4502 reply_serial = dbus_message_get_reply_serial (message);
4503 pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4507 _dbus_verbose ("Dispatching a pending reply\n");
4508 complete_pending_call_and_unlock (connection, pending, message);
4509 pending = NULL; /* it's probably unref'd */
4511 CONNECTION_LOCK (connection);
4512 _dbus_verbose ("pending call completed in dispatch\n");
4513 result = DBUS_HANDLER_RESULT_HANDLED;
4517 result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4518 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4521 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4523 _dbus_connection_release_dispatch (connection);
4524 HAVE_LOCK_CHECK (connection);
4526 _dbus_connection_failed_pop (connection, message_link);
4528 /* unlocks and calls user code */
4529 _dbus_connection_update_dispatch_status_and_unlock (connection,
4530 DBUS_DISPATCH_NEED_MEMORY);
4533 dbus_pending_call_unref (pending);
4534 dbus_connection_unref (connection);
4536 return DBUS_DISPATCH_NEED_MEMORY;
4539 _dbus_list_foreach (&filter_list_copy,
4540 (DBusForeachFunction)_dbus_message_filter_ref,
4543 /* We're still protected from dispatch() reentrancy here
4544 * since we acquired the dispatcher
4546 CONNECTION_UNLOCK (connection);
4548 link = _dbus_list_get_first_link (&filter_list_copy);
4549 while (link != NULL)
4551 DBusMessageFilter *filter = link->data;
4552 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4554 if (filter->function == NULL)
4556 _dbus_verbose (" filter was removed in a callback function\n");
4561 _dbus_verbose (" running filter on message %p\n", message);
4562 result = (* filter->function) (connection, message, filter->user_data);
4564 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4570 _dbus_list_foreach (&filter_list_copy,
4571 (DBusForeachFunction)_dbus_message_filter_unref,
4573 _dbus_list_clear (&filter_list_copy);
4575 CONNECTION_LOCK (connection);
4577 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4579 _dbus_verbose ("No memory\n");
4582 else if (result == DBUS_HANDLER_RESULT_HANDLED)
4584 _dbus_verbose ("filter handled message in dispatch\n");
4588 /* We're still protected from dispatch() reentrancy here
4589 * since we acquired the dispatcher
4591 _dbus_verbose (" running object path dispatch on message %p (%s %s %s '%s')\n",
4593 dbus_message_type_to_string (dbus_message_get_type (message)),
4594 dbus_message_get_interface (message) ?
4595 dbus_message_get_interface (message) :
4597 dbus_message_get_member (message) ?
4598 dbus_message_get_member (message) :
4600 dbus_message_get_signature (message));
4602 HAVE_LOCK_CHECK (connection);
4603 result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4606 CONNECTION_LOCK (connection);
4608 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4610 _dbus_verbose ("object tree handled message in dispatch\n");
4614 if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4618 DBusPreallocatedSend *preallocated;
4620 _dbus_verbose (" sending error %s\n",
4621 DBUS_ERROR_UNKNOWN_METHOD);
4623 if (!_dbus_string_init (&str))
4625 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4626 _dbus_verbose ("no memory for error string in dispatch\n");
4630 if (!_dbus_string_append_printf (&str,
4631 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4632 dbus_message_get_member (message),
4633 dbus_message_get_signature (message),
4634 dbus_message_get_interface (message)))
4636 _dbus_string_free (&str);
4637 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4638 _dbus_verbose ("no memory for error string in dispatch\n");
4642 reply = dbus_message_new_error (message,
4643 DBUS_ERROR_UNKNOWN_METHOD,
4644 _dbus_string_get_const_data (&str));
4645 _dbus_string_free (&str);
4649 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4650 _dbus_verbose ("no memory for error reply in dispatch\n");
4654 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4656 if (preallocated == NULL)
4658 dbus_message_unref (reply);
4659 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4660 _dbus_verbose ("no memory for error send in dispatch\n");
4664 _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4667 dbus_message_unref (reply);
4669 result = DBUS_HANDLER_RESULT_HANDLED;
4672 _dbus_verbose (" done dispatching %p (%s %s %s '%s') on connection %p\n", message,
4673 dbus_message_type_to_string (dbus_message_get_type (message)),
4674 dbus_message_get_interface (message) ?
4675 dbus_message_get_interface (message) :
4677 dbus_message_get_member (message) ?
4678 dbus_message_get_member (message) :
4680 dbus_message_get_signature (message),
4684 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4686 _dbus_verbose ("out of memory\n");
4688 /* Put message back, and we'll start over.
4689 * Yes this means handlers must be idempotent if they
4690 * don't return HANDLED; c'est la vie.
4692 _dbus_connection_putback_message_link_unlocked (connection,
4697 _dbus_verbose (" ... done dispatching\n");
4699 _dbus_list_free_link (message_link);
4700 dbus_message_unref (message); /* don't want the message to count in max message limits
4701 * in computing dispatch status below
4705 _dbus_connection_release_dispatch (connection);
4706 HAVE_LOCK_CHECK (connection);
4708 _dbus_verbose ("before final status update\n");
4709 status = _dbus_connection_get_dispatch_status_unlocked (connection);
4711 /* unlocks and calls user code */
4712 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4714 dbus_connection_unref (connection);
4720 * Sets the watch functions for the connection. These functions are
4721 * responsible for making the application's main loop aware of file
4722 * descriptors that need to be monitored for events, using select() or
4723 * poll(). When using Qt, typically the DBusAddWatchFunction would
4724 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4725 * could call g_io_add_watch(), or could be used as part of a more
4726 * elaborate GSource. Note that when a watch is added, it may
4729 * The DBusWatchToggledFunction notifies the application that the
4730 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4731 * to check this. A disabled watch should have no effect, and enabled
4732 * watch should be added to the main loop. This feature is used
4733 * instead of simply adding/removing the watch because
4734 * enabling/disabling can be done without memory allocation. The
4735 * toggled function may be NULL if a main loop re-queries
4736 * dbus_watch_get_enabled() every time anyway.
4738 * The DBusWatch can be queried for the file descriptor to watch using
4739 * dbus_watch_get_unix_fd() or dbus_watch_get_socket(), and for the
4740 * events to watch for using dbus_watch_get_flags(). The flags
4741 * returned by dbus_watch_get_flags() will only contain
4742 * DBUS_WATCH_READABLE and DBUS_WATCH_WRITABLE, never
4743 * DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR; all watches implicitly
4744 * include a watch for hangups, errors, and other exceptional
4747 * Once a file descriptor becomes readable or writable, or an exception
4748 * occurs, dbus_watch_handle() should be called to
4749 * notify the connection of the file descriptor's condition.
4751 * dbus_watch_handle() cannot be called during the
4752 * DBusAddWatchFunction, as the connection will not be ready to handle
4755 * It is not allowed to reference a DBusWatch after it has been passed
4756 * to remove_function.
4758 * If #FALSE is returned due to lack of memory, the failure may be due
4759 * to a #FALSE return from the new add_function. If so, the
4760 * add_function may have been called successfully one or more times,
4761 * but the remove_function will also have been called to remove any
4762 * successful adds. i.e. if #FALSE is returned the net result
4763 * should be that dbus_connection_set_watch_functions() has no effect,
4764 * but the add_function and remove_function may have been called.
4766 * @todo We need to drop the lock when we call the
4767 * add/remove/toggled functions which can be a side effect
4768 * of setting the watch functions.
4770 * @param connection the connection.
4771 * @param add_function function to begin monitoring a new descriptor.
4772 * @param remove_function function to stop monitoring a descriptor.
4773 * @param toggled_function function to notify of enable/disable
4774 * @param data data to pass to add_function and remove_function.
4775 * @param free_data_function function to be called to free the data.
4776 * @returns #FALSE on failure (no memory)
4779 dbus_connection_set_watch_functions (DBusConnection *connection,
4780 DBusAddWatchFunction add_function,
4781 DBusRemoveWatchFunction remove_function,
4782 DBusWatchToggledFunction toggled_function,
4784 DBusFreeFunction free_data_function)
4787 DBusWatchList *watches;
4789 _dbus_return_val_if_fail (connection != NULL, FALSE);
4791 CONNECTION_LOCK (connection);
4793 #ifndef DBUS_DISABLE_CHECKS
4794 if (connection->watches == NULL)
4796 _dbus_warn_check_failed ("Re-entrant call is not allowed\n");
4801 /* ref connection for slightly better reentrancy */
4802 _dbus_connection_ref_unlocked (connection);
4804 /* This can call back into user code, and we need to drop the
4805 * connection lock when it does. This is kind of a lame
4808 watches = connection->watches;
4809 connection->watches = NULL;
4810 CONNECTION_UNLOCK (connection);
4812 retval = _dbus_watch_list_set_functions (watches,
4813 add_function, remove_function,
4815 data, free_data_function);
4816 CONNECTION_LOCK (connection);
4817 connection->watches = watches;
4819 CONNECTION_UNLOCK (connection);
4820 /* drop our paranoid refcount */
4821 dbus_connection_unref (connection);
4827 * Sets the timeout functions for the connection. These functions are
4828 * responsible for making the application's main loop aware of timeouts.
4829 * When using Qt, typically the DBusAddTimeoutFunction would create a
4830 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4833 * The DBusTimeoutToggledFunction notifies the application that the
4834 * timeout has been enabled or disabled. Call
4835 * dbus_timeout_get_enabled() to check this. A disabled timeout should
4836 * have no effect, and enabled timeout should be added to the main
4837 * loop. This feature is used instead of simply adding/removing the
4838 * timeout because enabling/disabling can be done without memory
4839 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4840 * to enable and disable. The toggled function may be NULL if a main
4841 * loop re-queries dbus_timeout_get_enabled() every time anyway.
4842 * Whenever a timeout is toggled, its interval may change.
4844 * The DBusTimeout can be queried for the timer interval using
4845 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4846 * repeatedly, each time the interval elapses, starting after it has
4847 * elapsed once. The timeout stops firing when it is removed with the
4848 * given remove_function. The timer interval may change whenever the
4849 * timeout is added, removed, or toggled.
4851 * @param connection the connection.
4852 * @param add_function function to add a timeout.
4853 * @param remove_function function to remove a timeout.
4854 * @param toggled_function function to notify of enable/disable
4855 * @param data data to pass to add_function and remove_function.
4856 * @param free_data_function function to be called to free the data.
4857 * @returns #FALSE on failure (no memory)
4860 dbus_connection_set_timeout_functions (DBusConnection *connection,
4861 DBusAddTimeoutFunction add_function,
4862 DBusRemoveTimeoutFunction remove_function,
4863 DBusTimeoutToggledFunction toggled_function,
4865 DBusFreeFunction free_data_function)
4868 DBusTimeoutList *timeouts;
4870 _dbus_return_val_if_fail (connection != NULL, FALSE);
4872 CONNECTION_LOCK (connection);
4874 #ifndef DBUS_DISABLE_CHECKS
4875 if (connection->timeouts == NULL)
4877 _dbus_warn_check_failed ("Re-entrant call is not allowed\n");
4882 /* ref connection for slightly better reentrancy */
4883 _dbus_connection_ref_unlocked (connection);
4885 timeouts = connection->timeouts;
4886 connection->timeouts = NULL;
4887 CONNECTION_UNLOCK (connection);
4889 retval = _dbus_timeout_list_set_functions (timeouts,
4890 add_function, remove_function,
4892 data, free_data_function);
4893 CONNECTION_LOCK (connection);
4894 connection->timeouts = timeouts;
4896 CONNECTION_UNLOCK (connection);
4897 /* drop our paranoid refcount */
4898 dbus_connection_unref (connection);
4904 * Sets the mainloop wakeup function for the connection. This function
4905 * is responsible for waking up the main loop (if its sleeping in
4906 * another thread) when some some change has happened to the
4907 * connection that the mainloop needs to reconsider (e.g. a message
4908 * has been queued for writing). When using Qt, this typically
4909 * results in a call to QEventLoop::wakeUp(). When using GLib, it
4910 * would call g_main_context_wakeup().
4912 * @param connection the connection.
4913 * @param wakeup_main_function function to wake up the mainloop
4914 * @param data data to pass wakeup_main_function
4915 * @param free_data_function function to be called to free the data.
4918 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
4919 DBusWakeupMainFunction wakeup_main_function,
4921 DBusFreeFunction free_data_function)
4924 DBusFreeFunction old_free_data;
4926 _dbus_return_if_fail (connection != NULL);
4928 CONNECTION_LOCK (connection);
4929 old_data = connection->wakeup_main_data;
4930 old_free_data = connection->free_wakeup_main_data;
4932 connection->wakeup_main_function = wakeup_main_function;
4933 connection->wakeup_main_data = data;
4934 connection->free_wakeup_main_data = free_data_function;
4936 CONNECTION_UNLOCK (connection);
4938 /* Callback outside the lock */
4940 (*old_free_data) (old_data);
4944 * Set a function to be invoked when the dispatch status changes.
4945 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
4946 * dbus_connection_dispatch() needs to be called to process incoming
4947 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
4948 * from inside the DBusDispatchStatusFunction. Indeed, almost
4949 * any reentrancy in this function is a bad idea. Instead,
4950 * the DBusDispatchStatusFunction should simply save an indication
4951 * that messages should be dispatched later, when the main loop
4954 * If you don't set a dispatch status function, you have to be sure to
4955 * dispatch on every iteration of your main loop, especially if
4956 * dbus_watch_handle() or dbus_timeout_handle() were called.
4958 * @param connection the connection
4959 * @param function function to call on dispatch status changes
4960 * @param data data for function
4961 * @param free_data_function free the function data
4964 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
4965 DBusDispatchStatusFunction function,
4967 DBusFreeFunction free_data_function)
4970 DBusFreeFunction old_free_data;
4972 _dbus_return_if_fail (connection != NULL);
4974 CONNECTION_LOCK (connection);
4975 old_data = connection->dispatch_status_data;
4976 old_free_data = connection->free_dispatch_status_data;
4978 connection->dispatch_status_function = function;
4979 connection->dispatch_status_data = data;
4980 connection->free_dispatch_status_data = free_data_function;
4982 CONNECTION_UNLOCK (connection);
4984 /* Callback outside the lock */
4986 (*old_free_data) (old_data);
4990 * Get the UNIX file descriptor of the connection, if any. This can
4991 * be used for SELinux access control checks with getpeercon() for
4992 * example. DO NOT read or write to the file descriptor, or try to
4993 * select() on it; use DBusWatch for main loop integration. Not all
4994 * connections will have a file descriptor. So for adding descriptors
4995 * to the main loop, use dbus_watch_get_unix_fd() and so forth.
4997 * If the connection is socket-based, you can also use
4998 * dbus_connection_get_socket(), which will work on Windows too.
4999 * This function always fails on Windows.
5001 * Right now the returned descriptor is always a socket, but
5002 * that is not guaranteed.
5004 * @param connection the connection
5005 * @param fd return location for the file descriptor.
5006 * @returns #TRUE if fd is successfully obtained.
5009 dbus_connection_get_unix_fd (DBusConnection *connection,
5012 _dbus_return_val_if_fail (connection != NULL, FALSE);
5013 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5016 /* FIXME do this on a lower level */
5020 return dbus_connection_get_socket(connection, fd);
5024 * Gets the underlying Windows or UNIX socket file descriptor
5025 * of the connection, if any. DO NOT read or write to the file descriptor, or try to
5026 * select() on it; use DBusWatch for main loop integration. Not all
5027 * connections will have a socket. So for adding descriptors
5028 * to the main loop, use dbus_watch_get_socket() and so forth.
5030 * If the connection is not socket-based, this function will return FALSE,
5031 * even if the connection does have a file descriptor of some kind.
5032 * i.e. this function always returns specifically a socket file descriptor.
5034 * @param connection the connection
5035 * @param fd return location for the file descriptor.
5036 * @returns #TRUE if fd is successfully obtained.
5039 dbus_connection_get_socket(DBusConnection *connection,
5044 _dbus_return_val_if_fail (connection != NULL, FALSE);
5045 _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
5047 CONNECTION_LOCK (connection);
5049 retval = _dbus_transport_get_socket_fd (connection->transport,
5052 CONNECTION_UNLOCK (connection);
5059 * Gets the UNIX user ID of the connection if known. Returns #TRUE if
5060 * the uid is filled in. Always returns #FALSE on non-UNIX platforms
5061 * for now, though in theory someone could hook Windows to NIS or
5062 * something. Always returns #FALSE prior to authenticating the
5065 * The UID is only read by servers from clients; clients can't usually
5066 * get the UID of servers, because servers do not authenticate to
5067 * clients. The returned UID is the UID the connection authenticated
5070 * The message bus is a server and the apps connecting to the bus
5073 * You can ask the bus to tell you the UID of another connection though
5074 * if you like; this is done with dbus_bus_get_unix_user().
5076 * @param connection the connection
5077 * @param uid return location for the user ID
5078 * @returns #TRUE if uid is filled in with a valid user ID
5081 dbus_connection_get_unix_user (DBusConnection *connection,
5086 _dbus_return_val_if_fail (connection != NULL, FALSE);
5087 _dbus_return_val_if_fail (uid != NULL, FALSE);
5089 CONNECTION_LOCK (connection);
5091 if (!_dbus_transport_get_is_authenticated (connection->transport))
5094 result = _dbus_transport_get_unix_user (connection->transport,
5098 _dbus_assert (!result);
5101 CONNECTION_UNLOCK (connection);
5107 * Gets the process ID of the connection if any.
5108 * Returns #TRUE if the pid is filled in.
5109 * Always returns #FALSE prior to authenticating the
5112 * @param connection the connection
5113 * @param pid return location for the process ID
5114 * @returns #TRUE if uid is filled in with a valid process ID
5117 dbus_connection_get_unix_process_id (DBusConnection *connection,
5122 _dbus_return_val_if_fail (connection != NULL, FALSE);
5123 _dbus_return_val_if_fail (pid != NULL, FALSE);
5125 CONNECTION_LOCK (connection);
5127 if (!_dbus_transport_get_is_authenticated (connection->transport))
5130 result = _dbus_transport_get_unix_process_id (connection->transport,
5133 CONNECTION_UNLOCK (connection);
5139 * Gets the ADT audit data of the connection if any.
5140 * Returns #TRUE if the structure pointer is returned.
5141 * Always returns #FALSE prior to authenticating the
5144 * @param connection the connection
5145 * @param data return location for audit data
5146 * @returns #TRUE if audit data is filled in with a valid ucred pointer
5149 dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
5151 dbus_int32_t *data_size)
5155 _dbus_return_val_if_fail (connection != NULL, FALSE);
5156 _dbus_return_val_if_fail (data != NULL, FALSE);
5157 _dbus_return_val_if_fail (data_size != NULL, FALSE);
5159 CONNECTION_LOCK (connection);
5161 if (!_dbus_transport_get_is_authenticated (connection->transport))
5164 result = _dbus_transport_get_adt_audit_session_data (connection->transport,
5167 CONNECTION_UNLOCK (connection);
5173 * Sets a predicate function used to determine whether a given user ID
5174 * is allowed to connect. When an incoming connection has
5175 * authenticated with a particular user ID, this function is called;
5176 * if it returns #TRUE, the connection is allowed to proceed,
5177 * otherwise the connection is disconnected.
5179 * If the function is set to #NULL (as it is by default), then
5180 * only the same UID as the server process will be allowed to
5181 * connect. Also, root is always allowed to connect.
5183 * On Windows, the function will be set and its free_data_function will
5184 * be invoked when the connection is freed or a new function is set.
5185 * However, the function will never be called, because there are
5186 * no UNIX user ids to pass to it, or at least none of the existing
5187 * auth protocols would allow authenticating as a UNIX user on Windows.
5189 * @param connection the connection
5190 * @param function the predicate
5191 * @param data data to pass to the predicate
5192 * @param free_data_function function to free the data
5195 dbus_connection_set_unix_user_function (DBusConnection *connection,
5196 DBusAllowUnixUserFunction function,
5198 DBusFreeFunction free_data_function)
5200 void *old_data = NULL;
5201 DBusFreeFunction old_free_function = NULL;
5203 _dbus_return_if_fail (connection != NULL);
5205 CONNECTION_LOCK (connection);
5206 _dbus_transport_set_unix_user_function (connection->transport,
5207 function, data, free_data_function,
5208 &old_data, &old_free_function);
5209 CONNECTION_UNLOCK (connection);
5211 if (old_free_function != NULL)
5212 (* old_free_function) (old_data);
5216 * Gets the Windows user SID of the connection if known. Returns
5217 * #TRUE if the ID is filled in. Always returns #FALSE on non-Windows
5218 * platforms for now, though in theory someone could hook UNIX to
5219 * Active Directory or something. Always returns #FALSE prior to
5220 * authenticating the connection.
5222 * The user is only read by servers from clients; clients can't usually
5223 * get the user of servers, because servers do not authenticate to
5224 * clients. The returned user is the user the connection authenticated
5227 * The message bus is a server and the apps connecting to the bus
5230 * The returned user string has to be freed with dbus_free().
5232 * The return value indicates whether the user SID is available;
5233 * if it's available but we don't have the memory to copy it,
5234 * then the return value is #TRUE and #NULL is given as the SID.
5236 * @todo We would like to be able to say "You can ask the bus to tell
5237 * you the user of another connection though if you like; this is done
5238 * with dbus_bus_get_windows_user()." But this has to be implemented
5239 * in bus/driver.c and dbus/dbus-bus.c, and is pointless anyway
5240 * since on Windows we only use the session bus for now.
5242 * @param connection the connection
5243 * @param windows_sid_p return location for an allocated copy of the user ID, or #NULL if no memory
5244 * @returns #TRUE if user is available (returned value may be #NULL anyway if no memory)
5247 dbus_connection_get_windows_user (DBusConnection *connection,
5248 char **windows_sid_p)
5252 _dbus_return_val_if_fail (connection != NULL, FALSE);
5253 _dbus_return_val_if_fail (windows_sid_p != NULL, FALSE);
5255 CONNECTION_LOCK (connection);
5257 if (!_dbus_transport_get_is_authenticated (connection->transport))
5260 result = _dbus_transport_get_windows_user (connection->transport,
5264 _dbus_assert (!result);
5267 CONNECTION_UNLOCK (connection);
5273 * Sets a predicate function used to determine whether a given user ID
5274 * is allowed to connect. When an incoming connection has
5275 * authenticated with a particular user ID, this function is called;
5276 * if it returns #TRUE, the connection is allowed to proceed,
5277 * otherwise the connection is disconnected.
5279 * If the function is set to #NULL (as it is by default), then
5280 * only the same user owning the server process will be allowed to
5283 * On UNIX, the function will be set and its free_data_function will
5284 * be invoked when the connection is freed or a new function is set.
5285 * However, the function will never be called, because there is no
5286 * way right now to authenticate as a Windows user on UNIX.
5288 * @param connection the connection
5289 * @param function the predicate
5290 * @param data data to pass to the predicate
5291 * @param free_data_function function to free the data
5294 dbus_connection_set_windows_user_function (DBusConnection *connection,
5295 DBusAllowWindowsUserFunction function,
5297 DBusFreeFunction free_data_function)
5299 void *old_data = NULL;
5300 DBusFreeFunction old_free_function = NULL;
5302 _dbus_return_if_fail (connection != NULL);
5304 CONNECTION_LOCK (connection);
5305 _dbus_transport_set_windows_user_function (connection->transport,
5306 function, data, free_data_function,
5307 &old_data, &old_free_function);
5308 CONNECTION_UNLOCK (connection);
5310 if (old_free_function != NULL)
5311 (* old_free_function) (old_data);
5315 * This function must be called on the server side of a connection when the
5316 * connection is first seen in the #DBusNewConnectionFunction. If set to
5317 * #TRUE (the default is #FALSE), then the connection can proceed even if
5318 * the client does not authenticate as some user identity, i.e. clients
5319 * can connect anonymously.
5321 * This setting interacts with the available authorization mechanisms
5322 * (see dbus_server_set_auth_mechanisms()). Namely, an auth mechanism
5323 * such as ANONYMOUS that supports anonymous auth must be included in
5324 * the list of available mechanisms for anonymous login to work.
5326 * This setting also changes the default rule for connections
5327 * authorized as a user; normally, if a connection authorizes as
5328 * a user identity, it is permitted if the user identity is
5329 * root or the user identity matches the user identity of the server
5330 * process. If anonymous connections are allowed, however,
5331 * then any user identity is allowed.
5333 * You can override the rules for connections authorized as a
5334 * user identity with dbus_connection_set_unix_user_function()
5335 * and dbus_connection_set_windows_user_function().
5337 * @param connection the connection
5338 * @param value whether to allow authentication as an anonymous user
5341 dbus_connection_set_allow_anonymous (DBusConnection *connection,
5344 _dbus_return_if_fail (connection != NULL);
5346 CONNECTION_LOCK (connection);
5347 _dbus_transport_set_allow_anonymous (connection->transport, value);
5348 CONNECTION_UNLOCK (connection);
5353 * Normally #DBusConnection automatically handles all messages to the
5354 * org.freedesktop.DBus.Peer interface. However, the message bus wants
5355 * to be able to route methods on that interface through the bus and
5356 * to other applications. If routing peer messages is enabled, then
5357 * messages with the org.freedesktop.DBus.Peer interface that also
5358 * have a bus destination name set will not be automatically
5359 * handled by the #DBusConnection and instead will be dispatched
5360 * normally to the application.
5362 * If a normal application sets this flag, it can break things badly.
5363 * So don't set this unless you are the message bus.
5365 * @param connection the connection
5366 * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
5369 dbus_connection_set_route_peer_messages (DBusConnection *connection,
5372 _dbus_return_if_fail (connection != NULL);
5374 CONNECTION_LOCK (connection);
5375 connection->route_peer_messages = TRUE;
5376 CONNECTION_UNLOCK (connection);
5380 * Adds a message filter. Filters are handlers that are run on all
5381 * incoming messages, prior to the objects registered with
5382 * dbus_connection_register_object_path(). Filters are run in the
5383 * order that they were added. The same handler can be added as a
5384 * filter more than once, in which case it will be run more than once.
5385 * Filters added during a filter callback won't be run on the message
5388 * @todo we don't run filters on messages while blocking without
5389 * entering the main loop, since filters are run as part of
5390 * dbus_connection_dispatch(). This is probably a feature, as filters
5391 * could create arbitrary reentrancy. But kind of sucks if you're
5392 * trying to filter METHOD_RETURN for some reason.
5394 * @param connection the connection
5395 * @param function function to handle messages
5396 * @param user_data user data to pass to the function
5397 * @param free_data_function function to use for freeing user data
5398 * @returns #TRUE on success, #FALSE if not enough memory.
5401 dbus_connection_add_filter (DBusConnection *connection,
5402 DBusHandleMessageFunction function,
5404 DBusFreeFunction free_data_function)
5406 DBusMessageFilter *filter;
5408 _dbus_return_val_if_fail (connection != NULL, FALSE);
5409 _dbus_return_val_if_fail (function != NULL, FALSE);
5411 filter = dbus_new0 (DBusMessageFilter, 1);
5415 filter->refcount.value = 1;
5417 CONNECTION_LOCK (connection);
5419 if (!_dbus_list_append (&connection->filter_list,
5422 _dbus_message_filter_unref (filter);
5423 CONNECTION_UNLOCK (connection);
5427 /* Fill in filter after all memory allocated,
5428 * so we don't run the free_user_data_function
5429 * if the add_filter() fails
5432 filter->function = function;
5433 filter->user_data = user_data;
5434 filter->free_user_data_function = free_data_function;
5436 CONNECTION_UNLOCK (connection);
5441 * Removes a previously-added message filter. It is a programming
5442 * error to call this function for a handler that has not been added
5443 * as a filter. If the given handler was added more than once, only
5444 * one instance of it will be removed (the most recently-added
5447 * @param connection the connection
5448 * @param function the handler to remove
5449 * @param user_data user data for the handler to remove
5453 dbus_connection_remove_filter (DBusConnection *connection,
5454 DBusHandleMessageFunction function,
5458 DBusMessageFilter *filter;
5460 _dbus_return_if_fail (connection != NULL);
5461 _dbus_return_if_fail (function != NULL);
5463 CONNECTION_LOCK (connection);
5467 link = _dbus_list_get_last_link (&connection->filter_list);
5468 while (link != NULL)
5470 filter = link->data;
5472 if (filter->function == function &&
5473 filter->user_data == user_data)
5475 _dbus_list_remove_link (&connection->filter_list, link);
5476 filter->function = NULL;
5481 link = _dbus_list_get_prev_link (&connection->filter_list, link);
5485 CONNECTION_UNLOCK (connection);
5487 #ifndef DBUS_DISABLE_CHECKS
5490 _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5491 function, user_data);
5496 /* Call application code */
5497 if (filter->free_user_data_function)
5498 (* filter->free_user_data_function) (filter->user_data);
5500 filter->free_user_data_function = NULL;
5501 filter->user_data = NULL;
5503 _dbus_message_filter_unref (filter);
5507 * Registers a handler for a given path in the object hierarchy.
5508 * The given vtable handles messages sent to exactly the given path.
5510 * @param connection the connection
5511 * @param path a '/' delimited string of path elements
5512 * @param vtable the virtual table
5513 * @param user_data data to pass to functions in the vtable
5514 * @param error address where an error can be returned
5515 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5516 * #DBUS_ERROR_ADDRESS_IN_USE) is reported
5519 dbus_connection_try_register_object_path (DBusConnection *connection,
5521 const DBusObjectPathVTable *vtable,
5525 char **decomposed_path;
5528 _dbus_return_val_if_fail (connection != NULL, FALSE);
5529 _dbus_return_val_if_fail (path != NULL, FALSE);
5530 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5531 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5533 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5536 CONNECTION_LOCK (connection);
5538 retval = _dbus_object_tree_register (connection->objects,
5540 (const char **) decomposed_path, vtable,
5543 CONNECTION_UNLOCK (connection);
5545 dbus_free_string_array (decomposed_path);
5551 * Registers a handler for a given path in the object hierarchy.
5552 * The given vtable handles messages sent to exactly the given path.
5554 * It is a bug to call this function for object paths which already
5555 * have a handler. Use dbus_connection_try_register_object_path() if this
5556 * might be the case.
5558 * @param connection the connection
5559 * @param path a '/' delimited string of path elements
5560 * @param vtable the virtual table
5561 * @param user_data data to pass to functions in the vtable
5562 * @returns #FALSE if not enough memory
5565 dbus_connection_register_object_path (DBusConnection *connection,
5567 const DBusObjectPathVTable *vtable,
5570 char **decomposed_path;
5572 DBusError error = DBUS_ERROR_INIT;
5574 _dbus_return_val_if_fail (connection != NULL, FALSE);
5575 _dbus_return_val_if_fail (path != NULL, FALSE);
5576 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5577 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5579 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5582 CONNECTION_LOCK (connection);
5584 retval = _dbus_object_tree_register (connection->objects,
5586 (const char **) decomposed_path, vtable,
5589 CONNECTION_UNLOCK (connection);
5591 dbus_free_string_array (decomposed_path);
5593 if (dbus_error_has_name (&error, DBUS_ERROR_ADDRESS_IN_USE))
5595 _dbus_warn ("%s\n", error.message);
5596 dbus_error_free (&error);
5604 * Registers a fallback handler for a given subsection of the object
5605 * hierarchy. The given vtable handles messages at or below the given
5606 * path. You can use this to establish a default message handling
5607 * policy for a whole "subdirectory."
5609 * @param connection the connection
5610 * @param path a '/' delimited string of path elements
5611 * @param vtable the virtual table
5612 * @param user_data data to pass to functions in the vtable
5613 * @param error address where an error can be returned
5614 * @returns #FALSE if an error (#DBUS_ERROR_NO_MEMORY or
5615 * #DBUS_ERROR_ADDRESS_IN_USE) is reported
5618 dbus_connection_try_register_fallback (DBusConnection *connection,
5620 const DBusObjectPathVTable *vtable,
5624 char **decomposed_path;
5627 _dbus_return_val_if_fail (connection != NULL, FALSE);
5628 _dbus_return_val_if_fail (path != NULL, FALSE);
5629 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5630 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5632 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5635 CONNECTION_LOCK (connection);
5637 retval = _dbus_object_tree_register (connection->objects,
5639 (const char **) decomposed_path, vtable,
5642 CONNECTION_UNLOCK (connection);
5644 dbus_free_string_array (decomposed_path);
5650 * Registers a fallback handler for a given subsection of the object
5651 * hierarchy. The given vtable handles messages at or below the given
5652 * path. You can use this to establish a default message handling
5653 * policy for a whole "subdirectory."
5655 * It is a bug to call this function for object paths which already
5656 * have a handler. Use dbus_connection_try_register_fallback() if this
5657 * might be the case.
5659 * @param connection the connection
5660 * @param path a '/' delimited string of path elements
5661 * @param vtable the virtual table
5662 * @param user_data data to pass to functions in the vtable
5663 * @returns #FALSE if not enough memory
5666 dbus_connection_register_fallback (DBusConnection *connection,
5668 const DBusObjectPathVTable *vtable,
5671 char **decomposed_path;
5673 DBusError error = DBUS_ERROR_INIT;
5675 _dbus_return_val_if_fail (connection != NULL, FALSE);
5676 _dbus_return_val_if_fail (path != NULL, FALSE);
5677 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5678 _dbus_return_val_if_fail (vtable != NULL, FALSE);
5680 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5683 CONNECTION_LOCK (connection);
5685 retval = _dbus_object_tree_register (connection->objects,
5687 (const char **) decomposed_path, vtable,
5690 CONNECTION_UNLOCK (connection);
5692 dbus_free_string_array (decomposed_path);
5694 if (dbus_error_has_name (&error, DBUS_ERROR_ADDRESS_IN_USE))
5696 _dbus_warn ("%s\n", error.message);
5697 dbus_error_free (&error);
5705 * Unregisters the handler registered with exactly the given path.
5706 * It's a bug to call this function for a path that isn't registered.
5707 * Can unregister both fallback paths and object paths.
5709 * @param connection the connection
5710 * @param path a '/' delimited string of path elements
5711 * @returns #FALSE if not enough memory
5714 dbus_connection_unregister_object_path (DBusConnection *connection,
5717 char **decomposed_path;
5719 _dbus_return_val_if_fail (connection != NULL, FALSE);
5720 _dbus_return_val_if_fail (path != NULL, FALSE);
5721 _dbus_return_val_if_fail (path[0] == '/', FALSE);
5723 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5726 CONNECTION_LOCK (connection);
5728 _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5730 dbus_free_string_array (decomposed_path);
5736 * Gets the user data passed to dbus_connection_register_object_path()
5737 * or dbus_connection_register_fallback(). If nothing was registered
5738 * at this path, the data is filled in with #NULL.
5740 * @param connection the connection
5741 * @param path the path you registered with
5742 * @param data_p location to store the user data, or #NULL
5743 * @returns #FALSE if not enough memory
5746 dbus_connection_get_object_path_data (DBusConnection *connection,
5750 char **decomposed_path;
5752 _dbus_return_val_if_fail (connection != NULL, FALSE);
5753 _dbus_return_val_if_fail (path != NULL, FALSE);
5754 _dbus_return_val_if_fail (data_p != NULL, FALSE);
5758 if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5761 CONNECTION_LOCK (connection);
5763 *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5765 CONNECTION_UNLOCK (connection);
5767 dbus_free_string_array (decomposed_path);
5773 * Lists the registered fallback handlers and object path handlers at
5774 * the given parent_path. The returned array should be freed with
5775 * dbus_free_string_array().
5777 * @param connection the connection
5778 * @param parent_path the path to list the child handlers of
5779 * @param child_entries returns #NULL-terminated array of children
5780 * @returns #FALSE if no memory to allocate the child entries
5783 dbus_connection_list_registered (DBusConnection *connection,
5784 const char *parent_path,
5785 char ***child_entries)
5787 char **decomposed_path;
5789 _dbus_return_val_if_fail (connection != NULL, FALSE);
5790 _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5791 _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5792 _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5794 if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5797 CONNECTION_LOCK (connection);
5799 retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5800 (const char **) decomposed_path,
5802 dbus_free_string_array (decomposed_path);
5807 static DBusDataSlotAllocator slot_allocator;
5808 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
5811 * Allocates an integer ID to be used for storing application-specific
5812 * data on any DBusConnection. The allocated ID may then be used
5813 * with dbus_connection_set_data() and dbus_connection_get_data().
5814 * The passed-in slot must be initialized to -1, and is filled in
5815 * with the slot ID. If the passed-in slot is not -1, it's assumed
5816 * to be already allocated, and its refcount is incremented.
5818 * The allocated slot is global, i.e. all DBusConnection objects will
5819 * have a slot with the given integer ID reserved.
5821 * @param slot_p address of a global variable storing the slot
5822 * @returns #FALSE on failure (no memory)
5825 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5827 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5828 &_DBUS_LOCK_NAME (connection_slots),
5833 * Deallocates a global ID for connection data slots.
5834 * dbus_connection_get_data() and dbus_connection_set_data() may no
5835 * longer be used with this slot. Existing data stored on existing
5836 * DBusConnection objects will be freed when the connection is
5837 * finalized, but may not be retrieved (and may only be replaced if
5838 * someone else reallocates the slot). When the refcount on the
5839 * passed-in slot reaches 0, it is set to -1.
5841 * @param slot_p address storing the slot to deallocate
5844 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5846 _dbus_return_if_fail (*slot_p >= 0);
5848 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5852 * Stores a pointer on a DBusConnection, along
5853 * with an optional function to be used for freeing
5854 * the data when the data is set again, or when
5855 * the connection is finalized. The slot number
5856 * must have been allocated with dbus_connection_allocate_data_slot().
5858 * @param connection the connection
5859 * @param slot the slot number
5860 * @param data the data to store
5861 * @param free_data_func finalizer function for the data
5862 * @returns #TRUE if there was enough memory to store the data
5865 dbus_connection_set_data (DBusConnection *connection,
5868 DBusFreeFunction free_data_func)
5870 DBusFreeFunction old_free_func;
5874 _dbus_return_val_if_fail (connection != NULL, FALSE);
5875 _dbus_return_val_if_fail (slot >= 0, FALSE);
5877 CONNECTION_LOCK (connection);
5879 retval = _dbus_data_slot_list_set (&slot_allocator,
5880 &connection->slot_list,
5881 slot, data, free_data_func,
5882 &old_free_func, &old_data);
5884 CONNECTION_UNLOCK (connection);
5888 /* Do the actual free outside the connection lock */
5890 (* old_free_func) (old_data);
5897 * Retrieves data previously set with dbus_connection_set_data().
5898 * The slot must still be allocated (must not have been freed).
5900 * @param connection the connection
5901 * @param slot the slot to get data from
5902 * @returns the data, or #NULL if not found
5905 dbus_connection_get_data (DBusConnection *connection,
5910 _dbus_return_val_if_fail (connection != NULL, NULL);
5912 CONNECTION_LOCK (connection);
5914 res = _dbus_data_slot_list_get (&slot_allocator,
5915 &connection->slot_list,
5918 CONNECTION_UNLOCK (connection);
5924 * This function sets a global flag for whether dbus_connection_new()
5925 * will set SIGPIPE behavior to SIG_IGN.
5927 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
5930 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
5932 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
5936 * Specifies the maximum size message this connection is allowed to
5937 * receive. Larger messages will result in disconnecting the
5940 * @param connection a #DBusConnection
5941 * @param size maximum message size the connection can receive, in bytes
5944 dbus_connection_set_max_message_size (DBusConnection *connection,
5947 _dbus_return_if_fail (connection != NULL);
5949 CONNECTION_LOCK (connection);
5950 _dbus_transport_set_max_message_size (connection->transport,
5952 CONNECTION_UNLOCK (connection);
5956 * Gets the value set by dbus_connection_set_max_message_size().
5958 * @param connection the connection
5959 * @returns the max size of a single message
5962 dbus_connection_get_max_message_size (DBusConnection *connection)
5966 _dbus_return_val_if_fail (connection != NULL, 0);
5968 CONNECTION_LOCK (connection);
5969 res = _dbus_transport_get_max_message_size (connection->transport);
5970 CONNECTION_UNLOCK (connection);
5975 * Specifies the maximum number of unix fds a message on this
5976 * connection is allowed to receive. Messages with more unix fds will
5977 * result in disconnecting the connection.
5979 * @param connection a #DBusConnection
5980 * @param size maximum message unix fds the connection can receive
5983 dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
5986 _dbus_return_if_fail (connection != NULL);
5988 CONNECTION_LOCK (connection);
5989 _dbus_transport_set_max_message_unix_fds (connection->transport,
5991 CONNECTION_UNLOCK (connection);
5995 * Gets the value set by dbus_connection_set_max_message_unix_fds().
5997 * @param connection the connection
5998 * @returns the max numer of unix fds of a single message
6001 dbus_connection_get_max_message_unix_fds (DBusConnection *connection)
6005 _dbus_return_val_if_fail (connection != NULL, 0);
6007 CONNECTION_LOCK (connection);
6008 res = _dbus_transport_get_max_message_unix_fds (connection->transport);
6009 CONNECTION_UNLOCK (connection);
6014 * Sets the maximum total number of bytes that can be used for all messages
6015 * received on this connection. Messages count toward the maximum until
6016 * they are finalized. When the maximum is reached, the connection will
6017 * not read more data until some messages are finalized.
6019 * The semantics of the maximum are: if outstanding messages are
6020 * already above the maximum, additional messages will not be read.
6021 * The semantics are not: if the next message would cause us to exceed
6022 * the maximum, we don't read it. The reason is that we don't know the
6023 * size of a message until after we read it.
6025 * Thus, the max live messages size can actually be exceeded
6026 * by up to the maximum size of a single message.
6028 * Also, if we read say 1024 bytes off the wire in a single read(),
6029 * and that contains a half-dozen small messages, we may exceed the
6030 * size max by that amount. But this should be inconsequential.
6032 * This does imply that we can't call read() with a buffer larger
6033 * than we're willing to exceed this limit by.
6035 * @param connection the connection
6036 * @param size the maximum size in bytes of all outstanding messages
6039 dbus_connection_set_max_received_size (DBusConnection *connection,
6042 _dbus_return_if_fail (connection != NULL);
6044 CONNECTION_LOCK (connection);
6045 _dbus_transport_set_max_received_size (connection->transport,
6047 CONNECTION_UNLOCK (connection);
6051 * Gets the value set by dbus_connection_set_max_received_size().
6053 * @param connection the connection
6054 * @returns the max size of all live messages
6057 dbus_connection_get_max_received_size (DBusConnection *connection)
6061 _dbus_return_val_if_fail (connection != NULL, 0);
6063 CONNECTION_LOCK (connection);
6064 res = _dbus_transport_get_max_received_size (connection->transport);
6065 CONNECTION_UNLOCK (connection);
6070 * Sets the maximum total number of unix fds that can be used for all messages
6071 * received on this connection. Messages count toward the maximum until
6072 * they are finalized. When the maximum is reached, the connection will
6073 * not read more data until some messages are finalized.
6075 * The semantics are analogous to those of dbus_connection_set_max_received_size().
6077 * @param connection the connection
6078 * @param size the maximum size in bytes of all outstanding messages
6081 dbus_connection_set_max_received_unix_fds (DBusConnection *connection,
6084 _dbus_return_if_fail (connection != NULL);
6086 CONNECTION_LOCK (connection);
6087 _dbus_transport_set_max_received_unix_fds (connection->transport,
6089 CONNECTION_UNLOCK (connection);
6093 * Gets the value set by dbus_connection_set_max_received_unix_fds().
6095 * @param connection the connection
6096 * @returns the max unix fds of all live messages
6099 dbus_connection_get_max_received_unix_fds (DBusConnection *connection)
6103 _dbus_return_val_if_fail (connection != NULL, 0);
6105 CONNECTION_LOCK (connection);
6106 res = _dbus_transport_get_max_received_unix_fds (connection->transport);
6107 CONNECTION_UNLOCK (connection);
6112 * Gets the approximate size in bytes of all messages in the outgoing
6113 * message queue. The size is approximate in that you shouldn't use
6114 * it to decide how many bytes to read off the network or anything
6115 * of that nature, as optimizations may choose to tell small white lies
6116 * to avoid performance overhead.
6118 * @param connection the connection
6119 * @returns the number of bytes that have been queued up but not sent
6122 dbus_connection_get_outgoing_size (DBusConnection *connection)
6126 _dbus_return_val_if_fail (connection != NULL, 0);
6128 CONNECTION_LOCK (connection);
6129 res = _dbus_counter_get_size_value (connection->outgoing_counter);
6130 CONNECTION_UNLOCK (connection);
6135 * Gets the approximate number of uni fds of all messages in the
6136 * outgoing message queue.
6138 * @param connection the connection
6139 * @returns the number of unix fds that have been queued up but not sent
6142 dbus_connection_get_outgoing_unix_fds (DBusConnection *connection)
6146 _dbus_return_val_if_fail (connection != NULL, 0);
6148 CONNECTION_LOCK (connection);
6149 res = _dbus_counter_get_unix_fd_value (connection->outgoing_counter);
6150 CONNECTION_UNLOCK (connection);