1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-connection.c DBusConnection object
4 * Copyright (C) 2002, 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 1.2
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "dbus-connection.h"
26 #include "dbus-list.h"
27 #include "dbus-timeout.h"
28 #include "dbus-transport.h"
29 #include "dbus-watch.h"
30 #include "dbus-connection-internal.h"
31 #include "dbus-list.h"
32 #include "dbus-hash.h"
33 #include "dbus-message-internal.h"
34 #include "dbus-message-handler.h"
35 #include "dbus-threads.h"
36 #include "dbus-protocol.h"
37 #include "dbus-dataslot.h"
40 #define CONNECTION_LOCK(connection) do { \
41 _dbus_verbose (" LOCK: %s\n", _DBUS_FUNCTION_NAME); \
42 dbus_mutex_lock ((connection)->mutex); \
44 #define CONNECTION_UNLOCK(connection) do { \
45 _dbus_verbose (" UNLOCK: %s\n", _DBUS_FUNCTION_NAME); \
46 dbus_mutex_unlock ((connection)->mutex); \
49 #define CONNECTION_LOCK(connection) dbus_mutex_lock ((connection)->mutex)
50 #define CONNECTION_UNLOCK(connection) dbus_mutex_unlock ((connection)->mutex)
54 * @defgroup DBusConnection DBusConnection
56 * @brief Connection to another application
58 * A DBusConnection represents a connection to another
59 * application. Messages can be sent and received via this connection.
60 * The other application may be a message bus; for convenience, the
61 * function dbus_bus_get() is provided to automatically open a
62 * connection to the well-known message buses.
64 * In brief a DBusConnection is a message queue associated with some
65 * message transport mechanism such as a socket. The connection
66 * maintains a queue of incoming messages and a queue of outgoing
69 * Incoming messages are normally processed by calling
70 * dbus_connection_dispatch(). dbus_connection_dispatch() runs any
71 * handlers registered for the topmost message in the message queue,
72 * then discards the message, then returns.
74 * dbus_connection_get_dispatch_status() indicates whether
75 * messages are currently in the queue that need dispatching.
76 * dbus_connection_set_dispatch_status_function() allows
77 * you to set a function to be used to monitor the dispatch status.
79 * If you're using GLib or Qt add-on libraries for D-BUS, there are
80 * special convenience functions in those libraries that hide
81 * all the details of dispatch and watch/timeout monitoring.
82 * For example, dbus_connection_setup_with_g_main().
84 * If you aren't using these add-on libraries, you have to manually
85 * call dbus_connection_set_dispatch_status_function(),
86 * dbus_connection_set_watch_functions(),
87 * dbus_connection_set_timeout_functions() providing appropriate
88 * functions to integrate the connection with your application's main
91 * When you use dbus_connection_send() or one of its variants to send
92 * a message, the message is added to the outgoing queue. It's
93 * actually written to the network later; either in
94 * dbus_watch_handle() invoked by your main loop, or in
95 * dbus_connection_flush() which blocks until it can write out the
96 * entire outgoing queue. The GLib/Qt add-on libraries again
97 * handle the details here for you by setting up watch functions.
99 * When a connection is disconnected, you are guaranteed to get a
100 * message with the name #DBUS_MESSAGE_LOCAL_DISCONNECT.
102 * You may not drop the last reference to a #DBusConnection
103 * until that connection has been disconnected.
105 * You may dispatch the unprocessed incoming message queue even if the
106 * connection is disconnected. However, #DBUS_MESSAGE_LOCAL_DISCONNECT
107 * will always be the last message in the queue (obviously no messages
108 * are received after disconnection).
110 * #DBusConnection has thread locks and drops them when invoking user
111 * callbacks, so in general is transparently threadsafe. However,
112 * #DBusMessage does NOT have thread locks; you must not send the same
113 * message to multiple #DBusConnection that will be used from
118 * @defgroup DBusConnectionInternals DBusConnection implementation details
119 * @ingroup DBusInternals
120 * @brief Implementation details of DBusConnection
125 /** default timeout value when waiting for a message reply */
126 #define DEFAULT_TIMEOUT_VALUE (15 * 1000)
128 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
131 * Implementation details of DBusConnection. All fields are private.
133 struct DBusConnection
135 DBusAtomic refcount; /**< Reference count. */
137 DBusMutex *mutex; /**< Lock on the entire DBusConnection */
139 dbus_bool_t dispatch_acquired; /**< Protects dispatch() */
140 DBusCondVar *dispatch_cond; /**< Protects dispatch() */
142 dbus_bool_t io_path_acquired; /**< Protects transport io path */
143 DBusCondVar *io_path_cond; /**< Protects transport io path */
145 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
146 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
148 DBusMessage *message_borrowed; /**< True if the first incoming message has been borrowed */
149 DBusCondVar *message_returned_cond; /**< Used with dbus_connection_borrow_message() */
151 int n_outgoing; /**< Length of outgoing queue. */
152 int n_incoming; /**< Length of incoming queue. */
154 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
156 DBusTransport *transport; /**< Object that sends/receives messages over network. */
157 DBusWatchList *watches; /**< Stores active watches. */
158 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
160 DBusHashTable *handler_table; /**< Table of registered DBusMessageHandler */
161 DBusList *filter_list; /**< List of filters. */
163 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
165 DBusHashTable *pending_replies; /**< Hash of message serials and their message handlers. */
167 dbus_uint32_t client_serial; /**< Client serial. Increments each time a message is sent */
168 DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
170 DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop */
171 void *wakeup_main_data; /**< Application data for wakeup_main_function */
172 DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
174 DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes */
175 void *dispatch_status_data; /**< Application data for dispatch_status_function */
176 DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
178 DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
180 DBusList *link_cache; /**< A cache of linked list links to prevent contention
181 * for the global linked list mempool lock
187 DBusConnection *connection;
188 DBusMessageHandler *handler;
189 DBusTimeout *timeout;
192 DBusList *timeout_link; /* Preallocated timeout response */
194 dbus_bool_t timeout_added;
195 dbus_bool_t connection_added;
198 static void reply_handler_data_free (ReplyHandlerData *data);
200 static void _dbus_connection_remove_timeout_locked (DBusConnection *connection,
201 DBusTimeout *timeout);
202 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
203 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
204 DBusDispatchStatus new_status);
209 * Acquires the connection lock.
211 * @param connection the connection.
214 _dbus_connection_lock (DBusConnection *connection)
216 CONNECTION_LOCK (connection);
220 * Releases the connection lock.
222 * @param connection the connection.
225 _dbus_connection_unlock (DBusConnection *connection)
227 CONNECTION_UNLOCK (connection);
231 * Wakes up the main loop if it is sleeping
232 * Needed if we're e.g. queueing outgoing messages
233 * on a thread while the mainloop sleeps.
235 * @param connection the connection.
238 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
240 if (connection->wakeup_main_function)
241 (*connection->wakeup_main_function) (connection->wakeup_main_data);
244 #ifdef DBUS_BUILD_TESTS
245 /* For now this function isn't used */
247 * Adds a message to the incoming message queue, returning #FALSE
248 * if there's insufficient memory to queue the message.
249 * Does not take over refcount of the message.
251 * @param connection the connection.
252 * @param message the message to queue.
253 * @returns #TRUE on success.
256 _dbus_connection_queue_received_message (DBusConnection *connection,
257 DBusMessage *message)
261 link = _dbus_list_alloc_link (message);
265 dbus_message_ref (message);
266 _dbus_connection_queue_received_message_link (connection, link);
273 * Adds a message-containing list link to the incoming message queue,
274 * taking ownership of the link and the message's current refcount.
275 * Cannot fail due to lack of memory.
277 * @param connection the connection.
278 * @param link the message link to queue.
281 _dbus_connection_queue_received_message_link (DBusConnection *connection,
284 ReplyHandlerData *reply_handler_data;
285 dbus_int32_t reply_serial;
286 DBusMessage *message;
288 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
290 _dbus_list_append_link (&connection->incoming_messages,
292 message = link->data;
294 /* If this is a reply we're waiting on, remove timeout for it */
295 reply_serial = dbus_message_get_reply_serial (message);
296 if (reply_serial != -1)
298 reply_handler_data = _dbus_hash_table_lookup_int (connection->pending_replies,
300 if (reply_handler_data != NULL)
302 if (reply_handler_data->timeout_added)
303 _dbus_connection_remove_timeout_locked (connection,
304 reply_handler_data->timeout);
305 reply_handler_data->timeout_added = FALSE;
309 connection->n_incoming += 1;
311 _dbus_connection_wakeup_mainloop (connection);
313 _dbus_assert (dbus_message_get_name (message) != NULL);
314 _dbus_verbose ("Message %p (%s) added to incoming queue %p, %d incoming\n",
315 message, dbus_message_get_name (message),
317 connection->n_incoming);
321 * Adds a link + message to the incoming message queue.
322 * Can't fail. Takes ownership of both link and message.
324 * @param connection the connection.
325 * @param link the list node and message to queue.
327 * @todo This needs to wake up the mainloop if it is in
328 * a poll/select and this is a multithreaded app.
331 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
334 _dbus_list_append_link (&connection->incoming_messages, link);
336 connection->n_incoming += 1;
338 _dbus_connection_wakeup_mainloop (connection);
340 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
341 link->data, connection, connection->n_incoming);
346 * Checks whether there are messages in the outgoing message queue.
348 * @param connection the connection.
349 * @returns #TRUE if the outgoing queue is non-empty.
352 _dbus_connection_have_messages_to_send (DBusConnection *connection)
354 return connection->outgoing_messages != NULL;
358 * Gets the next outgoing message. The message remains in the
359 * queue, and the caller does not own a reference to it.
361 * @param connection the connection.
362 * @returns the message to be sent.
365 _dbus_connection_get_message_to_send (DBusConnection *connection)
367 return _dbus_list_get_last (&connection->outgoing_messages);
371 * Notifies the connection that a message has been sent, so the
372 * message can be removed from the outgoing queue.
373 * Called with the connection lock held.
375 * @param connection the connection.
376 * @param message the message that was sent.
379 _dbus_connection_message_sent (DBusConnection *connection,
380 DBusMessage *message)
384 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
386 link = _dbus_list_get_last_link (&connection->outgoing_messages);
387 _dbus_assert (link != NULL);
388 _dbus_assert (link->data == message);
390 /* Save this link in the link cache */
391 _dbus_list_unlink (&connection->outgoing_messages,
393 _dbus_list_prepend_link (&connection->link_cache, link);
395 connection->n_outgoing -= 1;
397 _dbus_verbose ("Message %p (%s) removed from outgoing queue %p, %d left to send\n",
398 message, dbus_message_get_name (message),
399 connection, connection->n_outgoing);
401 /* Save this link in the link cache also */
402 _dbus_message_remove_size_counter (message, connection->outgoing_counter,
404 _dbus_list_prepend_link (&connection->link_cache, link);
406 dbus_message_unref (message);
408 if (connection->n_outgoing == 0)
409 _dbus_transport_messages_pending (connection->transport,
410 connection->n_outgoing);
414 * Adds a watch using the connection's DBusAddWatchFunction if
415 * available. Otherwise records the watch to be added when said
416 * function is available. Also re-adds the watch if the
417 * DBusAddWatchFunction changes. May fail due to lack of memory.
419 * @param connection the connection.
420 * @param watch the watch to add.
421 * @returns #TRUE on success.
424 _dbus_connection_add_watch (DBusConnection *connection,
427 if (connection->watches) /* null during finalize */
428 return _dbus_watch_list_add_watch (connection->watches,
435 * Removes a watch using the connection's DBusRemoveWatchFunction
436 * if available. It's an error to call this function on a watch
437 * that was not previously added.
439 * @param connection the connection.
440 * @param watch the watch to remove.
443 _dbus_connection_remove_watch (DBusConnection *connection,
446 if (connection->watches) /* null during finalize */
447 _dbus_watch_list_remove_watch (connection->watches,
452 * Toggles a watch and notifies app via connection's
453 * DBusWatchToggledFunction if available. It's an error to call this
454 * function on a watch that was not previously added.
456 * @param connection the connection.
457 * @param watch the watch to toggle.
458 * @param enabled whether to enable or disable
461 _dbus_connection_toggle_watch (DBusConnection *connection,
465 if (connection->watches) /* null during finalize */
466 _dbus_watch_list_toggle_watch (connection->watches,
471 * Adds a timeout using the connection's DBusAddTimeoutFunction if
472 * available. Otherwise records the timeout to be added when said
473 * function is available. Also re-adds the timeout if the
474 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
475 * The timeout will fire repeatedly until removed.
477 * @param connection the connection.
478 * @param timeout the timeout to add.
479 * @returns #TRUE on success.
482 _dbus_connection_add_timeout (DBusConnection *connection,
483 DBusTimeout *timeout)
485 if (connection->timeouts) /* null during finalize */
486 return _dbus_timeout_list_add_timeout (connection->timeouts,
493 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
494 * if available. It's an error to call this function on a timeout
495 * that was not previously added.
497 * @param connection the connection.
498 * @param timeout the timeout to remove.
501 _dbus_connection_remove_timeout (DBusConnection *connection,
502 DBusTimeout *timeout)
504 if (connection->timeouts) /* null during finalize */
505 _dbus_timeout_list_remove_timeout (connection->timeouts,
510 _dbus_connection_remove_timeout_locked (DBusConnection *connection,
511 DBusTimeout *timeout)
513 CONNECTION_LOCK (connection);
514 _dbus_connection_remove_timeout (connection, timeout);
515 CONNECTION_UNLOCK (connection);
519 * Toggles a timeout and notifies app via connection's
520 * DBusTimeoutToggledFunction if available. It's an error to call this
521 * function on a timeout that was not previously added.
523 * @param connection the connection.
524 * @param timeout the timeout to toggle.
525 * @param enabled whether to enable or disable
528 _dbus_connection_toggle_timeout (DBusConnection *connection,
529 DBusTimeout *timeout,
532 if (connection->timeouts) /* null during finalize */
533 _dbus_timeout_list_toggle_timeout (connection->timeouts,
538 * Tells the connection that the transport has been disconnected.
539 * Results in posting a disconnect message on the incoming message
540 * queue. Only has an effect the first time it's called.
542 * @param connection the connection
545 _dbus_connection_notify_disconnected (DBusConnection *connection)
547 if (connection->disconnect_message_link)
549 /* We haven't sent the disconnect message already */
550 _dbus_connection_queue_synthesized_message_link (connection,
551 connection->disconnect_message_link);
552 connection->disconnect_message_link = NULL;
558 * Acquire the transporter I/O path. This must be done before
559 * doing any I/O in the transporter. May sleep and drop the
560 * connection mutex while waiting for the I/O path.
562 * @param connection the connection.
563 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
564 * @returns TRUE if the I/O path was acquired.
567 _dbus_connection_acquire_io_path (DBusConnection *connection,
568 int timeout_milliseconds)
570 dbus_bool_t res = TRUE;
572 if (connection->io_path_acquired)
574 if (timeout_milliseconds != -1)
575 res = dbus_condvar_wait_timeout (connection->io_path_cond,
577 timeout_milliseconds);
579 dbus_condvar_wait (connection->io_path_cond, connection->mutex);
584 _dbus_assert (!connection->io_path_acquired);
586 connection->io_path_acquired = TRUE;
593 * Release the I/O path when you're done with it. Only call
594 * after you've acquired the I/O. Wakes up at most one thread
595 * currently waiting to acquire the I/O path.
597 * @param connection the connection.
600 _dbus_connection_release_io_path (DBusConnection *connection)
602 _dbus_assert (connection->io_path_acquired);
604 connection->io_path_acquired = FALSE;
605 dbus_condvar_wake_one (connection->io_path_cond);
610 * Queues incoming messages and sends outgoing messages for this
611 * connection, optionally blocking in the process. Each call to
612 * _dbus_connection_do_iteration() will call select() or poll() one
613 * time and then read or write data if possible.
615 * The purpose of this function is to be able to flush outgoing
616 * messages or queue up incoming messages without returning
617 * control to the application and causing reentrancy weirdness.
619 * The flags parameter allows you to specify whether to
620 * read incoming messages, write outgoing messages, or both,
621 * and whether to block if no immediate action is possible.
623 * The timeout_milliseconds parameter does nothing unless the
624 * iteration is blocking.
626 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
627 * wasn't specified, then it's impossible to block, even if
628 * you specify DBUS_ITERATION_BLOCK; in that case the function
629 * returns immediately.
631 * @param connection the connection.
632 * @param flags iteration flags.
633 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
636 _dbus_connection_do_iteration (DBusConnection *connection,
638 int timeout_milliseconds)
640 if (connection->n_outgoing == 0)
641 flags &= ~DBUS_ITERATION_DO_WRITING;
643 if (_dbus_connection_acquire_io_path (connection,
644 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
646 _dbus_transport_do_iteration (connection->transport,
647 flags, timeout_milliseconds);
648 _dbus_connection_release_io_path (connection);
653 * Creates a new connection for the given transport. A transport
654 * represents a message stream that uses some concrete mechanism, such
655 * as UNIX domain sockets. May return #NULL if insufficient
656 * memory exists to create the connection.
658 * @param transport the transport.
659 * @returns the new connection, or #NULL on failure.
662 _dbus_connection_new_for_transport (DBusTransport *transport)
664 DBusConnection *connection;
665 DBusWatchList *watch_list;
666 DBusTimeoutList *timeout_list;
667 DBusHashTable *handler_table, *pending_replies;
669 DBusCondVar *message_returned_cond;
670 DBusCondVar *dispatch_cond;
671 DBusCondVar *io_path_cond;
672 DBusList *disconnect_link;
673 DBusMessage *disconnect_message;
674 DBusCounter *outgoing_counter;
678 handler_table = NULL;
679 pending_replies = NULL;
682 message_returned_cond = NULL;
683 dispatch_cond = NULL;
685 disconnect_link = NULL;
686 disconnect_message = NULL;
687 outgoing_counter = NULL;
689 watch_list = _dbus_watch_list_new ();
690 if (watch_list == NULL)
693 timeout_list = _dbus_timeout_list_new ();
694 if (timeout_list == NULL)
698 _dbus_hash_table_new (DBUS_HASH_STRING,
700 if (handler_table == NULL)
704 _dbus_hash_table_new (DBUS_HASH_INT,
705 NULL, (DBusFreeFunction)reply_handler_data_free);
706 if (pending_replies == NULL)
709 connection = dbus_new0 (DBusConnection, 1);
710 if (connection == NULL)
713 mutex = dbus_mutex_new ();
717 message_returned_cond = dbus_condvar_new ();
718 if (message_returned_cond == NULL)
721 dispatch_cond = dbus_condvar_new ();
722 if (dispatch_cond == NULL)
725 io_path_cond = dbus_condvar_new ();
726 if (io_path_cond == NULL)
729 disconnect_message = dbus_message_new (DBUS_MESSAGE_LOCAL_DISCONNECT, NULL);
730 if (disconnect_message == NULL)
733 disconnect_link = _dbus_list_alloc_link (disconnect_message);
734 if (disconnect_link == NULL)
737 outgoing_counter = _dbus_counter_new ();
738 if (outgoing_counter == NULL)
741 if (_dbus_modify_sigpipe)
742 _dbus_disable_sigpipe ();
744 connection->refcount.value = 1;
745 connection->mutex = mutex;
746 connection->dispatch_cond = dispatch_cond;
747 connection->io_path_cond = io_path_cond;
748 connection->message_returned_cond = message_returned_cond;
749 connection->transport = transport;
750 connection->watches = watch_list;
751 connection->timeouts = timeout_list;
752 connection->handler_table = handler_table;
753 connection->pending_replies = pending_replies;
754 connection->outgoing_counter = outgoing_counter;
755 connection->filter_list = NULL;
756 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
758 _dbus_data_slot_list_init (&connection->slot_list);
760 connection->client_serial = 1;
762 connection->disconnect_message_link = disconnect_link;
764 if (!_dbus_transport_set_connection (transport, connection))
767 _dbus_transport_ref (transport);
772 if (disconnect_message != NULL)
773 dbus_message_unref (disconnect_message);
775 if (disconnect_link != NULL)
776 _dbus_list_free_link (disconnect_link);
778 if (io_path_cond != NULL)
779 dbus_condvar_free (io_path_cond);
781 if (dispatch_cond != NULL)
782 dbus_condvar_free (dispatch_cond);
784 if (message_returned_cond != NULL)
785 dbus_condvar_free (message_returned_cond);
788 dbus_mutex_free (mutex);
790 if (connection != NULL)
791 dbus_free (connection);
794 _dbus_hash_table_unref (handler_table);
797 _dbus_hash_table_unref (pending_replies);
800 _dbus_watch_list_free (watch_list);
803 _dbus_timeout_list_free (timeout_list);
805 if (outgoing_counter)
806 _dbus_counter_unref (outgoing_counter);
812 * Increments the reference count of a DBusConnection.
813 * Requires that the caller already holds the connection lock.
815 * @param connection the connection.
818 _dbus_connection_ref_unlocked (DBusConnection *connection)
820 #ifdef DBUS_HAVE_ATOMIC_INT
821 _dbus_atomic_inc (&connection->refcount);
823 _dbus_assert (connection->refcount.value > 0);
824 connection->refcount.value += 1;
829 _dbus_connection_get_next_client_serial (DBusConnection *connection)
833 serial = connection->client_serial++;
835 if (connection->client_serial < 0)
836 connection->client_serial = 1;
842 * Used to notify a connection when a DBusMessageHandler is
843 * destroyed, so the connection can drop any reference
844 * to the handler. This is a private function, but still
845 * takes the connection lock. Don't call it with the lock held.
847 * @todo needs to check in pending_replies too.
849 * @param connection the connection
850 * @param handler the handler
853 _dbus_connection_handler_destroyed_locked (DBusConnection *connection,
854 DBusMessageHandler *handler)
859 CONNECTION_LOCK (connection);
861 _dbus_hash_iter_init (connection->handler_table, &iter);
862 while (_dbus_hash_iter_next (&iter))
864 DBusMessageHandler *h = _dbus_hash_iter_get_value (&iter);
867 _dbus_hash_iter_remove_entry (&iter);
870 link = _dbus_list_get_first_link (&connection->filter_list);
873 DBusMessageHandler *h = link->data;
874 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
877 _dbus_list_remove_link (&connection->filter_list,
882 CONNECTION_UNLOCK (connection);
886 * A callback for use with dbus_watch_new() to create a DBusWatch.
888 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
889 * and the virtual handle_watch in DBusTransport if we got rid of it.
890 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
893 * @param watch the watch.
894 * @param condition the current condition of the file descriptors being watched.
895 * @param data must be a pointer to a #DBusConnection
896 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
899 _dbus_connection_handle_watch (DBusWatch *watch,
900 unsigned int condition,
903 DBusConnection *connection;
905 DBusDispatchStatus status;
909 CONNECTION_LOCK (connection);
910 _dbus_connection_acquire_io_path (connection, -1);
911 retval = _dbus_transport_handle_watch (connection->transport,
913 _dbus_connection_release_io_path (connection);
915 status = _dbus_connection_get_dispatch_status_unlocked (connection);
917 /* this calls out to user code */
918 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
924 * Get the ID to be used in the high bits of an object ID for an object
925 * registered with this connection.
927 * @todo implement this function
929 * @param connection the connection.
930 * @returns the connection portion of the object ID
933 _dbus_connection_get_id (DBusConnection *connection)
942 * @addtogroup DBusConnection
948 * Opens a new connection to a remote address.
950 * @todo specify what the address parameter is. Right now
951 * it's just the name of a UNIX domain socket. It should be
952 * something more complex that encodes which transport to use.
954 * If the open fails, the function returns #NULL, and provides
955 * a reason for the failure in the result parameter. Pass
956 * #NULL for the result parameter if you aren't interested
957 * in the reason for failure.
959 * @param address the address.
960 * @param error address where an error can be returned.
961 * @returns new connection, or #NULL on failure.
964 dbus_connection_open (const char *address,
967 DBusConnection *connection;
968 DBusTransport *transport;
970 _dbus_return_val_if_fail (address != NULL, NULL);
971 _dbus_return_val_if_error_is_set (error, NULL);
973 transport = _dbus_transport_open (address, error);
974 if (transport == NULL)
976 _DBUS_ASSERT_ERROR_IS_SET (error);
980 connection = _dbus_connection_new_for_transport (transport);
982 _dbus_transport_unref (transport);
984 if (connection == NULL)
986 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
994 * Increments the reference count of a DBusConnection.
996 * @param connection the connection.
999 dbus_connection_ref (DBusConnection *connection)
1001 _dbus_return_if_fail (connection != NULL);
1003 /* The connection lock is better than the global
1004 * lock in the atomic increment fallback
1007 #ifdef DBUS_HAVE_ATOMIC_INT
1008 _dbus_atomic_inc (&connection->refcount);
1010 CONNECTION_LOCK (connection);
1011 _dbus_assert (connection->refcount.value > 0);
1013 connection->refcount.value += 1;
1014 CONNECTION_UNLOCK (connection);
1019 free_outgoing_message (void *element,
1022 DBusMessage *message = element;
1023 DBusConnection *connection = data;
1025 _dbus_message_remove_size_counter (message,
1026 connection->outgoing_counter,
1028 dbus_message_unref (message);
1031 /* This is run without the mutex held, but after the last reference
1032 * to the connection has been dropped we should have no thread-related
1036 _dbus_connection_last_unref (DBusConnection *connection)
1041 _dbus_verbose ("Finalizing connection %p\n", connection);
1043 _dbus_assert (connection->refcount.value == 0);
1045 /* You have to disconnect the connection before unref:ing it. Otherwise
1046 * you won't get the disconnected message.
1048 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
1050 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
1051 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
1052 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
1053 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
1055 _dbus_watch_list_free (connection->watches);
1056 connection->watches = NULL;
1058 _dbus_timeout_list_free (connection->timeouts);
1059 connection->timeouts = NULL;
1061 _dbus_data_slot_list_free (&connection->slot_list);
1062 /* ---- Done with stuff that invokes application callbacks */
1064 _dbus_hash_iter_init (connection->handler_table, &iter);
1065 while (_dbus_hash_iter_next (&iter))
1067 DBusMessageHandler *h = _dbus_hash_iter_get_value (&iter);
1069 _dbus_message_handler_remove_connection (h, connection);
1072 link = _dbus_list_get_first_link (&connection->filter_list);
1073 while (link != NULL)
1075 DBusMessageHandler *h = link->data;
1076 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
1078 _dbus_message_handler_remove_connection (h, connection);
1083 _dbus_hash_table_unref (connection->handler_table);
1084 connection->handler_table = NULL;
1086 _dbus_hash_table_unref (connection->pending_replies);
1087 connection->pending_replies = NULL;
1089 _dbus_list_clear (&connection->filter_list);
1091 _dbus_list_foreach (&connection->outgoing_messages,
1092 free_outgoing_message,
1094 _dbus_list_clear (&connection->outgoing_messages);
1096 _dbus_list_foreach (&connection->incoming_messages,
1097 (DBusForeachFunction) dbus_message_unref,
1099 _dbus_list_clear (&connection->incoming_messages);
1101 _dbus_counter_unref (connection->outgoing_counter);
1103 _dbus_transport_unref (connection->transport);
1105 if (connection->disconnect_message_link)
1107 DBusMessage *message = connection->disconnect_message_link->data;
1108 dbus_message_unref (message);
1109 _dbus_list_free_link (connection->disconnect_message_link);
1112 _dbus_list_clear (&connection->link_cache);
1114 dbus_condvar_free (connection->dispatch_cond);
1115 dbus_condvar_free (connection->io_path_cond);
1116 dbus_condvar_free (connection->message_returned_cond);
1118 dbus_mutex_free (connection->mutex);
1120 dbus_free (connection);
1124 * Decrements the reference count of a DBusConnection, and finalizes
1125 * it if the count reaches zero. It is a bug to drop the last reference
1126 * to a connection that has not been disconnected.
1128 * @todo in practice it can be quite tricky to never unref a connection
1129 * that's still connected; maybe there's some way we could avoid
1132 * @param connection the connection.
1135 dbus_connection_unref (DBusConnection *connection)
1137 dbus_bool_t last_unref;
1139 _dbus_return_if_fail (connection != NULL);
1141 /* The connection lock is better than the global
1142 * lock in the atomic increment fallback
1145 #ifdef DBUS_HAVE_ATOMIC_INT
1146 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1148 CONNECTION_LOCK (connection);
1150 _dbus_assert (connection->refcount.value > 0);
1152 connection->refcount.value -= 1;
1153 last_unref = (connection->refcount.value == 0);
1156 printf ("unref() connection %p count = %d\n", connection, connection->refcount.value);
1159 CONNECTION_UNLOCK (connection);
1163 _dbus_connection_last_unref (connection);
1167 * Closes the connection, so no further data can be sent or received.
1168 * Any further attempts to send data will result in errors. This
1169 * function does not affect the connection's reference count. It's
1170 * safe to disconnect a connection more than once; all calls after the
1171 * first do nothing. It's impossible to "reconnect" a connection, a
1172 * new connection must be created.
1174 * @param connection the connection.
1177 dbus_connection_disconnect (DBusConnection *connection)
1179 _dbus_return_if_fail (connection != NULL);
1181 CONNECTION_LOCK (connection);
1182 _dbus_transport_disconnect (connection->transport);
1183 CONNECTION_UNLOCK (connection);
1187 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
1189 return _dbus_transport_get_is_connected (connection->transport);
1193 * Gets whether the connection is currently connected. All
1194 * connections are connected when they are opened. A connection may
1195 * become disconnected when the remote application closes its end, or
1196 * exits; a connection may also be disconnected with
1197 * dbus_connection_disconnect().
1199 * @param connection the connection.
1200 * @returns #TRUE if the connection is still alive.
1203 dbus_connection_get_is_connected (DBusConnection *connection)
1207 _dbus_return_val_if_fail (connection != NULL, FALSE);
1209 CONNECTION_LOCK (connection);
1210 res = _dbus_connection_get_is_connected_unlocked (connection);
1211 CONNECTION_UNLOCK (connection);
1217 * Gets whether the connection was authenticated. (Note that
1218 * if the connection was authenticated then disconnected,
1219 * this function still returns #TRUE)
1221 * @param connection the connection
1222 * @returns #TRUE if the connection was ever authenticated
1225 dbus_connection_get_is_authenticated (DBusConnection *connection)
1229 _dbus_return_val_if_fail (connection != NULL, FALSE);
1231 CONNECTION_LOCK (connection);
1232 res = _dbus_transport_get_is_authenticated (connection->transport);
1233 CONNECTION_UNLOCK (connection);
1238 struct DBusPreallocatedSend
1240 DBusConnection *connection;
1241 DBusList *queue_link;
1242 DBusList *counter_link;
1245 static DBusPreallocatedSend*
1246 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1248 DBusPreallocatedSend *preallocated;
1250 _dbus_return_val_if_fail (connection != NULL, NULL);
1252 preallocated = dbus_new (DBusPreallocatedSend, 1);
1253 if (preallocated == NULL)
1256 if (connection->link_cache != NULL)
1258 preallocated->queue_link =
1259 _dbus_list_pop_first_link (&connection->link_cache);
1260 preallocated->queue_link->data = NULL;
1264 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1265 if (preallocated->queue_link == NULL)
1269 if (connection->link_cache != NULL)
1271 preallocated->counter_link =
1272 _dbus_list_pop_first_link (&connection->link_cache);
1273 preallocated->counter_link->data = connection->outgoing_counter;
1277 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1278 if (preallocated->counter_link == NULL)
1282 _dbus_counter_ref (preallocated->counter_link->data);
1284 preallocated->connection = connection;
1286 return preallocated;
1289 _dbus_list_free_link (preallocated->queue_link);
1291 dbus_free (preallocated);
1297 * Preallocates resources needed to send a message, allowing the message
1298 * to be sent without the possibility of memory allocation failure.
1299 * Allows apps to create a future guarantee that they can send
1300 * a message regardless of memory shortages.
1302 * @param connection the connection we're preallocating for.
1303 * @returns the preallocated resources, or #NULL
1305 DBusPreallocatedSend*
1306 dbus_connection_preallocate_send (DBusConnection *connection)
1308 DBusPreallocatedSend *preallocated;
1310 _dbus_return_val_if_fail (connection != NULL, NULL);
1312 CONNECTION_LOCK (connection);
1315 _dbus_connection_preallocate_send_unlocked (connection);
1317 CONNECTION_UNLOCK (connection);
1319 return preallocated;
1323 * Frees preallocated message-sending resources from
1324 * dbus_connection_preallocate_send(). Should only
1325 * be called if the preallocated resources are not used
1326 * to send a message.
1328 * @param connection the connection
1329 * @param preallocated the resources
1332 dbus_connection_free_preallocated_send (DBusConnection *connection,
1333 DBusPreallocatedSend *preallocated)
1335 _dbus_return_if_fail (connection != NULL);
1336 _dbus_return_if_fail (preallocated != NULL);
1337 _dbus_return_if_fail (connection == preallocated->connection);
1339 _dbus_list_free_link (preallocated->queue_link);
1340 _dbus_counter_unref (preallocated->counter_link->data);
1341 _dbus_list_free_link (preallocated->counter_link);
1342 dbus_free (preallocated);
1346 _dbus_connection_send_preallocated_unlocked (DBusConnection *connection,
1347 DBusPreallocatedSend *preallocated,
1348 DBusMessage *message,
1349 dbus_uint32_t *client_serial)
1351 dbus_uint32_t serial;
1353 preallocated->queue_link->data = message;
1354 _dbus_list_prepend_link (&connection->outgoing_messages,
1355 preallocated->queue_link);
1357 _dbus_message_add_size_counter_link (message,
1358 preallocated->counter_link);
1360 dbus_free (preallocated);
1361 preallocated = NULL;
1363 dbus_message_ref (message);
1365 connection->n_outgoing += 1;
1367 _dbus_verbose ("Message %p (%s) added to outgoing queue %p, %d pending to send\n",
1369 dbus_message_get_name (message),
1371 connection->n_outgoing);
1373 if (dbus_message_get_serial (message) == 0)
1375 serial = _dbus_connection_get_next_client_serial (connection);
1376 _dbus_message_set_serial (message, serial);
1378 *client_serial = serial;
1383 *client_serial = dbus_message_get_serial (message);
1386 _dbus_message_lock (message);
1388 if (connection->n_outgoing == 1)
1389 _dbus_transport_messages_pending (connection->transport,
1390 connection->n_outgoing);
1392 _dbus_connection_wakeup_mainloop (connection);
1396 * Sends a message using preallocated resources. This function cannot fail.
1397 * It works identically to dbus_connection_send() in other respects.
1398 * Preallocated resources comes from dbus_connection_preallocate_send().
1399 * This function "consumes" the preallocated resources, they need not
1400 * be freed separately.
1402 * @param connection the connection
1403 * @param preallocated the preallocated resources
1404 * @param message the message to send
1405 * @param client_serial return location for client serial assigned to the message
1408 dbus_connection_send_preallocated (DBusConnection *connection,
1409 DBusPreallocatedSend *preallocated,
1410 DBusMessage *message,
1411 dbus_uint32_t *client_serial)
1413 _dbus_return_if_fail (connection != NULL);
1414 _dbus_return_if_fail (preallocated != NULL);
1415 _dbus_return_if_fail (message != NULL);
1416 _dbus_return_if_fail (preallocated->connection == connection);
1417 _dbus_return_if_fail (dbus_message_get_name (message) != NULL);
1419 CONNECTION_LOCK (connection);
1420 _dbus_connection_send_preallocated_unlocked (connection,
1422 message, client_serial);
1423 CONNECTION_UNLOCK (connection);
1427 * Adds a message to the outgoing message queue. Does not block to
1428 * write the message to the network; that happens asynchronously. To
1429 * force the message to be written, call dbus_connection_flush().
1430 * Because this only queues the message, the only reason it can
1431 * fail is lack of memory. Even if the connection is disconnected,
1432 * no error will be returned.
1434 * If the function fails due to lack of memory, it returns #FALSE.
1435 * The function will never fail for other reasons; even if the
1436 * connection is disconnected, you can queue an outgoing message,
1437 * though obviously it won't be sent.
1439 * @param connection the connection.
1440 * @param message the message to write.
1441 * @param client_serial return location for client serial.
1442 * @returns #TRUE on success.
1445 dbus_connection_send (DBusConnection *connection,
1446 DBusMessage *message,
1447 dbus_uint32_t *client_serial)
1449 DBusPreallocatedSend *preallocated;
1451 _dbus_return_val_if_fail (connection != NULL, FALSE);
1452 _dbus_return_val_if_fail (message != NULL, FALSE);
1454 CONNECTION_LOCK (connection);
1456 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
1457 if (preallocated == NULL)
1459 CONNECTION_UNLOCK (connection);
1464 _dbus_connection_send_preallocated_unlocked (connection,
1468 CONNECTION_UNLOCK (connection);
1474 reply_handler_timeout (void *data)
1476 DBusConnection *connection;
1477 ReplyHandlerData *reply_handler_data = data;
1478 DBusDispatchStatus status;
1480 connection = reply_handler_data->connection;
1482 CONNECTION_LOCK (connection);
1483 if (reply_handler_data->timeout_link)
1485 _dbus_connection_queue_synthesized_message_link (connection,
1486 reply_handler_data->timeout_link);
1487 reply_handler_data->timeout_link = NULL;
1490 _dbus_connection_remove_timeout (connection,
1491 reply_handler_data->timeout);
1492 reply_handler_data->timeout_added = FALSE;
1494 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1496 /* Unlocks, and calls out to user code */
1497 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1503 reply_handler_data_free (ReplyHandlerData *data)
1508 if (data->timeout_added)
1509 _dbus_connection_remove_timeout_locked (data->connection,
1512 if (data->connection_added)
1513 _dbus_message_handler_remove_connection (data->handler,
1516 if (data->timeout_link)
1518 dbus_message_unref ((DBusMessage *)data->timeout_link->data);
1519 _dbus_list_free_link (data->timeout_link);
1522 dbus_message_handler_unref (data->handler);
1528 * Queues a message to send, as with dbus_connection_send_message(),
1529 * but also sets up a DBusMessageHandler to receive a reply to the
1530 * message. If no reply is received in the given timeout_milliseconds,
1531 * expires the pending reply and sends the DBusMessageHandler a
1532 * synthetic error reply (generated in-process, not by the remote
1533 * application) indicating that a timeout occurred.
1535 * Reply handlers see their replies after message filters see them,
1536 * but before message handlers added with
1537 * dbus_connection_register_handler() see them, regardless of the
1538 * reply message's name. Reply handlers are only handed a single
1539 * message as a reply, after one reply has been seen the handler is
1540 * removed. If a filter filters out the reply before the handler sees
1541 * it, the reply is immediately timed out and a timeout error reply is
1542 * generated. If a filter removes the timeout error reply then the
1543 * reply handler will never be called. Filters should not do this.
1545 * If #NULL is passed for the reply_handler, the timeout reply will
1546 * still be generated and placed into the message queue, but no
1547 * specific message handler will receive the reply.
1549 * If -1 is passed for the timeout, a sane default timeout is used. -1
1550 * is typically the best value for the timeout for this reason, unless
1551 * you want a very short or very long timeout. There is no way to
1552 * avoid a timeout entirely, other than passing INT_MAX for the
1553 * timeout to postpone it indefinitely.
1555 * @param connection the connection
1556 * @param message the message to send
1557 * @param reply_handler message handler expecting the reply, or #NULL
1558 * @param timeout_milliseconds timeout in milliseconds or -1 for default
1559 * @returns #TRUE if the message is successfully queued, #FALSE if no memory.
1563 dbus_connection_send_with_reply (DBusConnection *connection,
1564 DBusMessage *message,
1565 DBusMessageHandler *reply_handler,
1566 int timeout_milliseconds)
1568 DBusTimeout *timeout;
1569 ReplyHandlerData *data;
1571 DBusList *reply_link;
1572 dbus_int32_t serial = -1;
1574 _dbus_return_val_if_fail (connection != NULL, FALSE);
1575 _dbus_return_val_if_fail (message != NULL, FALSE);
1576 _dbus_return_val_if_fail (reply_handler != NULL, FALSE);
1577 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
1579 if (timeout_milliseconds == -1)
1580 timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
1582 data = dbus_new0 (ReplyHandlerData, 1);
1587 timeout = _dbus_timeout_new (timeout_milliseconds, reply_handler_timeout,
1592 reply_handler_data_free (data);
1596 CONNECTION_LOCK (connection);
1599 if (!_dbus_connection_add_timeout (connection, timeout))
1601 reply_handler_data_free (data);
1602 _dbus_timeout_unref (timeout);
1603 CONNECTION_UNLOCK (connection);
1607 /* The connection now owns the reference to the timeout. */
1608 _dbus_timeout_unref (timeout);
1610 data->timeout_added = TRUE;
1611 data->timeout = timeout;
1612 data->connection = connection;
1614 if (!_dbus_message_handler_add_connection (reply_handler, connection))
1616 CONNECTION_UNLOCK (connection);
1617 reply_handler_data_free (data);
1620 data->connection_added = TRUE;
1622 /* Assign a serial to the message */
1623 if (dbus_message_get_serial (message) == 0)
1625 serial = _dbus_connection_get_next_client_serial (connection);
1626 _dbus_message_set_serial (message, serial);
1629 data->handler = reply_handler;
1630 data->serial = serial;
1632 dbus_message_handler_ref (reply_handler);
1634 reply = dbus_message_new_error_reply (message, DBUS_ERROR_NO_REPLY,
1635 "No reply within specified time");
1638 CONNECTION_UNLOCK (connection);
1639 reply_handler_data_free (data);
1643 reply_link = _dbus_list_alloc_link (reply);
1646 CONNECTION_UNLOCK (connection);
1647 dbus_message_unref (reply);
1648 reply_handler_data_free (data);
1652 data->timeout_link = reply_link;
1654 /* Insert the serial in the pending replies hash. */
1655 if (!_dbus_hash_table_insert_int (connection->pending_replies, serial, data))
1657 CONNECTION_UNLOCK (connection);
1658 reply_handler_data_free (data);
1662 CONNECTION_UNLOCK (connection);
1664 if (!dbus_connection_send (connection, message, NULL))
1666 /* This will free the handler data too */
1667 _dbus_hash_table_remove_int (connection->pending_replies, serial);
1676 check_for_reply_unlocked (DBusConnection *connection,
1677 dbus_uint32_t client_serial)
1681 link = _dbus_list_get_first_link (&connection->incoming_messages);
1683 while (link != NULL)
1685 DBusMessage *reply = link->data;
1687 if (dbus_message_get_reply_serial (reply) == client_serial)
1689 _dbus_list_remove_link (&connection->incoming_messages, link);
1690 connection->n_incoming -= 1;
1691 dbus_message_ref (reply);
1694 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
1701 * Sends a message and blocks a certain time period while waiting for a reply.
1702 * This function does not dispatch any message handlers until the main loop
1703 * has been reached. This function is used to do non-reentrant "method calls."
1704 * If a reply is received, it is returned, and removed from the incoming
1705 * message queue. If it is not received, #NULL is returned and the
1706 * error is set to #DBUS_ERROR_NO_REPLY. If something else goes
1707 * wrong, result is set to whatever is appropriate, such as
1708 * #DBUS_ERROR_NO_MEMORY or #DBUS_ERROR_DISCONNECTED.
1710 * @todo could use performance improvements (it keeps scanning
1711 * the whole message queue for example) and has thread issues,
1712 * see comments in source
1714 * @param connection the connection
1715 * @param message the message to send
1716 * @param timeout_milliseconds timeout in milliseconds or -1 for default
1717 * @param error return location for error message
1718 * @returns the message that is the reply or #NULL with an error code if the
1722 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
1723 DBusMessage *message,
1724 int timeout_milliseconds,
1727 dbus_uint32_t client_serial;
1728 long start_tv_sec, start_tv_usec;
1729 long end_tv_sec, end_tv_usec;
1730 long tv_sec, tv_usec;
1731 DBusDispatchStatus status;
1733 _dbus_return_val_if_fail (connection != NULL, NULL);
1734 _dbus_return_val_if_fail (message != NULL, NULL);
1735 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
1736 _dbus_return_val_if_error_is_set (error, NULL);
1738 if (timeout_milliseconds == -1)
1739 timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
1741 /* it would probably seem logical to pass in _DBUS_INT_MAX
1742 * for infinite timeout, but then math below would get
1743 * all overflow-prone, so smack that down.
1745 if (timeout_milliseconds > _DBUS_ONE_HOUR_IN_MILLISECONDS * 6)
1746 timeout_milliseconds = _DBUS_ONE_HOUR_IN_MILLISECONDS * 6;
1748 if (!dbus_connection_send (connection, message, &client_serial))
1750 _DBUS_SET_OOM (error);
1756 /* Flush message queue */
1757 dbus_connection_flush (connection);
1759 CONNECTION_LOCK (connection);
1761 _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
1762 end_tv_sec = start_tv_sec + timeout_milliseconds / 1000;
1763 end_tv_usec = start_tv_usec + (timeout_milliseconds % 1000) * 1000;
1764 end_tv_sec += end_tv_usec / _DBUS_USEC_PER_SECOND;
1765 end_tv_usec = end_tv_usec % _DBUS_USEC_PER_SECOND;
1767 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec to %ld sec %ld usec\n",
1768 timeout_milliseconds,
1770 start_tv_sec, start_tv_usec,
1771 end_tv_sec, end_tv_usec);
1773 /* Now we wait... */
1774 /* THREAD TODO: This is busted. What if a dispatch() or pop_message
1775 * gets the message before we do?
1777 /* always block at least once as we know we don't have the reply yet */
1778 _dbus_connection_do_iteration (connection,
1779 DBUS_ITERATION_DO_READING |
1780 DBUS_ITERATION_BLOCK,
1781 timeout_milliseconds);
1785 /* queue messages and get status */
1786 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1788 if (status == DBUS_DISPATCH_DATA_REMAINS)
1792 reply = check_for_reply_unlocked (connection, client_serial);
1795 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1797 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply %s\n",
1798 dbus_message_get_name (reply));
1800 /* Unlocks, and calls out to user code */
1801 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1807 _dbus_get_current_time (&tv_sec, &tv_usec);
1809 if (tv_sec < start_tv_sec)
1810 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
1811 else if (connection->disconnect_message_link == NULL)
1812 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
1813 else if (tv_sec < end_tv_sec ||
1814 (tv_sec == end_tv_sec && tv_usec < end_tv_usec))
1816 timeout_milliseconds = (end_tv_sec - tv_sec) * 1000 +
1817 (end_tv_usec - tv_usec) / 1000;
1818 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds);
1819 _dbus_assert (timeout_milliseconds >= 0);
1821 if (status == DBUS_DISPATCH_NEED_MEMORY)
1823 /* Try sleeping a bit, as we aren't sure we need to block for reading,
1824 * we may already have a reply in the buffer and just can't process
1827 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
1829 if (timeout_milliseconds < 100)
1830 ; /* just busy loop */
1831 else if (timeout_milliseconds <= 1000)
1832 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
1834 _dbus_sleep_milliseconds (1000);
1838 /* block again, we don't have the reply buffered yet. */
1839 _dbus_connection_do_iteration (connection,
1840 DBUS_ITERATION_DO_READING |
1841 DBUS_ITERATION_BLOCK,
1842 timeout_milliseconds);
1845 goto recheck_status;
1848 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %ld milliseconds and got no reply\n",
1849 (tv_sec - start_tv_sec) * 1000 + (tv_usec - start_tv_usec) / 1000);
1851 if (dbus_connection_get_is_connected (connection))
1852 dbus_set_error (error, DBUS_ERROR_NO_REPLY, "Message did not receive a reply");
1854 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Disconnected prior to receiving a reply");
1856 /* unlocks and calls out to user code */
1857 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1863 * Blocks until the outgoing message queue is empty.
1865 * @param connection the connection.
1868 dbus_connection_flush (DBusConnection *connection)
1870 /* We have to specify DBUS_ITERATION_DO_READING here because
1871 * otherwise we could have two apps deadlock if they are both doing
1872 * a flush(), and the kernel buffers fill up. This could change the
1875 DBusDispatchStatus status;
1877 _dbus_return_if_fail (connection != NULL);
1879 CONNECTION_LOCK (connection);
1880 while (connection->n_outgoing > 0 &&
1881 _dbus_connection_get_is_connected_unlocked (connection))
1882 _dbus_connection_do_iteration (connection,
1883 DBUS_ITERATION_DO_READING |
1884 DBUS_ITERATION_DO_WRITING |
1885 DBUS_ITERATION_BLOCK,
1888 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1890 /* Unlocks and calls out to user code */
1891 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1894 /* Call with mutex held. Will drop it while waiting and re-acquire
1898 _dbus_connection_wait_for_borrowed (DBusConnection *connection)
1900 _dbus_assert (connection->message_borrowed != NULL);
1902 while (connection->message_borrowed != NULL)
1903 dbus_condvar_wait (connection->message_returned_cond, connection->mutex);
1907 * Returns the first-received message from the incoming message queue,
1908 * leaving it in the queue. If the queue is empty, returns #NULL.
1910 * The caller does not own a reference to the returned message, and
1911 * must either return it using dbus_connection_return_message() or
1912 * keep it after calling dbus_connection_steal_borrowed_message(). No
1913 * one can get at the message while its borrowed, so return it as
1914 * quickly as possible and don't keep a reference to it after
1915 * returning it. If you need to keep the message, make a copy of it.
1917 * @param connection the connection.
1918 * @returns next message in the incoming queue.
1921 dbus_connection_borrow_message (DBusConnection *connection)
1923 DBusMessage *message;
1924 DBusDispatchStatus status;
1926 _dbus_return_val_if_fail (connection != NULL, NULL);
1928 /* this is called for the side effect that it queues
1929 * up any messages from the transport
1931 status = dbus_connection_get_dispatch_status (connection);
1932 if (status != DBUS_DISPATCH_DATA_REMAINS)
1935 CONNECTION_LOCK (connection);
1937 if (connection->message_borrowed != NULL)
1938 _dbus_connection_wait_for_borrowed (connection);
1940 message = _dbus_list_get_first (&connection->incoming_messages);
1943 connection->message_borrowed = message;
1945 CONNECTION_UNLOCK (connection);
1950 * Used to return a message after peeking at it using
1951 * dbus_connection_borrow_message().
1953 * @param connection the connection
1954 * @param message the message from dbus_connection_borrow_message()
1957 dbus_connection_return_message (DBusConnection *connection,
1958 DBusMessage *message)
1960 _dbus_return_if_fail (connection != NULL);
1961 _dbus_return_if_fail (message != NULL);
1963 CONNECTION_LOCK (connection);
1965 _dbus_assert (message == connection->message_borrowed);
1967 connection->message_borrowed = NULL;
1968 dbus_condvar_wake_all (connection->message_returned_cond);
1970 CONNECTION_UNLOCK (connection);
1974 * Used to keep a message after peeking at it using
1975 * dbus_connection_borrow_message(). Before using this function, see
1976 * the caveats/warnings in the documentation for
1977 * dbus_connection_pop_message().
1979 * @param connection the connection
1980 * @param message the message from dbus_connection_borrow_message()
1983 dbus_connection_steal_borrowed_message (DBusConnection *connection,
1984 DBusMessage *message)
1986 DBusMessage *pop_message;
1988 _dbus_return_if_fail (connection != NULL);
1989 _dbus_return_if_fail (message != NULL);
1991 CONNECTION_LOCK (connection);
1993 _dbus_assert (message == connection->message_borrowed);
1995 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
1996 _dbus_assert (message == pop_message);
1998 connection->n_incoming -= 1;
2000 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
2001 message, connection->n_incoming);
2003 connection->message_borrowed = NULL;
2004 dbus_condvar_wake_all (connection->message_returned_cond);
2006 CONNECTION_UNLOCK (connection);
2009 /* See dbus_connection_pop_message, but requires the caller to own
2010 * the lock before calling. May drop the lock while running.
2013 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
2015 if (connection->message_borrowed != NULL)
2016 _dbus_connection_wait_for_borrowed (connection);
2018 if (connection->n_incoming > 0)
2022 link = _dbus_list_pop_first_link (&connection->incoming_messages);
2023 connection->n_incoming -= 1;
2025 _dbus_verbose ("Message %p (%s) removed from incoming queue %p, %d incoming\n",
2026 link->data, dbus_message_get_name (link->data),
2027 connection, connection->n_incoming);
2035 /* See dbus_connection_pop_message, but requires the caller to own
2036 * the lock before calling. May drop the lock while running.
2039 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
2043 link = _dbus_connection_pop_message_link_unlocked (connection);
2047 DBusMessage *message;
2049 message = link->data;
2051 _dbus_list_free_link (link);
2061 * Returns the first-received message from the incoming message queue,
2062 * removing it from the queue. The caller owns a reference to the
2063 * returned message. If the queue is empty, returns #NULL.
2065 * This function bypasses any message handlers that are registered,
2066 * and so using it is usually wrong. Instead, let the main loop invoke
2067 * dbus_connection_dispatch(). Popping messages manually is only
2068 * useful in very simple programs that don't share a #DBusConnection
2069 * with any libraries or other modules.
2071 * @param connection the connection.
2072 * @returns next message in the incoming queue.
2075 dbus_connection_pop_message (DBusConnection *connection)
2077 DBusMessage *message;
2078 DBusDispatchStatus status;
2080 /* this is called for the side effect that it queues
2081 * up any messages from the transport
2083 status = dbus_connection_get_dispatch_status (connection);
2084 if (status != DBUS_DISPATCH_DATA_REMAINS)
2087 CONNECTION_LOCK (connection);
2089 message = _dbus_connection_pop_message_unlocked (connection);
2091 _dbus_verbose ("Returning popped message %p\n", message);
2093 CONNECTION_UNLOCK (connection);
2099 * Acquire the dispatcher. This must be done before dispatching
2100 * messages in order to guarantee the right order of
2101 * message delivery. May sleep and drop the connection mutex
2102 * while waiting for the dispatcher.
2104 * @param connection the connection.
2107 _dbus_connection_acquire_dispatch (DBusConnection *connection)
2109 if (connection->dispatch_acquired)
2110 dbus_condvar_wait (connection->dispatch_cond, connection->mutex);
2111 _dbus_assert (!connection->dispatch_acquired);
2113 connection->dispatch_acquired = TRUE;
2117 * Release the dispatcher when you're done with it. Only call
2118 * after you've acquired the dispatcher. Wakes up at most one
2119 * thread currently waiting to acquire the dispatcher.
2121 * @param connection the connection.
2124 _dbus_connection_release_dispatch (DBusConnection *connection)
2126 _dbus_assert (connection->dispatch_acquired);
2128 connection->dispatch_acquired = FALSE;
2129 dbus_condvar_wake_one (connection->dispatch_cond);
2133 _dbus_connection_failed_pop (DBusConnection *connection,
2134 DBusList *message_link)
2136 _dbus_list_prepend_link (&connection->incoming_messages,
2138 connection->n_incoming += 1;
2141 static DBusDispatchStatus
2142 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
2144 if (connection->n_incoming > 0)
2145 return DBUS_DISPATCH_DATA_REMAINS;
2146 else if (!_dbus_transport_queue_messages (connection->transport))
2147 return DBUS_DISPATCH_NEED_MEMORY;
2150 DBusDispatchStatus status;
2152 status = _dbus_transport_get_dispatch_status (connection->transport);
2154 if (status != DBUS_DISPATCH_COMPLETE)
2156 else if (connection->n_incoming > 0)
2157 return DBUS_DISPATCH_DATA_REMAINS;
2159 return DBUS_DISPATCH_COMPLETE;
2164 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
2165 DBusDispatchStatus new_status)
2167 dbus_bool_t changed;
2168 DBusDispatchStatusFunction function;
2171 /* We have the lock */
2173 _dbus_connection_ref_unlocked (connection);
2175 changed = new_status != connection->last_dispatch_status;
2177 connection->last_dispatch_status = new_status;
2179 function = connection->dispatch_status_function;
2180 data = connection->dispatch_status_data;
2182 /* We drop the lock */
2183 CONNECTION_UNLOCK (connection);
2185 if (changed && function)
2187 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
2188 connection, new_status,
2189 new_status == DBUS_DISPATCH_COMPLETE ? "complete" :
2190 new_status == DBUS_DISPATCH_DATA_REMAINS ? "data remains" :
2191 new_status == DBUS_DISPATCH_NEED_MEMORY ? "need memory" :
2193 (* function) (connection, new_status, data);
2196 dbus_connection_unref (connection);
2200 * Gets the current state (what we would currently return
2201 * from dbus_connection_dispatch()) but doesn't actually
2202 * dispatch any messages.
2204 * @param connection the connection.
2205 * @returns current dispatch status
2208 dbus_connection_get_dispatch_status (DBusConnection *connection)
2210 DBusDispatchStatus status;
2212 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
2214 CONNECTION_LOCK (connection);
2216 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2218 CONNECTION_UNLOCK (connection);
2224 * Processes data buffered while handling watches, queueing zero or
2225 * more incoming messages. Then pops the first-received message from
2226 * the current incoming message queue, runs any handlers for it, and
2227 * unrefs the message. Returns a status indicating whether messages/data
2228 * remain, more memory is needed, or all data has been processed.
2230 * Even if the dispatch status is #DBUS_DISPATCH_DATA_REMAINS,
2231 * does not necessarily dispatch a message, as the data may
2232 * be part of authentication or the like.
2234 * @param connection the connection
2235 * @returns dispatch status
2238 dbus_connection_dispatch (DBusConnection *connection)
2240 DBusMessageHandler *handler;
2241 DBusMessage *message;
2242 DBusList *link, *filter_list_copy, *message_link;
2243 DBusHandlerResult result;
2244 ReplyHandlerData *reply_handler_data;
2246 dbus_int32_t reply_serial;
2247 DBusDispatchStatus status;
2249 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
2251 CONNECTION_LOCK (connection);
2252 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2253 if (status != DBUS_DISPATCH_DATA_REMAINS)
2255 /* unlocks and calls out to user code */
2256 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2260 /* We need to ref the connection since the callback could potentially
2261 * drop the last ref to it
2263 _dbus_connection_ref_unlocked (connection);
2265 _dbus_connection_acquire_dispatch (connection);
2267 /* This call may drop the lock during the execution (if waiting for
2268 * borrowed messages to be returned) but the order of message
2269 * dispatch if several threads call dispatch() is still
2270 * protected by the lock, since only one will get the lock, and that
2271 * one will finish the message dispatching
2273 message_link = _dbus_connection_pop_message_link_unlocked (connection);
2274 if (message_link == NULL)
2276 /* another thread dispatched our stuff */
2278 _dbus_connection_release_dispatch (connection);
2280 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2282 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2284 dbus_connection_unref (connection);
2289 message = message_link->data;
2291 result = DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
2293 reply_serial = dbus_message_get_reply_serial (message);
2294 reply_handler_data = _dbus_hash_table_lookup_int (connection->pending_replies,
2297 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
2299 _dbus_connection_release_dispatch (connection);
2301 _dbus_connection_failed_pop (connection, message_link);
2303 /* unlocks and calls user code */
2304 _dbus_connection_update_dispatch_status_and_unlock (connection,
2305 DBUS_DISPATCH_NEED_MEMORY);
2307 dbus_connection_unref (connection);
2309 return DBUS_DISPATCH_NEED_MEMORY;
2312 _dbus_list_foreach (&filter_list_copy,
2313 (DBusForeachFunction)dbus_message_handler_ref,
2316 /* We're still protected from dispatch() reentrancy here
2317 * since we acquired the dispatcher
2319 CONNECTION_UNLOCK (connection);
2321 link = _dbus_list_get_first_link (&filter_list_copy);
2322 while (link != NULL)
2324 DBusMessageHandler *handler = link->data;
2325 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
2327 _dbus_verbose (" running filter on message %p\n", message);
2328 result = _dbus_message_handler_handle_message (handler, connection,
2331 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2337 _dbus_list_foreach (&filter_list_copy,
2338 (DBusForeachFunction)dbus_message_handler_unref,
2340 _dbus_list_clear (&filter_list_copy);
2342 CONNECTION_LOCK (connection);
2344 /* Did a reply we were waiting on get filtered? */
2345 if (reply_handler_data && result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2347 /* Queue the timeout immediately! */
2348 if (reply_handler_data->timeout_link)
2350 _dbus_connection_queue_synthesized_message_link (connection,
2351 reply_handler_data->timeout_link);
2352 reply_handler_data->timeout_link = NULL;
2356 /* We already queued the timeout? Then it was filtered! */
2357 _dbus_warn ("The timeout error with reply serial %d was filtered, so the reply handler will never be called.\n", reply_serial);
2361 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2364 if (reply_handler_data)
2366 CONNECTION_UNLOCK (connection);
2368 _dbus_verbose (" running reply handler on message %p\n", message);
2370 result = _dbus_message_handler_handle_message (reply_handler_data->handler,
2371 connection, message);
2372 reply_handler_data_free (reply_handler_data);
2373 CONNECTION_LOCK (connection);
2377 name = dbus_message_get_name (message);
2380 handler = _dbus_hash_table_lookup_string (connection->handler_table,
2382 if (handler != NULL)
2384 /* We're still protected from dispatch() reentrancy here
2385 * since we acquired the dispatcher
2387 CONNECTION_UNLOCK (connection);
2389 _dbus_verbose (" running app handler on message %p (%s)\n",
2390 message, dbus_message_get_name (message));
2392 result = _dbus_message_handler_handle_message (handler, connection,
2394 CONNECTION_LOCK (connection);
2395 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2400 _dbus_verbose (" done dispatching %p (%s) on connection %p\n", message,
2401 dbus_message_get_name (message), connection);
2404 _dbus_connection_release_dispatch (connection);
2406 _dbus_list_free_link (message_link);
2407 dbus_message_unref (message); /* don't want the message to count in max message limits
2408 * in computing dispatch status
2411 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2413 /* unlocks and calls user code */
2414 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2416 dbus_connection_unref (connection);
2422 * Sets the watch functions for the connection. These functions are
2423 * responsible for making the application's main loop aware of file
2424 * descriptors that need to be monitored for events, using select() or
2425 * poll(). When using Qt, typically the DBusAddWatchFunction would
2426 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
2427 * could call g_io_add_watch(), or could be used as part of a more
2428 * elaborate GSource. Note that when a watch is added, it may
2431 * The DBusWatchToggledFunction notifies the application that the
2432 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
2433 * to check this. A disabled watch should have no effect, and enabled
2434 * watch should be added to the main loop. This feature is used
2435 * instead of simply adding/removing the watch because
2436 * enabling/disabling can be done without memory allocation. The
2437 * toggled function may be NULL if a main loop re-queries
2438 * dbus_watch_get_enabled() every time anyway.
2440 * The DBusWatch can be queried for the file descriptor to watch using
2441 * dbus_watch_get_fd(), and for the events to watch for using
2442 * dbus_watch_get_flags(). The flags returned by
2443 * dbus_watch_get_flags() will only contain DBUS_WATCH_READABLE and
2444 * DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR;
2445 * all watches implicitly include a watch for hangups, errors, and
2446 * other exceptional conditions.
2448 * Once a file descriptor becomes readable or writable, or an exception
2449 * occurs, dbus_watch_handle() should be called to
2450 * notify the connection of the file descriptor's condition.
2452 * dbus_watch_handle() cannot be called during the
2453 * DBusAddWatchFunction, as the connection will not be ready to handle
2456 * It is not allowed to reference a DBusWatch after it has been passed
2457 * to remove_function.
2459 * If #FALSE is returned due to lack of memory, the failure may be due
2460 * to a #FALSE return from the new add_function. If so, the
2461 * add_function may have been called successfully one or more times,
2462 * but the remove_function will also have been called to remove any
2463 * successful adds. i.e. if #FALSE is returned the net result
2464 * should be that dbus_connection_set_watch_functions() has no effect,
2465 * but the add_function and remove_function may have been called.
2467 * @todo We need to drop the lock when we call the
2468 * add/remove/toggled functions which can be a side effect
2469 * of setting the watch functions.
2471 * @param connection the connection.
2472 * @param add_function function to begin monitoring a new descriptor.
2473 * @param remove_function function to stop monitoring a descriptor.
2474 * @param toggled_function function to notify of enable/disable
2475 * @param data data to pass to add_function and remove_function.
2476 * @param free_data_function function to be called to free the data.
2477 * @returns #FALSE on failure (no memory)
2480 dbus_connection_set_watch_functions (DBusConnection *connection,
2481 DBusAddWatchFunction add_function,
2482 DBusRemoveWatchFunction remove_function,
2483 DBusWatchToggledFunction toggled_function,
2485 DBusFreeFunction free_data_function)
2489 _dbus_return_val_if_fail (connection != NULL, FALSE);
2491 CONNECTION_LOCK (connection);
2492 /* ref connection for slightly better reentrancy */
2493 _dbus_connection_ref_unlocked (connection);
2495 /* FIXME this can call back into user code, and we need to drop the
2496 * connection lock when it does.
2498 retval = _dbus_watch_list_set_functions (connection->watches,
2499 add_function, remove_function,
2501 data, free_data_function);
2503 CONNECTION_UNLOCK (connection);
2504 /* drop our paranoid refcount */
2505 dbus_connection_unref (connection);
2511 * Sets the timeout functions for the connection. These functions are
2512 * responsible for making the application's main loop aware of timeouts.
2513 * When using Qt, typically the DBusAddTimeoutFunction would create a
2514 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
2517 * The DBusTimeoutToggledFunction notifies the application that the
2518 * timeout has been enabled or disabled. Call
2519 * dbus_timeout_get_enabled() to check this. A disabled timeout should
2520 * have no effect, and enabled timeout should be added to the main
2521 * loop. This feature is used instead of simply adding/removing the
2522 * timeout because enabling/disabling can be done without memory
2523 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
2524 * to enable and disable. The toggled function may be NULL if a main
2525 * loop re-queries dbus_timeout_get_enabled() every time anyway.
2526 * Whenever a timeout is toggled, its interval may change.
2528 * The DBusTimeout can be queried for the timer interval using
2529 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
2530 * repeatedly, each time the interval elapses, starting after it has
2531 * elapsed once. The timeout stops firing when it is removed with the
2532 * given remove_function. The timer interval may change whenever the
2533 * timeout is added, removed, or toggled.
2535 * @param connection the connection.
2536 * @param add_function function to add a timeout.
2537 * @param remove_function function to remove a timeout.
2538 * @param toggled_function function to notify of enable/disable
2539 * @param data data to pass to add_function and remove_function.
2540 * @param free_data_function function to be called to free the data.
2541 * @returns #FALSE on failure (no memory)
2544 dbus_connection_set_timeout_functions (DBusConnection *connection,
2545 DBusAddTimeoutFunction add_function,
2546 DBusRemoveTimeoutFunction remove_function,
2547 DBusTimeoutToggledFunction toggled_function,
2549 DBusFreeFunction free_data_function)
2553 _dbus_return_val_if_fail (connection != NULL, FALSE);
2555 CONNECTION_LOCK (connection);
2556 /* ref connection for slightly better reentrancy */
2557 _dbus_connection_ref_unlocked (connection);
2559 retval = _dbus_timeout_list_set_functions (connection->timeouts,
2560 add_function, remove_function,
2562 data, free_data_function);
2564 CONNECTION_UNLOCK (connection);
2565 /* drop our paranoid refcount */
2566 dbus_connection_unref (connection);
2572 * Sets the mainloop wakeup function for the connection. Thi function is
2573 * responsible for waking up the main loop (if its sleeping) when some some
2574 * change has happened to the connection that the mainloop needs to reconsiders
2575 * (e.g. a message has been queued for writing).
2576 * When using Qt, this typically results in a call to QEventLoop::wakeUp().
2577 * When using GLib, it would call g_main_context_wakeup().
2580 * @param connection the connection.
2581 * @param wakeup_main_function function to wake up the mainloop
2582 * @param data data to pass wakeup_main_function
2583 * @param free_data_function function to be called to free the data.
2586 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
2587 DBusWakeupMainFunction wakeup_main_function,
2589 DBusFreeFunction free_data_function)
2592 DBusFreeFunction old_free_data;
2594 _dbus_return_if_fail (connection != NULL);
2596 CONNECTION_LOCK (connection);
2597 old_data = connection->wakeup_main_data;
2598 old_free_data = connection->free_wakeup_main_data;
2600 connection->wakeup_main_function = wakeup_main_function;
2601 connection->wakeup_main_data = data;
2602 connection->free_wakeup_main_data = free_data_function;
2604 CONNECTION_UNLOCK (connection);
2606 /* Callback outside the lock */
2608 (*old_free_data) (old_data);
2612 * Set a function to be invoked when the dispatch status changes.
2613 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
2614 * dbus_connection_dispatch() needs to be called to process incoming
2615 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
2616 * from inside the DBusDispatchStatusFunction. Indeed, almost
2617 * any reentrancy in this function is a bad idea. Instead,
2618 * the DBusDispatchStatusFunction should simply save an indication
2619 * that messages should be dispatched later, when the main loop
2622 * @param connection the connection
2623 * @param function function to call on dispatch status changes
2624 * @param data data for function
2625 * @param free_data_function free the function data
2628 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
2629 DBusDispatchStatusFunction function,
2631 DBusFreeFunction free_data_function)
2634 DBusFreeFunction old_free_data;
2636 _dbus_return_if_fail (connection != NULL);
2638 CONNECTION_LOCK (connection);
2639 old_data = connection->dispatch_status_data;
2640 old_free_data = connection->free_dispatch_status_data;
2642 connection->dispatch_status_function = function;
2643 connection->dispatch_status_data = data;
2644 connection->free_dispatch_status_data = free_data_function;
2646 CONNECTION_UNLOCK (connection);
2648 /* Callback outside the lock */
2650 (*old_free_data) (old_data);
2654 * Gets the UNIX user ID of the connection if any.
2655 * Returns #TRUE if the uid is filled in.
2656 * Always returns #FALSE on non-UNIX platforms.
2657 * Always returns #FALSE prior to authenticating the
2660 * @param connection the connection
2661 * @param uid return location for the user ID
2662 * @returns #TRUE if uid is filled in with a valid user ID
2665 dbus_connection_get_unix_user (DBusConnection *connection,
2670 _dbus_return_val_if_fail (connection != NULL, FALSE);
2671 _dbus_return_val_if_fail (uid != NULL, FALSE);
2673 CONNECTION_LOCK (connection);
2675 if (!_dbus_transport_get_is_authenticated (connection->transport))
2678 result = _dbus_transport_get_unix_user (connection->transport,
2680 CONNECTION_UNLOCK (connection);
2686 * Sets a predicate function used to determine whether a given user ID
2687 * is allowed to connect. When an incoming connection has
2688 * authenticated with a particular user ID, this function is called;
2689 * if it returns #TRUE, the connection is allowed to proceed,
2690 * otherwise the connection is disconnected.
2692 * If the function is set to #NULL (as it is by default), then
2693 * only the same UID as the server process will be allowed to
2696 * @param connection the connection
2697 * @param function the predicate
2698 * @param data data to pass to the predicate
2699 * @param free_data_function function to free the data
2702 dbus_connection_set_unix_user_function (DBusConnection *connection,
2703 DBusAllowUnixUserFunction function,
2705 DBusFreeFunction free_data_function)
2707 void *old_data = NULL;
2708 DBusFreeFunction old_free_function = NULL;
2710 _dbus_return_if_fail (connection != NULL);
2712 CONNECTION_LOCK (connection);
2713 _dbus_transport_set_unix_user_function (connection->transport,
2714 function, data, free_data_function,
2715 &old_data, &old_free_function);
2716 CONNECTION_UNLOCK (connection);
2718 if (old_free_function != NULL)
2719 (* old_free_function) (old_data);
2723 * Adds a message filter. Filters are handlers that are run on
2724 * all incoming messages, prior to the normal handlers
2725 * registered with dbus_connection_register_handler().
2726 * Filters are run in the order that they were added.
2727 * The same handler can be added as a filter more than once, in
2728 * which case it will be run more than once.
2729 * Filters added during a filter callback won't be run on the
2730 * message being processed.
2732 * The connection does NOT add a reference to the message handler;
2733 * instead, if the message handler is finalized, the connection simply
2734 * forgets about it. Thus the caller of this function must keep a
2735 * reference to the message handler.
2737 * @param connection the connection
2738 * @param handler the handler
2739 * @returns #TRUE on success, #FALSE if not enough memory.
2742 dbus_connection_add_filter (DBusConnection *connection,
2743 DBusMessageHandler *handler)
2745 _dbus_return_val_if_fail (connection != NULL, FALSE);
2746 _dbus_return_val_if_fail (handler != NULL, FALSE);
2748 CONNECTION_LOCK (connection);
2749 if (!_dbus_message_handler_add_connection (handler, connection))
2751 CONNECTION_UNLOCK (connection);
2755 if (!_dbus_list_append (&connection->filter_list,
2758 _dbus_message_handler_remove_connection (handler, connection);
2759 CONNECTION_UNLOCK (connection);
2763 CONNECTION_UNLOCK (connection);
2768 * Removes a previously-added message filter. It is a programming
2769 * error to call this function for a handler that has not
2770 * been added as a filter. If the given handler was added
2771 * more than once, only one instance of it will be removed
2772 * (the most recently-added instance).
2774 * @param connection the connection
2775 * @param handler the handler to remove
2779 dbus_connection_remove_filter (DBusConnection *connection,
2780 DBusMessageHandler *handler)
2782 _dbus_return_if_fail (connection != NULL);
2783 _dbus_return_if_fail (handler != NULL);
2785 CONNECTION_LOCK (connection);
2786 if (!_dbus_list_remove_last (&connection->filter_list, handler))
2788 _dbus_warn ("Tried to remove a DBusConnection filter that had not been added\n");
2789 CONNECTION_UNLOCK (connection);
2793 _dbus_message_handler_remove_connection (handler, connection);
2795 CONNECTION_UNLOCK (connection);
2799 * Registers a handler for a list of message names. A single handler
2800 * can be registered for any number of message names, but each message
2801 * name can only have one handler at a time. It's not allowed to call
2802 * this function with the name of a message that already has a
2803 * handler. If the function returns #FALSE, the handlers were not
2804 * registered due to lack of memory.
2806 * The connection does NOT add a reference to the message handler;
2807 * instead, if the message handler is finalized, the connection simply
2808 * forgets about it. Thus the caller of this function must keep a
2809 * reference to the message handler.
2811 * @todo the messages_to_handle arg may be more convenient if it's a
2812 * single string instead of an array. Though right now MessageHandler
2813 * is sort of designed to say be associated with an entire object with
2814 * multiple methods, that's why for example the connection only
2815 * weakrefs it. So maybe the "manual" API should be different.
2817 * @param connection the connection
2818 * @param handler the handler
2819 * @param messages_to_handle the messages to handle
2820 * @param n_messages the number of message names in messages_to_handle
2821 * @returns #TRUE on success, #FALSE if no memory or another handler already exists
2825 dbus_connection_register_handler (DBusConnection *connection,
2826 DBusMessageHandler *handler,
2827 const char **messages_to_handle,
2832 _dbus_return_val_if_fail (connection != NULL, FALSE);
2833 _dbus_return_val_if_fail (handler != NULL, FALSE);
2834 _dbus_return_val_if_fail (n_messages >= 0, FALSE);
2835 _dbus_return_val_if_fail (n_messages == 0 || messages_to_handle != NULL, FALSE);
2837 CONNECTION_LOCK (connection);
2839 while (i < n_messages)
2844 key = _dbus_strdup (messages_to_handle[i]);
2848 if (!_dbus_hash_iter_lookup (connection->handler_table,
2856 if (_dbus_hash_iter_get_value (&iter) != NULL)
2858 _dbus_warn ("Bug in application: attempted to register a second handler for %s\n",
2859 messages_to_handle[i]);
2860 dbus_free (key); /* won't have replaced the old key with the new one */
2864 if (!_dbus_message_handler_add_connection (handler, connection))
2866 _dbus_hash_iter_remove_entry (&iter);
2867 /* key has freed on nuking the entry */
2871 _dbus_hash_iter_set_value (&iter, handler);
2876 CONNECTION_UNLOCK (connection);
2880 /* unregister everything registered so far,
2881 * so we don't fail partially
2883 dbus_connection_unregister_handler (connection,
2888 CONNECTION_UNLOCK (connection);
2893 * Unregisters a handler for a list of message names. The handlers
2894 * must have been previously registered.
2896 * @param connection the connection
2897 * @param handler the handler
2898 * @param messages_to_handle the messages to handle
2899 * @param n_messages the number of message names in messages_to_handle
2903 dbus_connection_unregister_handler (DBusConnection *connection,
2904 DBusMessageHandler *handler,
2905 const char **messages_to_handle,
2910 _dbus_return_if_fail (connection != NULL);
2911 _dbus_return_if_fail (handler != NULL);
2912 _dbus_return_if_fail (n_messages >= 0);
2913 _dbus_return_if_fail (n_messages == 0 || messages_to_handle != NULL);
2915 CONNECTION_LOCK (connection);
2917 while (i < n_messages)
2921 if (!_dbus_hash_iter_lookup (connection->handler_table,
2922 (char*) messages_to_handle[i], FALSE,
2925 _dbus_warn ("Bug in application: attempted to unregister handler for %s which was not registered\n",
2926 messages_to_handle[i]);
2928 else if (_dbus_hash_iter_get_value (&iter) != handler)
2930 _dbus_warn ("Bug in application: attempted to unregister handler for %s which was registered by a different handler\n",
2931 messages_to_handle[i]);
2935 _dbus_hash_iter_remove_entry (&iter);
2936 _dbus_message_handler_remove_connection (handler, connection);
2942 CONNECTION_UNLOCK (connection);
2945 static DBusDataSlotAllocator slot_allocator;
2946 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
2949 * Allocates an integer ID to be used for storing application-specific
2950 * data on any DBusConnection. The allocated ID may then be used
2951 * with dbus_connection_set_data() and dbus_connection_get_data().
2952 * The passed-in slot must be initialized to -1, and is filled in
2953 * with the slot ID. If the passed-in slot is not -1, it's assumed
2954 * to be already allocated, and its refcount is incremented.
2956 * The allocated slot is global, i.e. all DBusConnection objects will
2957 * have a slot with the given integer ID reserved.
2959 * @param slot_p address of a global variable storing the slot
2960 * @returns #FALSE on failure (no memory)
2963 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
2965 return _dbus_data_slot_allocator_alloc (&slot_allocator,
2966 _DBUS_LOCK_NAME (connection_slots),
2971 * Deallocates a global ID for connection data slots.
2972 * dbus_connection_get_data() and dbus_connection_set_data() may no
2973 * longer be used with this slot. Existing data stored on existing
2974 * DBusConnection objects will be freed when the connection is
2975 * finalized, but may not be retrieved (and may only be replaced if
2976 * someone else reallocates the slot). When the refcount on the
2977 * passed-in slot reaches 0, it is set to -1.
2979 * @param slot_p address storing the slot to deallocate
2982 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
2984 _dbus_return_if_fail (*slot_p >= 0);
2986 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
2990 * Stores a pointer on a DBusConnection, along
2991 * with an optional function to be used for freeing
2992 * the data when the data is set again, or when
2993 * the connection is finalized. The slot number
2994 * must have been allocated with dbus_connection_allocate_data_slot().
2996 * @param connection the connection
2997 * @param slot the slot number
2998 * @param data the data to store
2999 * @param free_data_func finalizer function for the data
3000 * @returns #TRUE if there was enough memory to store the data
3003 dbus_connection_set_data (DBusConnection *connection,
3006 DBusFreeFunction free_data_func)
3008 DBusFreeFunction old_free_func;
3012 _dbus_return_val_if_fail (connection != NULL, FALSE);
3013 _dbus_return_val_if_fail (slot >= 0, FALSE);
3015 CONNECTION_LOCK (connection);
3017 retval = _dbus_data_slot_list_set (&slot_allocator,
3018 &connection->slot_list,
3019 slot, data, free_data_func,
3020 &old_free_func, &old_data);
3022 CONNECTION_UNLOCK (connection);
3026 /* Do the actual free outside the connection lock */
3028 (* old_free_func) (old_data);
3035 * Retrieves data previously set with dbus_connection_set_data().
3036 * The slot must still be allocated (must not have been freed).
3038 * @param connection the connection
3039 * @param slot the slot to get data from
3040 * @returns the data, or #NULL if not found
3043 dbus_connection_get_data (DBusConnection *connection,
3048 _dbus_return_val_if_fail (connection != NULL, NULL);
3050 CONNECTION_LOCK (connection);
3052 res = _dbus_data_slot_list_get (&slot_allocator,
3053 &connection->slot_list,
3056 CONNECTION_UNLOCK (connection);
3062 * This function sets a global flag for whether dbus_connection_new()
3063 * will set SIGPIPE behavior to SIG_IGN.
3065 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
3068 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
3070 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
3074 * Specifies the maximum size message this connection is allowed to
3075 * receive. Larger messages will result in disconnecting the
3078 * @param connection a #DBusConnection
3079 * @param size maximum message size the connection can receive, in bytes
3082 dbus_connection_set_max_message_size (DBusConnection *connection,
3085 _dbus_return_if_fail (connection != NULL);
3087 CONNECTION_LOCK (connection);
3088 _dbus_transport_set_max_message_size (connection->transport,
3090 CONNECTION_UNLOCK (connection);
3094 * Gets the value set by dbus_connection_set_max_message_size().
3096 * @param connection the connection
3097 * @returns the max size of a single message
3100 dbus_connection_get_max_message_size (DBusConnection *connection)
3104 _dbus_return_val_if_fail (connection != NULL, 0);
3106 CONNECTION_LOCK (connection);
3107 res = _dbus_transport_get_max_message_size (connection->transport);
3108 CONNECTION_UNLOCK (connection);
3113 * Sets the maximum total number of bytes that can be used for all messages
3114 * received on this connection. Messages count toward the maximum until
3115 * they are finalized. When the maximum is reached, the connection will
3116 * not read more data until some messages are finalized.
3118 * The semantics of the maximum are: if outstanding messages are
3119 * already above the maximum, additional messages will not be read.
3120 * The semantics are not: if the next message would cause us to exceed
3121 * the maximum, we don't read it. The reason is that we don't know the
3122 * size of a message until after we read it.
3124 * Thus, the max live messages size can actually be exceeded
3125 * by up to the maximum size of a single message.
3127 * Also, if we read say 1024 bytes off the wire in a single read(),
3128 * and that contains a half-dozen small messages, we may exceed the
3129 * size max by that amount. But this should be inconsequential.
3131 * This does imply that we can't call read() with a buffer larger
3132 * than we're willing to exceed this limit by.
3134 * @param connection the connection
3135 * @param size the maximum size in bytes of all outstanding messages
3138 dbus_connection_set_max_received_size (DBusConnection *connection,
3141 _dbus_return_if_fail (connection != NULL);
3143 CONNECTION_LOCK (connection);
3144 _dbus_transport_set_max_received_size (connection->transport,
3146 CONNECTION_UNLOCK (connection);
3150 * Gets the value set by dbus_connection_set_max_received_size().
3152 * @param connection the connection
3153 * @returns the max size of all live messages
3156 dbus_connection_get_max_received_size (DBusConnection *connection)
3160 _dbus_return_val_if_fail (connection != NULL, 0);
3162 CONNECTION_LOCK (connection);
3163 res = _dbus_transport_get_max_received_size (connection->transport);
3164 CONNECTION_UNLOCK (connection);
3169 * Gets the approximate size in bytes of all messages in the outgoing
3170 * message queue. The size is approximate in that you shouldn't use
3171 * it to decide how many bytes to read off the network or anything
3172 * of that nature, as optimizations may choose to tell small white lies
3173 * to avoid performance overhead.
3175 * @param connection the connection
3176 * @returns the number of bytes that have been queued up but not sent
3179 dbus_connection_get_outgoing_size (DBusConnection *connection)
3183 _dbus_return_val_if_fail (connection != NULL, 0);
3185 CONNECTION_LOCK (connection);
3186 res = _dbus_counter_get_value (connection->outgoing_counter);
3187 CONNECTION_UNLOCK (connection);