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"
38 #include "dbus-object-registry.h"
41 #define CONNECTION_LOCK(connection) do { \
42 _dbus_verbose (" LOCK: %s\n", _DBUS_FUNCTION_NAME); \
43 dbus_mutex_lock ((connection)->mutex); \
45 #define CONNECTION_UNLOCK(connection) do { \
46 _dbus_verbose (" UNLOCK: %s\n", _DBUS_FUNCTION_NAME); \
47 dbus_mutex_unlock ((connection)->mutex); \
50 #define CONNECTION_LOCK(connection) dbus_mutex_lock ((connection)->mutex)
51 #define CONNECTION_UNLOCK(connection) dbus_mutex_unlock ((connection)->mutex)
55 * @defgroup DBusConnection DBusConnection
57 * @brief Connection to another application
59 * A DBusConnection represents a connection to another
60 * application. Messages can be sent and received via this connection.
61 * The other application may be a message bus; for convenience, the
62 * function dbus_bus_get() is provided to automatically open a
63 * connection to the well-known message buses.
65 * In brief a DBusConnection is a message queue associated with some
66 * message transport mechanism such as a socket. The connection
67 * maintains a queue of incoming messages and a queue of outgoing
70 * Incoming messages are normally processed by calling
71 * dbus_connection_dispatch(). dbus_connection_dispatch() runs any
72 * handlers registered for the topmost message in the message queue,
73 * then discards the message, then returns.
75 * dbus_connection_get_dispatch_status() indicates whether
76 * messages are currently in the queue that need dispatching.
77 * dbus_connection_set_dispatch_status_function() allows
78 * you to set a function to be used to monitor the dispatch status.
80 * If you're using GLib or Qt add-on libraries for D-BUS, there are
81 * special convenience APIs in those libraries that hide
82 * all the details of dispatch and watch/timeout monitoring.
83 * For example, dbus_connection_setup_with_g_main().
85 * If you aren't using these add-on libraries, you have to manually
86 * call dbus_connection_set_dispatch_status_function(),
87 * dbus_connection_set_watch_functions(),
88 * dbus_connection_set_timeout_functions() providing appropriate
89 * functions to integrate the connection with your application's main
92 * When you use dbus_connection_send() or one of its variants to send
93 * a message, the message is added to the outgoing queue. It's
94 * actually written to the network later; either in
95 * dbus_watch_handle() invoked by your main loop, or in
96 * dbus_connection_flush() which blocks until it can write out the
97 * entire outgoing queue. The GLib/Qt add-on libraries again
98 * handle the details here for you by setting up watch functions.
100 * When a connection is disconnected, you are guaranteed to get a
101 * message with the name #DBUS_MESSAGE_LOCAL_DISCONNECT.
103 * You may not drop the last reference to a #DBusConnection
104 * until that connection has been disconnected.
106 * You may dispatch the unprocessed incoming message queue even if the
107 * connection is disconnected. However, #DBUS_MESSAGE_LOCAL_DISCONNECT
108 * will always be the last message in the queue (obviously no messages
109 * are received after disconnection).
111 * #DBusConnection has thread locks and drops them when invoking user
112 * callbacks, so in general is transparently threadsafe. However,
113 * #DBusMessage does NOT have thread locks; you must not send the same
114 * message to multiple #DBusConnection that will be used from
119 * @defgroup DBusConnectionInternals DBusConnection implementation details
120 * @ingroup DBusInternals
121 * @brief Implementation details of DBusConnection
126 /** default timeout value when waiting for a message reply */
127 #define DEFAULT_TIMEOUT_VALUE (15 * 1000)
129 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
132 * Implementation details of DBusConnection. All fields are private.
134 struct DBusConnection
136 DBusAtomic refcount; /**< Reference count. */
138 DBusMutex *mutex; /**< Lock on the entire DBusConnection */
140 dbus_bool_t dispatch_acquired; /**< Protects dispatch() */
141 DBusCondVar *dispatch_cond; /**< Protects dispatch() */
143 dbus_bool_t io_path_acquired; /**< Protects transport io path */
144 DBusCondVar *io_path_cond; /**< Protects transport io path */
146 DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
147 DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
149 DBusMessage *message_borrowed; /**< True if the first incoming message has been borrowed */
150 DBusCondVar *message_returned_cond; /**< Used with dbus_connection_borrow_message() */
152 int n_outgoing; /**< Length of outgoing queue. */
153 int n_incoming; /**< Length of incoming queue. */
155 DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
157 DBusTransport *transport; /**< Object that sends/receives messages over network. */
158 DBusWatchList *watches; /**< Stores active watches. */
159 DBusTimeoutList *timeouts; /**< Stores active timeouts. */
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
183 DBusObjectRegistry *objects; /**< Objects registered with this connection */
188 DBusConnection *connection;
189 DBusMessageHandler *handler;
190 DBusTimeout *timeout;
193 DBusList *timeout_link; /* Preallocated timeout response */
195 dbus_bool_t timeout_added;
196 dbus_bool_t connection_added;
199 static void reply_handler_data_free (ReplyHandlerData *data);
201 static void _dbus_connection_remove_timeout_locked (DBusConnection *connection,
202 DBusTimeout *timeout);
203 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection);
204 static void _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
205 DBusDispatchStatus new_status);
210 * Acquires the connection lock.
212 * @param connection the connection.
215 _dbus_connection_lock (DBusConnection *connection)
217 CONNECTION_LOCK (connection);
221 * Releases the connection lock.
223 * @param connection the connection.
226 _dbus_connection_unlock (DBusConnection *connection)
228 CONNECTION_UNLOCK (connection);
232 * Wakes up the main loop if it is sleeping
233 * Needed if we're e.g. queueing outgoing messages
234 * on a thread while the mainloop sleeps.
236 * @param connection the connection.
239 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
241 if (connection->wakeup_main_function)
242 (*connection->wakeup_main_function) (connection->wakeup_main_data);
245 #ifdef DBUS_BUILD_TESTS
246 /* For now this function isn't used */
248 * Adds a message to the incoming message queue, returning #FALSE
249 * if there's insufficient memory to queue the message.
250 * Does not take over refcount of the message.
252 * @param connection the connection.
253 * @param message the message to queue.
254 * @returns #TRUE on success.
257 _dbus_connection_queue_received_message (DBusConnection *connection,
258 DBusMessage *message)
262 link = _dbus_list_alloc_link (message);
266 dbus_message_ref (message);
267 _dbus_connection_queue_received_message_link (connection, link);
274 * Adds a message-containing list link to the incoming message queue,
275 * taking ownership of the link and the message's current refcount.
276 * Cannot fail due to lack of memory.
278 * @param connection the connection.
279 * @param link the message link to queue.
282 _dbus_connection_queue_received_message_link (DBusConnection *connection,
285 ReplyHandlerData *reply_handler_data;
286 dbus_int32_t reply_serial;
287 DBusMessage *message;
289 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
291 _dbus_list_append_link (&connection->incoming_messages,
293 message = link->data;
295 /* If this is a reply we're waiting on, remove timeout for it */
296 reply_serial = dbus_message_get_reply_serial (message);
297 if (reply_serial != -1)
299 reply_handler_data = _dbus_hash_table_lookup_int (connection->pending_replies,
301 if (reply_handler_data != NULL)
303 if (reply_handler_data->timeout_added)
304 _dbus_connection_remove_timeout_locked (connection,
305 reply_handler_data->timeout);
306 reply_handler_data->timeout_added = FALSE;
310 connection->n_incoming += 1;
312 _dbus_connection_wakeup_mainloop (connection);
314 _dbus_assert (dbus_message_get_name (message) != NULL);
315 _dbus_verbose ("Message %p (%s) added to incoming queue %p, %d incoming\n",
316 message, dbus_message_get_name (message),
318 connection->n_incoming);
322 * Adds a link + message to the incoming message queue.
323 * Can't fail. Takes ownership of both link and message.
325 * @param connection the connection.
326 * @param link the list node and message to queue.
328 * @todo This needs to wake up the mainloop if it is in
329 * a poll/select and this is a multithreaded app.
332 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
335 _dbus_list_append_link (&connection->incoming_messages, link);
337 connection->n_incoming += 1;
339 _dbus_connection_wakeup_mainloop (connection);
341 _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
342 link->data, connection, connection->n_incoming);
347 * Checks whether there are messages in the outgoing message queue.
349 * @param connection the connection.
350 * @returns #TRUE if the outgoing queue is non-empty.
353 _dbus_connection_have_messages_to_send (DBusConnection *connection)
355 return connection->outgoing_messages != NULL;
359 * Gets the next outgoing message. The message remains in the
360 * queue, and the caller does not own a reference to it.
362 * @param connection the connection.
363 * @returns the message to be sent.
366 _dbus_connection_get_message_to_send (DBusConnection *connection)
368 return _dbus_list_get_last (&connection->outgoing_messages);
372 * Notifies the connection that a message has been sent, so the
373 * message can be removed from the outgoing queue.
374 * Called with the connection lock held.
376 * @param connection the connection.
377 * @param message the message that was sent.
380 _dbus_connection_message_sent (DBusConnection *connection,
381 DBusMessage *message)
385 _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
387 link = _dbus_list_get_last_link (&connection->outgoing_messages);
388 _dbus_assert (link != NULL);
389 _dbus_assert (link->data == message);
391 /* Save this link in the link cache */
392 _dbus_list_unlink (&connection->outgoing_messages,
394 _dbus_list_prepend_link (&connection->link_cache, link);
396 connection->n_outgoing -= 1;
398 _dbus_verbose ("Message %p (%s) removed from outgoing queue %p, %d left to send\n",
399 message, dbus_message_get_name (message),
400 connection, connection->n_outgoing);
402 /* Save this link in the link cache also */
403 _dbus_message_remove_size_counter (message, connection->outgoing_counter,
405 _dbus_list_prepend_link (&connection->link_cache, link);
407 dbus_message_unref (message);
409 if (connection->n_outgoing == 0)
410 _dbus_transport_messages_pending (connection->transport,
411 connection->n_outgoing);
415 * Adds a watch using the connection's DBusAddWatchFunction if
416 * available. Otherwise records the watch to be added when said
417 * function is available. Also re-adds the watch if the
418 * DBusAddWatchFunction changes. May fail due to lack of memory.
420 * @param connection the connection.
421 * @param watch the watch to add.
422 * @returns #TRUE on success.
425 _dbus_connection_add_watch (DBusConnection *connection,
428 if (connection->watches) /* null during finalize */
429 return _dbus_watch_list_add_watch (connection->watches,
436 * Removes a watch using the connection's DBusRemoveWatchFunction
437 * if available. It's an error to call this function on a watch
438 * that was not previously added.
440 * @param connection the connection.
441 * @param watch the watch to remove.
444 _dbus_connection_remove_watch (DBusConnection *connection,
447 if (connection->watches) /* null during finalize */
448 _dbus_watch_list_remove_watch (connection->watches,
453 * Toggles a watch and notifies app via connection's
454 * DBusWatchToggledFunction if available. It's an error to call this
455 * function on a watch that was not previously added.
457 * @param connection the connection.
458 * @param watch the watch to toggle.
459 * @param enabled whether to enable or disable
462 _dbus_connection_toggle_watch (DBusConnection *connection,
466 if (connection->watches) /* null during finalize */
467 _dbus_watch_list_toggle_watch (connection->watches,
472 * Adds a timeout using the connection's DBusAddTimeoutFunction if
473 * available. Otherwise records the timeout to be added when said
474 * function is available. Also re-adds the timeout if the
475 * DBusAddTimeoutFunction changes. May fail due to lack of memory.
476 * The timeout will fire repeatedly until removed.
478 * @param connection the connection.
479 * @param timeout the timeout to add.
480 * @returns #TRUE on success.
483 _dbus_connection_add_timeout (DBusConnection *connection,
484 DBusTimeout *timeout)
486 if (connection->timeouts) /* null during finalize */
487 return _dbus_timeout_list_add_timeout (connection->timeouts,
494 * Removes a timeout using the connection's DBusRemoveTimeoutFunction
495 * if available. It's an error to call this function on a timeout
496 * that was not previously added.
498 * @param connection the connection.
499 * @param timeout the timeout to remove.
502 _dbus_connection_remove_timeout (DBusConnection *connection,
503 DBusTimeout *timeout)
505 if (connection->timeouts) /* null during finalize */
506 _dbus_timeout_list_remove_timeout (connection->timeouts,
511 _dbus_connection_remove_timeout_locked (DBusConnection *connection,
512 DBusTimeout *timeout)
514 CONNECTION_LOCK (connection);
515 _dbus_connection_remove_timeout (connection, timeout);
516 CONNECTION_UNLOCK (connection);
520 * Toggles a timeout and notifies app via connection's
521 * DBusTimeoutToggledFunction if available. It's an error to call this
522 * function on a timeout that was not previously added.
524 * @param connection the connection.
525 * @param timeout the timeout to toggle.
526 * @param enabled whether to enable or disable
529 _dbus_connection_toggle_timeout (DBusConnection *connection,
530 DBusTimeout *timeout,
533 if (connection->timeouts) /* null during finalize */
534 _dbus_timeout_list_toggle_timeout (connection->timeouts,
539 * Tells the connection that the transport has been disconnected.
540 * Results in posting a disconnect message on the incoming message
541 * queue. Only has an effect the first time it's called.
543 * @param connection the connection
546 _dbus_connection_notify_disconnected (DBusConnection *connection)
548 if (connection->disconnect_message_link)
550 /* We haven't sent the disconnect message already */
551 _dbus_connection_queue_synthesized_message_link (connection,
552 connection->disconnect_message_link);
553 connection->disconnect_message_link = NULL;
559 * Acquire the transporter I/O path. This must be done before
560 * doing any I/O in the transporter. May sleep and drop the
561 * connection mutex while waiting for the I/O path.
563 * @param connection the connection.
564 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
565 * @returns TRUE if the I/O path was acquired.
568 _dbus_connection_acquire_io_path (DBusConnection *connection,
569 int timeout_milliseconds)
571 dbus_bool_t res = TRUE;
573 if (connection->io_path_acquired)
575 if (timeout_milliseconds != -1)
576 res = dbus_condvar_wait_timeout (connection->io_path_cond,
578 timeout_milliseconds);
580 dbus_condvar_wait (connection->io_path_cond, connection->mutex);
585 _dbus_assert (!connection->io_path_acquired);
587 connection->io_path_acquired = TRUE;
594 * Release the I/O path when you're done with it. Only call
595 * after you've acquired the I/O. Wakes up at most one thread
596 * currently waiting to acquire the I/O path.
598 * @param connection the connection.
601 _dbus_connection_release_io_path (DBusConnection *connection)
603 _dbus_assert (connection->io_path_acquired);
605 connection->io_path_acquired = FALSE;
606 dbus_condvar_wake_one (connection->io_path_cond);
611 * Queues incoming messages and sends outgoing messages for this
612 * connection, optionally blocking in the process. Each call to
613 * _dbus_connection_do_iteration() will call select() or poll() one
614 * time and then read or write data if possible.
616 * The purpose of this function is to be able to flush outgoing
617 * messages or queue up incoming messages without returning
618 * control to the application and causing reentrancy weirdness.
620 * The flags parameter allows you to specify whether to
621 * read incoming messages, write outgoing messages, or both,
622 * and whether to block if no immediate action is possible.
624 * The timeout_milliseconds parameter does nothing unless the
625 * iteration is blocking.
627 * If there are no outgoing messages and DBUS_ITERATION_DO_READING
628 * wasn't specified, then it's impossible to block, even if
629 * you specify DBUS_ITERATION_BLOCK; in that case the function
630 * returns immediately.
632 * @param connection the connection.
633 * @param flags iteration flags.
634 * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
637 _dbus_connection_do_iteration (DBusConnection *connection,
639 int timeout_milliseconds)
641 if (connection->n_outgoing == 0)
642 flags &= ~DBUS_ITERATION_DO_WRITING;
644 if (_dbus_connection_acquire_io_path (connection,
645 (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
647 _dbus_transport_do_iteration (connection->transport,
648 flags, timeout_milliseconds);
649 _dbus_connection_release_io_path (connection);
654 * Creates a new connection for the given transport. A transport
655 * represents a message stream that uses some concrete mechanism, such
656 * as UNIX domain sockets. May return #NULL if insufficient
657 * memory exists to create the connection.
659 * @param transport the transport.
660 * @returns the new connection, or #NULL on failure.
663 _dbus_connection_new_for_transport (DBusTransport *transport)
665 DBusConnection *connection;
666 DBusWatchList *watch_list;
667 DBusTimeoutList *timeout_list;
668 DBusHashTable *pending_replies;
670 DBusCondVar *message_returned_cond;
671 DBusCondVar *dispatch_cond;
672 DBusCondVar *io_path_cond;
673 DBusList *disconnect_link;
674 DBusMessage *disconnect_message;
675 DBusCounter *outgoing_counter;
676 DBusObjectRegistry *objects;
680 pending_replies = NULL;
683 message_returned_cond = NULL;
684 dispatch_cond = NULL;
686 disconnect_link = NULL;
687 disconnect_message = NULL;
688 outgoing_counter = NULL;
691 watch_list = _dbus_watch_list_new ();
692 if (watch_list == NULL)
695 timeout_list = _dbus_timeout_list_new ();
696 if (timeout_list == NULL)
700 _dbus_hash_table_new (DBUS_HASH_INT,
701 NULL, (DBusFreeFunction)reply_handler_data_free);
702 if (pending_replies == NULL)
705 connection = dbus_new0 (DBusConnection, 1);
706 if (connection == NULL)
709 mutex = dbus_mutex_new ();
713 message_returned_cond = dbus_condvar_new ();
714 if (message_returned_cond == NULL)
717 dispatch_cond = dbus_condvar_new ();
718 if (dispatch_cond == NULL)
721 io_path_cond = dbus_condvar_new ();
722 if (io_path_cond == NULL)
725 disconnect_message = dbus_message_new_signal (DBUS_MESSAGE_LOCAL_DISCONNECT);
726 if (disconnect_message == NULL)
729 disconnect_link = _dbus_list_alloc_link (disconnect_message);
730 if (disconnect_link == NULL)
733 outgoing_counter = _dbus_counter_new ();
734 if (outgoing_counter == NULL)
737 objects = _dbus_object_registry_new (connection);
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->pending_replies = pending_replies;
753 connection->outgoing_counter = outgoing_counter;
754 connection->filter_list = NULL;
755 connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
757 _dbus_data_slot_list_init (&connection->slot_list);
759 connection->client_serial = 1;
761 connection->disconnect_message_link = disconnect_link;
763 if (!_dbus_transport_set_connection (transport, connection))
766 _dbus_transport_ref (transport);
771 if (disconnect_message != NULL)
772 dbus_message_unref (disconnect_message);
774 if (disconnect_link != NULL)
775 _dbus_list_free_link (disconnect_link);
777 if (io_path_cond != NULL)
778 dbus_condvar_free (io_path_cond);
780 if (dispatch_cond != NULL)
781 dbus_condvar_free (dispatch_cond);
783 if (message_returned_cond != NULL)
784 dbus_condvar_free (message_returned_cond);
787 dbus_mutex_free (mutex);
789 if (connection != NULL)
790 dbus_free (connection);
793 _dbus_hash_table_unref (pending_replies);
796 _dbus_watch_list_free (watch_list);
799 _dbus_timeout_list_free (timeout_list);
801 if (outgoing_counter)
802 _dbus_counter_unref (outgoing_counter);
805 _dbus_object_registry_unref (objects);
811 * Increments the reference count of a DBusConnection.
812 * Requires that the caller already holds the connection lock.
814 * @param connection the connection.
817 _dbus_connection_ref_unlocked (DBusConnection *connection)
819 #ifdef DBUS_HAVE_ATOMIC_INT
820 _dbus_atomic_inc (&connection->refcount);
822 _dbus_assert (connection->refcount.value > 0);
823 connection->refcount.value += 1;
828 _dbus_connection_get_next_client_serial (DBusConnection *connection)
832 serial = connection->client_serial++;
834 if (connection->client_serial < 0)
835 connection->client_serial = 1;
841 * Used to notify a connection when a DBusMessageHandler is
842 * destroyed, so the connection can drop any reference
843 * to the handler. This is a private function, but still
844 * takes the connection lock. Don't call it with the lock held.
846 * @todo needs to check in pending_replies too.
848 * @param connection the connection
849 * @param handler the handler
852 _dbus_connection_handler_destroyed_locked (DBusConnection *connection,
853 DBusMessageHandler *handler)
857 CONNECTION_LOCK (connection);
859 link = _dbus_list_get_first_link (&connection->filter_list);
862 DBusMessageHandler *h = link->data;
863 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
866 _dbus_list_remove_link (&connection->filter_list,
871 CONNECTION_UNLOCK (connection);
875 * A callback for use with dbus_watch_new() to create a DBusWatch.
877 * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
878 * and the virtual handle_watch in DBusTransport if we got rid of it.
879 * The reason this is some work is threading, see the _dbus_connection_handle_watch()
882 * @param watch the watch.
883 * @param condition the current condition of the file descriptors being watched.
884 * @param data must be a pointer to a #DBusConnection
885 * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
888 _dbus_connection_handle_watch (DBusWatch *watch,
889 unsigned int condition,
892 DBusConnection *connection;
894 DBusDispatchStatus status;
898 CONNECTION_LOCK (connection);
899 _dbus_connection_acquire_io_path (connection, -1);
900 retval = _dbus_transport_handle_watch (connection->transport,
902 _dbus_connection_release_io_path (connection);
904 status = _dbus_connection_get_dispatch_status_unlocked (connection);
906 /* this calls out to user code */
907 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
913 * Get the server ID to be used in the object ID for an object
914 * registered with this connection.
916 * @todo implement this function
918 * @param connection the connection.
919 * @returns the portion of the object ID
922 _dbus_connection_init_id (DBusConnection *connection,
923 DBusObjectID *object_id)
926 dbus_object_id_set_server_bits (object_id, 15);
927 dbus_object_id_set_client_bits (object_id, 31);
928 dbus_object_id_set_is_server_bit (object_id, FALSE);
934 * @addtogroup DBusConnection
940 * Opens a new connection to a remote address.
942 * @todo specify what the address parameter is. Right now
943 * it's just the name of a UNIX domain socket. It should be
944 * something more complex that encodes which transport to use.
946 * If the open fails, the function returns #NULL, and provides
947 * a reason for the failure in the result parameter. Pass
948 * #NULL for the result parameter if you aren't interested
949 * in the reason for failure.
951 * @param address the address.
952 * @param error address where an error can be returned.
953 * @returns new connection, or #NULL on failure.
956 dbus_connection_open (const char *address,
959 DBusConnection *connection;
960 DBusTransport *transport;
962 _dbus_return_val_if_fail (address != NULL, NULL);
963 _dbus_return_val_if_error_is_set (error, NULL);
965 transport = _dbus_transport_open (address, error);
966 if (transport == NULL)
968 _DBUS_ASSERT_ERROR_IS_SET (error);
972 connection = _dbus_connection_new_for_transport (transport);
974 _dbus_transport_unref (transport);
976 if (connection == NULL)
978 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
986 * Increments the reference count of a DBusConnection.
988 * @param connection the connection.
991 dbus_connection_ref (DBusConnection *connection)
993 _dbus_return_if_fail (connection != NULL);
995 /* The connection lock is better than the global
996 * lock in the atomic increment fallback
999 #ifdef DBUS_HAVE_ATOMIC_INT
1000 _dbus_atomic_inc (&connection->refcount);
1002 CONNECTION_LOCK (connection);
1003 _dbus_assert (connection->refcount.value > 0);
1005 connection->refcount.value += 1;
1006 CONNECTION_UNLOCK (connection);
1011 free_outgoing_message (void *element,
1014 DBusMessage *message = element;
1015 DBusConnection *connection = data;
1017 _dbus_message_remove_size_counter (message,
1018 connection->outgoing_counter,
1020 dbus_message_unref (message);
1023 /* This is run without the mutex held, but after the last reference
1024 * to the connection has been dropped we should have no thread-related
1028 _dbus_connection_last_unref (DBusConnection *connection)
1032 _dbus_verbose ("Finalizing connection %p\n", connection);
1034 _dbus_assert (connection->refcount.value == 0);
1036 /* You have to disconnect the connection before unref:ing it. Otherwise
1037 * you won't get the disconnected message.
1039 _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
1041 /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
1042 _dbus_object_registry_free_all_unlocked (connection->objects);
1044 dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
1045 dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
1046 dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
1048 _dbus_watch_list_free (connection->watches);
1049 connection->watches = NULL;
1051 _dbus_timeout_list_free (connection->timeouts);
1052 connection->timeouts = NULL;
1054 _dbus_data_slot_list_free (&connection->slot_list);
1055 /* ---- Done with stuff that invokes application callbacks */
1057 link = _dbus_list_get_first_link (&connection->filter_list);
1058 while (link != NULL)
1060 DBusMessageHandler *h = link->data;
1061 DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
1063 _dbus_message_handler_remove_connection (h, connection);
1068 _dbus_object_registry_unref (connection->objects);
1070 _dbus_hash_table_unref (connection->pending_replies);
1071 connection->pending_replies = NULL;
1073 _dbus_list_clear (&connection->filter_list);
1075 _dbus_list_foreach (&connection->outgoing_messages,
1076 free_outgoing_message,
1078 _dbus_list_clear (&connection->outgoing_messages);
1080 _dbus_list_foreach (&connection->incoming_messages,
1081 (DBusForeachFunction) dbus_message_unref,
1083 _dbus_list_clear (&connection->incoming_messages);
1085 _dbus_counter_unref (connection->outgoing_counter);
1087 _dbus_transport_unref (connection->transport);
1089 if (connection->disconnect_message_link)
1091 DBusMessage *message = connection->disconnect_message_link->data;
1092 dbus_message_unref (message);
1093 _dbus_list_free_link (connection->disconnect_message_link);
1096 _dbus_list_clear (&connection->link_cache);
1098 dbus_condvar_free (connection->dispatch_cond);
1099 dbus_condvar_free (connection->io_path_cond);
1100 dbus_condvar_free (connection->message_returned_cond);
1102 dbus_mutex_free (connection->mutex);
1104 dbus_free (connection);
1108 * Decrements the reference count of a DBusConnection, and finalizes
1109 * it if the count reaches zero. It is a bug to drop the last reference
1110 * to a connection that has not been disconnected.
1112 * @todo in practice it can be quite tricky to never unref a connection
1113 * that's still connected; maybe there's some way we could avoid
1116 * @param connection the connection.
1119 dbus_connection_unref (DBusConnection *connection)
1121 dbus_bool_t last_unref;
1123 _dbus_return_if_fail (connection != NULL);
1125 /* The connection lock is better than the global
1126 * lock in the atomic increment fallback
1129 #ifdef DBUS_HAVE_ATOMIC_INT
1130 last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1132 CONNECTION_LOCK (connection);
1134 _dbus_assert (connection->refcount.value > 0);
1136 connection->refcount.value -= 1;
1137 last_unref = (connection->refcount.value == 0);
1140 printf ("unref() connection %p count = %d\n", connection, connection->refcount.value);
1143 CONNECTION_UNLOCK (connection);
1147 _dbus_connection_last_unref (connection);
1151 * Closes the connection, so no further data can be sent or received.
1152 * Any further attempts to send data will result in errors. This
1153 * function does not affect the connection's reference count. It's
1154 * safe to disconnect a connection more than once; all calls after the
1155 * first do nothing. It's impossible to "reconnect" a connection, a
1156 * new connection must be created.
1158 * @param connection the connection.
1161 dbus_connection_disconnect (DBusConnection *connection)
1163 _dbus_return_if_fail (connection != NULL);
1165 CONNECTION_LOCK (connection);
1166 _dbus_transport_disconnect (connection->transport);
1167 CONNECTION_UNLOCK (connection);
1171 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
1173 return _dbus_transport_get_is_connected (connection->transport);
1177 * Gets whether the connection is currently connected. All
1178 * connections are connected when they are opened. A connection may
1179 * become disconnected when the remote application closes its end, or
1180 * exits; a connection may also be disconnected with
1181 * dbus_connection_disconnect().
1183 * @param connection the connection.
1184 * @returns #TRUE if the connection is still alive.
1187 dbus_connection_get_is_connected (DBusConnection *connection)
1191 _dbus_return_val_if_fail (connection != NULL, FALSE);
1193 CONNECTION_LOCK (connection);
1194 res = _dbus_connection_get_is_connected_unlocked (connection);
1195 CONNECTION_UNLOCK (connection);
1201 * Gets whether the connection was authenticated. (Note that
1202 * if the connection was authenticated then disconnected,
1203 * this function still returns #TRUE)
1205 * @param connection the connection
1206 * @returns #TRUE if the connection was ever authenticated
1209 dbus_connection_get_is_authenticated (DBusConnection *connection)
1213 _dbus_return_val_if_fail (connection != NULL, FALSE);
1215 CONNECTION_LOCK (connection);
1216 res = _dbus_transport_get_is_authenticated (connection->transport);
1217 CONNECTION_UNLOCK (connection);
1222 struct DBusPreallocatedSend
1224 DBusConnection *connection;
1225 DBusList *queue_link;
1226 DBusList *counter_link;
1229 static DBusPreallocatedSend*
1230 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1232 DBusPreallocatedSend *preallocated;
1234 _dbus_return_val_if_fail (connection != NULL, NULL);
1236 preallocated = dbus_new (DBusPreallocatedSend, 1);
1237 if (preallocated == NULL)
1240 if (connection->link_cache != NULL)
1242 preallocated->queue_link =
1243 _dbus_list_pop_first_link (&connection->link_cache);
1244 preallocated->queue_link->data = NULL;
1248 preallocated->queue_link = _dbus_list_alloc_link (NULL);
1249 if (preallocated->queue_link == NULL)
1253 if (connection->link_cache != NULL)
1255 preallocated->counter_link =
1256 _dbus_list_pop_first_link (&connection->link_cache);
1257 preallocated->counter_link->data = connection->outgoing_counter;
1261 preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1262 if (preallocated->counter_link == NULL)
1266 _dbus_counter_ref (preallocated->counter_link->data);
1268 preallocated->connection = connection;
1270 return preallocated;
1273 _dbus_list_free_link (preallocated->queue_link);
1275 dbus_free (preallocated);
1281 * Preallocates resources needed to send a message, allowing the message
1282 * to be sent without the possibility of memory allocation failure.
1283 * Allows apps to create a future guarantee that they can send
1284 * a message regardless of memory shortages.
1286 * @param connection the connection we're preallocating for.
1287 * @returns the preallocated resources, or #NULL
1289 DBusPreallocatedSend*
1290 dbus_connection_preallocate_send (DBusConnection *connection)
1292 DBusPreallocatedSend *preallocated;
1294 _dbus_return_val_if_fail (connection != NULL, NULL);
1296 CONNECTION_LOCK (connection);
1299 _dbus_connection_preallocate_send_unlocked (connection);
1301 CONNECTION_UNLOCK (connection);
1303 return preallocated;
1307 * Frees preallocated message-sending resources from
1308 * dbus_connection_preallocate_send(). Should only
1309 * be called if the preallocated resources are not used
1310 * to send a message.
1312 * @param connection the connection
1313 * @param preallocated the resources
1316 dbus_connection_free_preallocated_send (DBusConnection *connection,
1317 DBusPreallocatedSend *preallocated)
1319 _dbus_return_if_fail (connection != NULL);
1320 _dbus_return_if_fail (preallocated != NULL);
1321 _dbus_return_if_fail (connection == preallocated->connection);
1323 _dbus_list_free_link (preallocated->queue_link);
1324 _dbus_counter_unref (preallocated->counter_link->data);
1325 _dbus_list_free_link (preallocated->counter_link);
1326 dbus_free (preallocated);
1330 _dbus_connection_send_preallocated_unlocked (DBusConnection *connection,
1331 DBusPreallocatedSend *preallocated,
1332 DBusMessage *message,
1333 dbus_uint32_t *client_serial)
1335 dbus_uint32_t serial;
1337 preallocated->queue_link->data = message;
1338 _dbus_list_prepend_link (&connection->outgoing_messages,
1339 preallocated->queue_link);
1341 _dbus_message_add_size_counter_link (message,
1342 preallocated->counter_link);
1344 dbus_free (preallocated);
1345 preallocated = NULL;
1347 dbus_message_ref (message);
1349 connection->n_outgoing += 1;
1351 _dbus_verbose ("Message %p (%s) added to outgoing queue %p, %d pending to send\n",
1353 dbus_message_get_name (message),
1355 connection->n_outgoing);
1357 if (dbus_message_get_serial (message) == 0)
1359 serial = _dbus_connection_get_next_client_serial (connection);
1360 _dbus_message_set_serial (message, serial);
1362 *client_serial = serial;
1367 *client_serial = dbus_message_get_serial (message);
1370 _dbus_message_lock (message);
1372 if (connection->n_outgoing == 1)
1373 _dbus_transport_messages_pending (connection->transport,
1374 connection->n_outgoing);
1376 _dbus_connection_wakeup_mainloop (connection);
1380 * Sends a message using preallocated resources. This function cannot fail.
1381 * It works identically to dbus_connection_send() in other respects.
1382 * Preallocated resources comes from dbus_connection_preallocate_send().
1383 * This function "consumes" the preallocated resources, they need not
1384 * be freed separately.
1386 * @param connection the connection
1387 * @param preallocated the preallocated resources
1388 * @param message the message to send
1389 * @param client_serial return location for client serial assigned to the message
1392 dbus_connection_send_preallocated (DBusConnection *connection,
1393 DBusPreallocatedSend *preallocated,
1394 DBusMessage *message,
1395 dbus_uint32_t *client_serial)
1397 _dbus_return_if_fail (connection != NULL);
1398 _dbus_return_if_fail (preallocated != NULL);
1399 _dbus_return_if_fail (message != NULL);
1400 _dbus_return_if_fail (preallocated->connection == connection);
1401 _dbus_return_if_fail (dbus_message_get_name (message) != NULL);
1403 CONNECTION_LOCK (connection);
1404 _dbus_connection_send_preallocated_unlocked (connection,
1406 message, client_serial);
1407 CONNECTION_UNLOCK (connection);
1411 * Adds a message to the outgoing message queue. Does not block to
1412 * write the message to the network; that happens asynchronously. To
1413 * force the message to be written, call dbus_connection_flush().
1414 * Because this only queues the message, the only reason it can
1415 * fail is lack of memory. Even if the connection is disconnected,
1416 * no error will be returned.
1418 * If the function fails due to lack of memory, it returns #FALSE.
1419 * The function will never fail for other reasons; even if the
1420 * connection is disconnected, you can queue an outgoing message,
1421 * though obviously it won't be sent.
1423 * @param connection the connection.
1424 * @param message the message to write.
1425 * @param client_serial return location for client serial.
1426 * @returns #TRUE on success.
1429 dbus_connection_send (DBusConnection *connection,
1430 DBusMessage *message,
1431 dbus_uint32_t *client_serial)
1433 DBusPreallocatedSend *preallocated;
1435 _dbus_return_val_if_fail (connection != NULL, FALSE);
1436 _dbus_return_val_if_fail (message != NULL, FALSE);
1438 CONNECTION_LOCK (connection);
1440 preallocated = _dbus_connection_preallocate_send_unlocked (connection);
1441 if (preallocated == NULL)
1443 CONNECTION_UNLOCK (connection);
1448 _dbus_connection_send_preallocated_unlocked (connection,
1452 CONNECTION_UNLOCK (connection);
1458 reply_handler_timeout (void *data)
1460 DBusConnection *connection;
1461 ReplyHandlerData *reply_handler_data = data;
1462 DBusDispatchStatus status;
1464 connection = reply_handler_data->connection;
1466 CONNECTION_LOCK (connection);
1467 if (reply_handler_data->timeout_link)
1469 _dbus_connection_queue_synthesized_message_link (connection,
1470 reply_handler_data->timeout_link);
1471 reply_handler_data->timeout_link = NULL;
1474 _dbus_connection_remove_timeout (connection,
1475 reply_handler_data->timeout);
1476 reply_handler_data->timeout_added = FALSE;
1478 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1480 /* Unlocks, and calls out to user code */
1481 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1487 reply_handler_data_free (ReplyHandlerData *data)
1492 if (data->timeout_added)
1493 _dbus_connection_remove_timeout_locked (data->connection,
1496 if (data->connection_added)
1497 _dbus_message_handler_remove_connection (data->handler,
1500 if (data->timeout_link)
1502 dbus_message_unref ((DBusMessage *)data->timeout_link->data);
1503 _dbus_list_free_link (data->timeout_link);
1506 dbus_message_handler_unref (data->handler);
1512 * Queues a message to send, as with dbus_connection_send_message(),
1513 * but also sets up a DBusMessageHandler to receive a reply to the
1514 * message. If no reply is received in the given timeout_milliseconds,
1515 * expires the pending reply and sends the DBusMessageHandler a
1516 * synthetic error reply (generated in-process, not by the remote
1517 * application) indicating that a timeout occurred.
1519 * Reply handlers see their replies after message filters see them,
1520 * but before message handlers added with
1521 * dbus_connection_register_handler() see them, regardless of the
1522 * reply message's name. Reply handlers are only handed a single
1523 * message as a reply, after one reply has been seen the handler is
1524 * removed. If a filter filters out the reply before the handler sees
1525 * it, the reply is immediately timed out and a timeout error reply is
1526 * generated. If a filter removes the timeout error reply then the
1527 * reply handler will never be called. Filters should not do this.
1529 * If #NULL is passed for the reply_handler, the timeout reply will
1530 * still be generated and placed into the message queue, but no
1531 * specific message handler will receive the reply.
1533 * If -1 is passed for the timeout, a sane default timeout is used. -1
1534 * is typically the best value for the timeout for this reason, unless
1535 * you want a very short or very long timeout. There is no way to
1536 * avoid a timeout entirely, other than passing INT_MAX for the
1537 * timeout to postpone it indefinitely.
1539 * @param connection the connection
1540 * @param message the message to send
1541 * @param reply_handler message handler expecting the reply, or #NULL
1542 * @param timeout_milliseconds timeout in milliseconds or -1 for default
1543 * @returns #TRUE if the message is successfully queued, #FALSE if no memory.
1547 dbus_connection_send_with_reply (DBusConnection *connection,
1548 DBusMessage *message,
1549 DBusMessageHandler *reply_handler,
1550 int timeout_milliseconds)
1552 DBusTimeout *timeout;
1553 ReplyHandlerData *data;
1555 DBusList *reply_link;
1556 dbus_int32_t serial = -1;
1558 _dbus_return_val_if_fail (connection != NULL, FALSE);
1559 _dbus_return_val_if_fail (message != NULL, FALSE);
1560 _dbus_return_val_if_fail (reply_handler != NULL, FALSE);
1561 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
1563 if (timeout_milliseconds == -1)
1564 timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
1566 data = dbus_new0 (ReplyHandlerData, 1);
1571 timeout = _dbus_timeout_new (timeout_milliseconds, reply_handler_timeout,
1576 reply_handler_data_free (data);
1580 CONNECTION_LOCK (connection);
1583 if (!_dbus_connection_add_timeout (connection, timeout))
1585 reply_handler_data_free (data);
1586 _dbus_timeout_unref (timeout);
1587 CONNECTION_UNLOCK (connection);
1591 /* The connection now owns the reference to the timeout. */
1592 _dbus_timeout_unref (timeout);
1594 data->timeout_added = TRUE;
1595 data->timeout = timeout;
1596 data->connection = connection;
1598 if (!_dbus_message_handler_add_connection (reply_handler, connection))
1600 CONNECTION_UNLOCK (connection);
1601 reply_handler_data_free (data);
1604 data->connection_added = TRUE;
1606 /* Assign a serial to the message */
1607 if (dbus_message_get_serial (message) == 0)
1609 serial = _dbus_connection_get_next_client_serial (connection);
1610 _dbus_message_set_serial (message, serial);
1613 data->handler = reply_handler;
1614 data->serial = serial;
1616 dbus_message_handler_ref (reply_handler);
1618 reply = dbus_message_new_error (message, DBUS_ERROR_NO_REPLY,
1619 "No reply within specified time");
1622 CONNECTION_UNLOCK (connection);
1623 reply_handler_data_free (data);
1627 reply_link = _dbus_list_alloc_link (reply);
1630 CONNECTION_UNLOCK (connection);
1631 dbus_message_unref (reply);
1632 reply_handler_data_free (data);
1636 data->timeout_link = reply_link;
1638 /* Insert the serial in the pending replies hash. */
1639 if (!_dbus_hash_table_insert_int (connection->pending_replies, serial, data))
1641 CONNECTION_UNLOCK (connection);
1642 reply_handler_data_free (data);
1646 CONNECTION_UNLOCK (connection);
1648 if (!dbus_connection_send (connection, message, NULL))
1650 /* This will free the handler data too */
1651 _dbus_hash_table_remove_int (connection->pending_replies, serial);
1660 check_for_reply_unlocked (DBusConnection *connection,
1661 dbus_uint32_t client_serial)
1665 link = _dbus_list_get_first_link (&connection->incoming_messages);
1667 while (link != NULL)
1669 DBusMessage *reply = link->data;
1671 if (dbus_message_get_reply_serial (reply) == client_serial)
1673 _dbus_list_remove_link (&connection->incoming_messages, link);
1674 connection->n_incoming -= 1;
1675 dbus_message_ref (reply);
1678 link = _dbus_list_get_next_link (&connection->incoming_messages, link);
1685 * Sends a message and blocks a certain time period while waiting for a reply.
1686 * This function does not dispatch any message handlers until the main loop
1687 * has been reached. This function is used to do non-reentrant "method calls."
1688 * If a reply is received, it is returned, and removed from the incoming
1689 * message queue. If it is not received, #NULL is returned and the
1690 * error is set to #DBUS_ERROR_NO_REPLY. If something else goes
1691 * wrong, result is set to whatever is appropriate, such as
1692 * #DBUS_ERROR_NO_MEMORY or #DBUS_ERROR_DISCONNECTED.
1694 * @todo could use performance improvements (it keeps scanning
1695 * the whole message queue for example) and has thread issues,
1696 * see comments in source
1698 * @param connection the connection
1699 * @param message the message to send
1700 * @param timeout_milliseconds timeout in milliseconds or -1 for default
1701 * @param error return location for error message
1702 * @returns the message that is the reply or #NULL with an error code if the
1706 dbus_connection_send_with_reply_and_block (DBusConnection *connection,
1707 DBusMessage *message,
1708 int timeout_milliseconds,
1711 dbus_uint32_t client_serial;
1712 long start_tv_sec, start_tv_usec;
1713 long end_tv_sec, end_tv_usec;
1714 long tv_sec, tv_usec;
1715 DBusDispatchStatus status;
1717 _dbus_return_val_if_fail (connection != NULL, NULL);
1718 _dbus_return_val_if_fail (message != NULL, NULL);
1719 _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
1720 _dbus_return_val_if_error_is_set (error, NULL);
1722 if (timeout_milliseconds == -1)
1723 timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
1725 /* it would probably seem logical to pass in _DBUS_INT_MAX
1726 * for infinite timeout, but then math below would get
1727 * all overflow-prone, so smack that down.
1729 if (timeout_milliseconds > _DBUS_ONE_HOUR_IN_MILLISECONDS * 6)
1730 timeout_milliseconds = _DBUS_ONE_HOUR_IN_MILLISECONDS * 6;
1732 if (!dbus_connection_send (connection, message, &client_serial))
1734 _DBUS_SET_OOM (error);
1740 /* Flush message queue */
1741 dbus_connection_flush (connection);
1743 CONNECTION_LOCK (connection);
1745 _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
1746 end_tv_sec = start_tv_sec + timeout_milliseconds / 1000;
1747 end_tv_usec = start_tv_usec + (timeout_milliseconds % 1000) * 1000;
1748 end_tv_sec += end_tv_usec / _DBUS_USEC_PER_SECOND;
1749 end_tv_usec = end_tv_usec % _DBUS_USEC_PER_SECOND;
1751 _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",
1752 timeout_milliseconds,
1754 start_tv_sec, start_tv_usec,
1755 end_tv_sec, end_tv_usec);
1757 /* Now we wait... */
1758 /* THREAD TODO: This is busted. What if a dispatch() or pop_message
1759 * gets the message before we do?
1761 /* always block at least once as we know we don't have the reply yet */
1762 _dbus_connection_do_iteration (connection,
1763 DBUS_ITERATION_DO_READING |
1764 DBUS_ITERATION_BLOCK,
1765 timeout_milliseconds);
1769 /* queue messages and get status */
1770 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1772 if (status == DBUS_DISPATCH_DATA_REMAINS)
1776 reply = check_for_reply_unlocked (connection, client_serial);
1779 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1781 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply %s\n",
1782 dbus_message_get_name (reply));
1784 /* Unlocks, and calls out to user code */
1785 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1791 _dbus_get_current_time (&tv_sec, &tv_usec);
1793 if (tv_sec < start_tv_sec)
1794 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
1795 else if (connection->disconnect_message_link == NULL)
1796 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
1797 else if (tv_sec < end_tv_sec ||
1798 (tv_sec == end_tv_sec && tv_usec < end_tv_usec))
1800 timeout_milliseconds = (end_tv_sec - tv_sec) * 1000 +
1801 (end_tv_usec - tv_usec) / 1000;
1802 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds);
1803 _dbus_assert (timeout_milliseconds >= 0);
1805 if (status == DBUS_DISPATCH_NEED_MEMORY)
1807 /* Try sleeping a bit, as we aren't sure we need to block for reading,
1808 * we may already have a reply in the buffer and just can't process
1811 _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
1813 if (timeout_milliseconds < 100)
1814 ; /* just busy loop */
1815 else if (timeout_milliseconds <= 1000)
1816 _dbus_sleep_milliseconds (timeout_milliseconds / 3);
1818 _dbus_sleep_milliseconds (1000);
1822 /* block again, we don't have the reply buffered yet. */
1823 _dbus_connection_do_iteration (connection,
1824 DBUS_ITERATION_DO_READING |
1825 DBUS_ITERATION_BLOCK,
1826 timeout_milliseconds);
1829 goto recheck_status;
1832 _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %ld milliseconds and got no reply\n",
1833 (tv_sec - start_tv_sec) * 1000 + (tv_usec - start_tv_usec) / 1000);
1835 if (dbus_connection_get_is_connected (connection))
1836 dbus_set_error (error, DBUS_ERROR_NO_REPLY, "Message did not receive a reply");
1838 dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Disconnected prior to receiving a reply");
1840 /* unlocks and calls out to user code */
1841 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1847 * Blocks until the outgoing message queue is empty.
1849 * @param connection the connection.
1852 dbus_connection_flush (DBusConnection *connection)
1854 /* We have to specify DBUS_ITERATION_DO_READING here because
1855 * otherwise we could have two apps deadlock if they are both doing
1856 * a flush(), and the kernel buffers fill up. This could change the
1859 DBusDispatchStatus status;
1861 _dbus_return_if_fail (connection != NULL);
1863 CONNECTION_LOCK (connection);
1864 while (connection->n_outgoing > 0 &&
1865 _dbus_connection_get_is_connected_unlocked (connection))
1866 _dbus_connection_do_iteration (connection,
1867 DBUS_ITERATION_DO_READING |
1868 DBUS_ITERATION_DO_WRITING |
1869 DBUS_ITERATION_BLOCK,
1872 status = _dbus_connection_get_dispatch_status_unlocked (connection);
1874 /* Unlocks and calls out to user code */
1875 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1878 /* Call with mutex held. Will drop it while waiting and re-acquire
1882 _dbus_connection_wait_for_borrowed (DBusConnection *connection)
1884 _dbus_assert (connection->message_borrowed != NULL);
1886 while (connection->message_borrowed != NULL)
1887 dbus_condvar_wait (connection->message_returned_cond, connection->mutex);
1891 * Returns the first-received message from the incoming message queue,
1892 * leaving it in the queue. If the queue is empty, returns #NULL.
1894 * The caller does not own a reference to the returned message, and
1895 * must either return it using dbus_connection_return_message() or
1896 * keep it after calling dbus_connection_steal_borrowed_message(). No
1897 * one can get at the message while its borrowed, so return it as
1898 * quickly as possible and don't keep a reference to it after
1899 * returning it. If you need to keep the message, make a copy of it.
1901 * @param connection the connection.
1902 * @returns next message in the incoming queue.
1905 dbus_connection_borrow_message (DBusConnection *connection)
1907 DBusMessage *message;
1908 DBusDispatchStatus status;
1910 _dbus_return_val_if_fail (connection != NULL, NULL);
1912 /* this is called for the side effect that it queues
1913 * up any messages from the transport
1915 status = dbus_connection_get_dispatch_status (connection);
1916 if (status != DBUS_DISPATCH_DATA_REMAINS)
1919 CONNECTION_LOCK (connection);
1921 if (connection->message_borrowed != NULL)
1922 _dbus_connection_wait_for_borrowed (connection);
1924 message = _dbus_list_get_first (&connection->incoming_messages);
1927 connection->message_borrowed = message;
1929 CONNECTION_UNLOCK (connection);
1934 * Used to return a message after peeking at it using
1935 * dbus_connection_borrow_message().
1937 * @param connection the connection
1938 * @param message the message from dbus_connection_borrow_message()
1941 dbus_connection_return_message (DBusConnection *connection,
1942 DBusMessage *message)
1944 _dbus_return_if_fail (connection != NULL);
1945 _dbus_return_if_fail (message != NULL);
1947 CONNECTION_LOCK (connection);
1949 _dbus_assert (message == connection->message_borrowed);
1951 connection->message_borrowed = NULL;
1952 dbus_condvar_wake_all (connection->message_returned_cond);
1954 CONNECTION_UNLOCK (connection);
1958 * Used to keep a message after peeking at it using
1959 * dbus_connection_borrow_message(). Before using this function, see
1960 * the caveats/warnings in the documentation for
1961 * dbus_connection_pop_message().
1963 * @param connection the connection
1964 * @param message the message from dbus_connection_borrow_message()
1967 dbus_connection_steal_borrowed_message (DBusConnection *connection,
1968 DBusMessage *message)
1970 DBusMessage *pop_message;
1972 _dbus_return_if_fail (connection != NULL);
1973 _dbus_return_if_fail (message != NULL);
1975 CONNECTION_LOCK (connection);
1977 _dbus_assert (message == connection->message_borrowed);
1979 pop_message = _dbus_list_pop_first (&connection->incoming_messages);
1980 _dbus_assert (message == pop_message);
1982 connection->n_incoming -= 1;
1984 _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
1985 message, connection->n_incoming);
1987 connection->message_borrowed = NULL;
1988 dbus_condvar_wake_all (connection->message_returned_cond);
1990 CONNECTION_UNLOCK (connection);
1993 /* See dbus_connection_pop_message, but requires the caller to own
1994 * the lock before calling. May drop the lock while running.
1997 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
1999 if (connection->message_borrowed != NULL)
2000 _dbus_connection_wait_for_borrowed (connection);
2002 if (connection->n_incoming > 0)
2006 link = _dbus_list_pop_first_link (&connection->incoming_messages);
2007 connection->n_incoming -= 1;
2009 _dbus_verbose ("Message %p (%s) removed from incoming queue %p, %d incoming\n",
2010 link->data, dbus_message_get_name (link->data),
2011 connection, connection->n_incoming);
2019 /* See dbus_connection_pop_message, but requires the caller to own
2020 * the lock before calling. May drop the lock while running.
2023 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
2027 link = _dbus_connection_pop_message_link_unlocked (connection);
2031 DBusMessage *message;
2033 message = link->data;
2035 _dbus_list_free_link (link);
2045 * Returns the first-received message from the incoming message queue,
2046 * removing it from the queue. The caller owns a reference to the
2047 * returned message. If the queue is empty, returns #NULL.
2049 * This function bypasses any message handlers that are registered,
2050 * and so using it is usually wrong. Instead, let the main loop invoke
2051 * dbus_connection_dispatch(). Popping messages manually is only
2052 * useful in very simple programs that don't share a #DBusConnection
2053 * with any libraries or other modules.
2055 * @param connection the connection.
2056 * @returns next message in the incoming queue.
2059 dbus_connection_pop_message (DBusConnection *connection)
2061 DBusMessage *message;
2062 DBusDispatchStatus status;
2064 /* this is called for the side effect that it queues
2065 * up any messages from the transport
2067 status = dbus_connection_get_dispatch_status (connection);
2068 if (status != DBUS_DISPATCH_DATA_REMAINS)
2071 CONNECTION_LOCK (connection);
2073 message = _dbus_connection_pop_message_unlocked (connection);
2075 _dbus_verbose ("Returning popped message %p\n", message);
2077 CONNECTION_UNLOCK (connection);
2083 * Acquire the dispatcher. This must be done before dispatching
2084 * messages in order to guarantee the right order of
2085 * message delivery. May sleep and drop the connection mutex
2086 * while waiting for the dispatcher.
2088 * @param connection the connection.
2091 _dbus_connection_acquire_dispatch (DBusConnection *connection)
2093 if (connection->dispatch_acquired)
2094 dbus_condvar_wait (connection->dispatch_cond, connection->mutex);
2095 _dbus_assert (!connection->dispatch_acquired);
2097 connection->dispatch_acquired = TRUE;
2101 * Release the dispatcher when you're done with it. Only call
2102 * after you've acquired the dispatcher. Wakes up at most one
2103 * thread currently waiting to acquire the dispatcher.
2105 * @param connection the connection.
2108 _dbus_connection_release_dispatch (DBusConnection *connection)
2110 _dbus_assert (connection->dispatch_acquired);
2112 connection->dispatch_acquired = FALSE;
2113 dbus_condvar_wake_one (connection->dispatch_cond);
2117 _dbus_connection_failed_pop (DBusConnection *connection,
2118 DBusList *message_link)
2120 _dbus_list_prepend_link (&connection->incoming_messages,
2122 connection->n_incoming += 1;
2125 static DBusDispatchStatus
2126 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
2128 if (connection->n_incoming > 0)
2129 return DBUS_DISPATCH_DATA_REMAINS;
2130 else if (!_dbus_transport_queue_messages (connection->transport))
2131 return DBUS_DISPATCH_NEED_MEMORY;
2134 DBusDispatchStatus status;
2136 status = _dbus_transport_get_dispatch_status (connection->transport);
2138 if (status != DBUS_DISPATCH_COMPLETE)
2140 else if (connection->n_incoming > 0)
2141 return DBUS_DISPATCH_DATA_REMAINS;
2143 return DBUS_DISPATCH_COMPLETE;
2148 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection *connection,
2149 DBusDispatchStatus new_status)
2151 dbus_bool_t changed;
2152 DBusDispatchStatusFunction function;
2155 /* We have the lock */
2157 _dbus_connection_ref_unlocked (connection);
2159 changed = new_status != connection->last_dispatch_status;
2161 connection->last_dispatch_status = new_status;
2163 function = connection->dispatch_status_function;
2164 data = connection->dispatch_status_data;
2166 /* We drop the lock */
2167 CONNECTION_UNLOCK (connection);
2169 if (changed && function)
2171 _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
2172 connection, new_status,
2173 new_status == DBUS_DISPATCH_COMPLETE ? "complete" :
2174 new_status == DBUS_DISPATCH_DATA_REMAINS ? "data remains" :
2175 new_status == DBUS_DISPATCH_NEED_MEMORY ? "need memory" :
2177 (* function) (connection, new_status, data);
2180 dbus_connection_unref (connection);
2184 * Gets the current state (what we would currently return
2185 * from dbus_connection_dispatch()) but doesn't actually
2186 * dispatch any messages.
2188 * @param connection the connection.
2189 * @returns current dispatch status
2192 dbus_connection_get_dispatch_status (DBusConnection *connection)
2194 DBusDispatchStatus status;
2196 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
2198 CONNECTION_LOCK (connection);
2200 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2202 CONNECTION_UNLOCK (connection);
2208 * Processes data buffered while handling watches, queueing zero or
2209 * more incoming messages. Then pops the first-received message from
2210 * the current incoming message queue, runs any handlers for it, and
2211 * unrefs the message. Returns a status indicating whether messages/data
2212 * remain, more memory is needed, or all data has been processed.
2214 * Even if the dispatch status is #DBUS_DISPATCH_DATA_REMAINS,
2215 * does not necessarily dispatch a message, as the data may
2216 * be part of authentication or the like.
2218 * @param connection the connection
2219 * @returns dispatch status
2222 dbus_connection_dispatch (DBusConnection *connection)
2224 DBusMessage *message;
2225 DBusList *link, *filter_list_copy, *message_link;
2226 DBusHandlerResult result;
2227 ReplyHandlerData *reply_handler_data;
2228 dbus_int32_t reply_serial;
2229 DBusDispatchStatus status;
2231 _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
2233 CONNECTION_LOCK (connection);
2234 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2235 if (status != DBUS_DISPATCH_DATA_REMAINS)
2237 /* unlocks and calls out to user code */
2238 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2242 /* We need to ref the connection since the callback could potentially
2243 * drop the last ref to it
2245 _dbus_connection_ref_unlocked (connection);
2247 _dbus_connection_acquire_dispatch (connection);
2249 /* This call may drop the lock during the execution (if waiting for
2250 * borrowed messages to be returned) but the order of message
2251 * dispatch if several threads call dispatch() is still
2252 * protected by the lock, since only one will get the lock, and that
2253 * one will finish the message dispatching
2255 message_link = _dbus_connection_pop_message_link_unlocked (connection);
2256 if (message_link == NULL)
2258 /* another thread dispatched our stuff */
2260 _dbus_connection_release_dispatch (connection);
2262 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2264 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2266 dbus_connection_unref (connection);
2271 message = message_link->data;
2273 result = DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
2275 reply_serial = dbus_message_get_reply_serial (message);
2276 reply_handler_data = _dbus_hash_table_lookup_int (connection->pending_replies,
2279 if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
2281 _dbus_connection_release_dispatch (connection);
2283 _dbus_connection_failed_pop (connection, message_link);
2285 /* unlocks and calls user code */
2286 _dbus_connection_update_dispatch_status_and_unlock (connection,
2287 DBUS_DISPATCH_NEED_MEMORY);
2289 dbus_connection_unref (connection);
2291 return DBUS_DISPATCH_NEED_MEMORY;
2294 _dbus_list_foreach (&filter_list_copy,
2295 (DBusForeachFunction)dbus_message_handler_ref,
2298 /* We're still protected from dispatch() reentrancy here
2299 * since we acquired the dispatcher
2301 CONNECTION_UNLOCK (connection);
2303 link = _dbus_list_get_first_link (&filter_list_copy);
2304 while (link != NULL)
2306 DBusMessageHandler *handler = link->data;
2307 DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
2309 _dbus_verbose (" running filter on message %p\n", message);
2310 result = _dbus_message_handler_handle_message (handler, connection,
2313 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2319 _dbus_list_foreach (&filter_list_copy,
2320 (DBusForeachFunction)dbus_message_handler_unref,
2322 _dbus_list_clear (&filter_list_copy);
2324 CONNECTION_LOCK (connection);
2326 /* Did a reply we were waiting on get filtered? */
2327 if (reply_handler_data && result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2329 /* Queue the timeout immediately! */
2330 if (reply_handler_data->timeout_link)
2332 _dbus_connection_queue_synthesized_message_link (connection,
2333 reply_handler_data->timeout_link);
2334 reply_handler_data->timeout_link = NULL;
2338 /* We already queued the timeout? Then it was filtered! */
2339 _dbus_warn ("The timeout error with reply serial %d was filtered, so the reply handler will never be called.\n", reply_serial);
2343 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2346 if (reply_handler_data)
2348 CONNECTION_UNLOCK (connection);
2350 _dbus_verbose (" running reply handler on message %p\n", message);
2352 result = _dbus_message_handler_handle_message (reply_handler_data->handler,
2353 connection, message);
2354 reply_handler_data_free (reply_handler_data);
2355 CONNECTION_LOCK (connection);
2359 /* We're still protected from dispatch() reentrancy here
2360 * since we acquired the dispatcher
2362 _dbus_verbose (" running object handler on message %p (%s)\n",
2363 message, dbus_message_get_name (message));
2365 result = _dbus_object_registry_handle_and_unlock (connection->objects,
2367 CONNECTION_LOCK (connection);
2368 if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
2371 _dbus_verbose (" done dispatching %p (%s) on connection %p\n", message,
2372 dbus_message_get_name (message), connection);
2375 _dbus_connection_release_dispatch (connection);
2377 _dbus_list_free_link (message_link);
2378 dbus_message_unref (message); /* don't want the message to count in max message limits
2379 * in computing dispatch status
2382 status = _dbus_connection_get_dispatch_status_unlocked (connection);
2384 /* unlocks and calls user code */
2385 _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2387 dbus_connection_unref (connection);
2393 * Sets the watch functions for the connection. These functions are
2394 * responsible for making the application's main loop aware of file
2395 * descriptors that need to be monitored for events, using select() or
2396 * poll(). When using Qt, typically the DBusAddWatchFunction would
2397 * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
2398 * could call g_io_add_watch(), or could be used as part of a more
2399 * elaborate GSource. Note that when a watch is added, it may
2402 * The DBusWatchToggledFunction notifies the application that the
2403 * watch has been enabled or disabled. Call dbus_watch_get_enabled()
2404 * to check this. A disabled watch should have no effect, and enabled
2405 * watch should be added to the main loop. This feature is used
2406 * instead of simply adding/removing the watch because
2407 * enabling/disabling can be done without memory allocation. The
2408 * toggled function may be NULL if a main loop re-queries
2409 * dbus_watch_get_enabled() every time anyway.
2411 * The DBusWatch can be queried for the file descriptor to watch using
2412 * dbus_watch_get_fd(), and for the events to watch for using
2413 * dbus_watch_get_flags(). The flags returned by
2414 * dbus_watch_get_flags() will only contain DBUS_WATCH_READABLE and
2415 * DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR;
2416 * all watches implicitly include a watch for hangups, errors, and
2417 * other exceptional conditions.
2419 * Once a file descriptor becomes readable or writable, or an exception
2420 * occurs, dbus_watch_handle() should be called to
2421 * notify the connection of the file descriptor's condition.
2423 * dbus_watch_handle() cannot be called during the
2424 * DBusAddWatchFunction, as the connection will not be ready to handle
2427 * It is not allowed to reference a DBusWatch after it has been passed
2428 * to remove_function.
2430 * If #FALSE is returned due to lack of memory, the failure may be due
2431 * to a #FALSE return from the new add_function. If so, the
2432 * add_function may have been called successfully one or more times,
2433 * but the remove_function will also have been called to remove any
2434 * successful adds. i.e. if #FALSE is returned the net result
2435 * should be that dbus_connection_set_watch_functions() has no effect,
2436 * but the add_function and remove_function may have been called.
2438 * @todo We need to drop the lock when we call the
2439 * add/remove/toggled functions which can be a side effect
2440 * of setting the watch functions.
2442 * @param connection the connection.
2443 * @param add_function function to begin monitoring a new descriptor.
2444 * @param remove_function function to stop monitoring a descriptor.
2445 * @param toggled_function function to notify of enable/disable
2446 * @param data data to pass to add_function and remove_function.
2447 * @param free_data_function function to be called to free the data.
2448 * @returns #FALSE on failure (no memory)
2451 dbus_connection_set_watch_functions (DBusConnection *connection,
2452 DBusAddWatchFunction add_function,
2453 DBusRemoveWatchFunction remove_function,
2454 DBusWatchToggledFunction toggled_function,
2456 DBusFreeFunction free_data_function)
2460 _dbus_return_val_if_fail (connection != NULL, FALSE);
2462 CONNECTION_LOCK (connection);
2463 /* ref connection for slightly better reentrancy */
2464 _dbus_connection_ref_unlocked (connection);
2466 /* FIXME this can call back into user code, and we need to drop the
2467 * connection lock when it does.
2469 retval = _dbus_watch_list_set_functions (connection->watches,
2470 add_function, remove_function,
2472 data, free_data_function);
2474 CONNECTION_UNLOCK (connection);
2475 /* drop our paranoid refcount */
2476 dbus_connection_unref (connection);
2482 * Sets the timeout functions for the connection. These functions are
2483 * responsible for making the application's main loop aware of timeouts.
2484 * When using Qt, typically the DBusAddTimeoutFunction would create a
2485 * QTimer. When using GLib, the DBusAddTimeoutFunction would call
2488 * The DBusTimeoutToggledFunction notifies the application that the
2489 * timeout has been enabled or disabled. Call
2490 * dbus_timeout_get_enabled() to check this. A disabled timeout should
2491 * have no effect, and enabled timeout should be added to the main
2492 * loop. This feature is used instead of simply adding/removing the
2493 * timeout because enabling/disabling can be done without memory
2494 * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
2495 * to enable and disable. The toggled function may be NULL if a main
2496 * loop re-queries dbus_timeout_get_enabled() every time anyway.
2497 * Whenever a timeout is toggled, its interval may change.
2499 * The DBusTimeout can be queried for the timer interval using
2500 * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
2501 * repeatedly, each time the interval elapses, starting after it has
2502 * elapsed once. The timeout stops firing when it is removed with the
2503 * given remove_function. The timer interval may change whenever the
2504 * timeout is added, removed, or toggled.
2506 * @param connection the connection.
2507 * @param add_function function to add a timeout.
2508 * @param remove_function function to remove a timeout.
2509 * @param toggled_function function to notify of enable/disable
2510 * @param data data to pass to add_function and remove_function.
2511 * @param free_data_function function to be called to free the data.
2512 * @returns #FALSE on failure (no memory)
2515 dbus_connection_set_timeout_functions (DBusConnection *connection,
2516 DBusAddTimeoutFunction add_function,
2517 DBusRemoveTimeoutFunction remove_function,
2518 DBusTimeoutToggledFunction toggled_function,
2520 DBusFreeFunction free_data_function)
2524 _dbus_return_val_if_fail (connection != NULL, FALSE);
2526 CONNECTION_LOCK (connection);
2527 /* ref connection for slightly better reentrancy */
2528 _dbus_connection_ref_unlocked (connection);
2530 retval = _dbus_timeout_list_set_functions (connection->timeouts,
2531 add_function, remove_function,
2533 data, free_data_function);
2535 CONNECTION_UNLOCK (connection);
2536 /* drop our paranoid refcount */
2537 dbus_connection_unref (connection);
2543 * Sets the mainloop wakeup function for the connection. Thi function is
2544 * responsible for waking up the main loop (if its sleeping) when some some
2545 * change has happened to the connection that the mainloop needs to reconsiders
2546 * (e.g. a message has been queued for writing).
2547 * When using Qt, this typically results in a call to QEventLoop::wakeUp().
2548 * When using GLib, it would call g_main_context_wakeup().
2551 * @param connection the connection.
2552 * @param wakeup_main_function function to wake up the mainloop
2553 * @param data data to pass wakeup_main_function
2554 * @param free_data_function function to be called to free the data.
2557 dbus_connection_set_wakeup_main_function (DBusConnection *connection,
2558 DBusWakeupMainFunction wakeup_main_function,
2560 DBusFreeFunction free_data_function)
2563 DBusFreeFunction old_free_data;
2565 _dbus_return_if_fail (connection != NULL);
2567 CONNECTION_LOCK (connection);
2568 old_data = connection->wakeup_main_data;
2569 old_free_data = connection->free_wakeup_main_data;
2571 connection->wakeup_main_function = wakeup_main_function;
2572 connection->wakeup_main_data = data;
2573 connection->free_wakeup_main_data = free_data_function;
2575 CONNECTION_UNLOCK (connection);
2577 /* Callback outside the lock */
2579 (*old_free_data) (old_data);
2583 * Set a function to be invoked when the dispatch status changes.
2584 * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
2585 * dbus_connection_dispatch() needs to be called to process incoming
2586 * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
2587 * from inside the DBusDispatchStatusFunction. Indeed, almost
2588 * any reentrancy in this function is a bad idea. Instead,
2589 * the DBusDispatchStatusFunction should simply save an indication
2590 * that messages should be dispatched later, when the main loop
2593 * @param connection the connection
2594 * @param function function to call on dispatch status changes
2595 * @param data data for function
2596 * @param free_data_function free the function data
2599 dbus_connection_set_dispatch_status_function (DBusConnection *connection,
2600 DBusDispatchStatusFunction function,
2602 DBusFreeFunction free_data_function)
2605 DBusFreeFunction old_free_data;
2607 _dbus_return_if_fail (connection != NULL);
2609 CONNECTION_LOCK (connection);
2610 old_data = connection->dispatch_status_data;
2611 old_free_data = connection->free_dispatch_status_data;
2613 connection->dispatch_status_function = function;
2614 connection->dispatch_status_data = data;
2615 connection->free_dispatch_status_data = free_data_function;
2617 CONNECTION_UNLOCK (connection);
2619 /* Callback outside the lock */
2621 (*old_free_data) (old_data);
2625 * Gets the UNIX user ID of the connection if any.
2626 * Returns #TRUE if the uid is filled in.
2627 * Always returns #FALSE on non-UNIX platforms.
2628 * Always returns #FALSE prior to authenticating the
2631 * @param connection the connection
2632 * @param uid return location for the user ID
2633 * @returns #TRUE if uid is filled in with a valid user ID
2636 dbus_connection_get_unix_user (DBusConnection *connection,
2641 _dbus_return_val_if_fail (connection != NULL, FALSE);
2642 _dbus_return_val_if_fail (uid != NULL, FALSE);
2644 CONNECTION_LOCK (connection);
2646 if (!_dbus_transport_get_is_authenticated (connection->transport))
2649 result = _dbus_transport_get_unix_user (connection->transport,
2651 CONNECTION_UNLOCK (connection);
2657 * Sets a predicate function used to determine whether a given user ID
2658 * is allowed to connect. When an incoming connection has
2659 * authenticated with a particular user ID, this function is called;
2660 * if it returns #TRUE, the connection is allowed to proceed,
2661 * otherwise the connection is disconnected.
2663 * If the function is set to #NULL (as it is by default), then
2664 * only the same UID as the server process will be allowed to
2667 * @param connection the connection
2668 * @param function the predicate
2669 * @param data data to pass to the predicate
2670 * @param free_data_function function to free the data
2673 dbus_connection_set_unix_user_function (DBusConnection *connection,
2674 DBusAllowUnixUserFunction function,
2676 DBusFreeFunction free_data_function)
2678 void *old_data = NULL;
2679 DBusFreeFunction old_free_function = NULL;
2681 _dbus_return_if_fail (connection != NULL);
2683 CONNECTION_LOCK (connection);
2684 _dbus_transport_set_unix_user_function (connection->transport,
2685 function, data, free_data_function,
2686 &old_data, &old_free_function);
2687 CONNECTION_UNLOCK (connection);
2689 if (old_free_function != NULL)
2690 (* old_free_function) (old_data);
2694 * Adds a message filter. Filters are handlers that are run on
2695 * all incoming messages, prior to the objects
2696 * registered with dbus_connection_register_object().
2697 * Filters are run in the order that they were added.
2698 * The same handler can be added as a filter more than once, in
2699 * which case it will be run more than once.
2700 * Filters added during a filter callback won't be run on the
2701 * message being processed.
2703 * The connection does NOT add a reference to the message handler;
2704 * instead, if the message handler is finalized, the connection simply
2705 * forgets about it. Thus the caller of this function must keep a
2706 * reference to the message handler.
2708 * @param connection the connection
2709 * @param handler the handler
2710 * @returns #TRUE on success, #FALSE if not enough memory.
2713 dbus_connection_add_filter (DBusConnection *connection,
2714 DBusMessageHandler *handler)
2716 _dbus_return_val_if_fail (connection != NULL, FALSE);
2717 _dbus_return_val_if_fail (handler != NULL, FALSE);
2719 CONNECTION_LOCK (connection);
2720 if (!_dbus_message_handler_add_connection (handler, connection))
2722 CONNECTION_UNLOCK (connection);
2726 if (!_dbus_list_append (&connection->filter_list,
2729 _dbus_message_handler_remove_connection (handler, connection);
2730 CONNECTION_UNLOCK (connection);
2734 CONNECTION_UNLOCK (connection);
2739 * Removes a previously-added message filter. It is a programming
2740 * error to call this function for a handler that has not
2741 * been added as a filter. If the given handler was added
2742 * more than once, only one instance of it will be removed
2743 * (the most recently-added instance).
2745 * @param connection the connection
2746 * @param handler the handler to remove
2750 dbus_connection_remove_filter (DBusConnection *connection,
2751 DBusMessageHandler *handler)
2753 _dbus_return_if_fail (connection != NULL);
2754 _dbus_return_if_fail (handler != NULL);
2756 CONNECTION_LOCK (connection);
2757 if (!_dbus_list_remove_last (&connection->filter_list, handler))
2759 _dbus_warn ("Tried to remove a DBusConnection filter that had not been added\n");
2760 CONNECTION_UNLOCK (connection);
2764 _dbus_message_handler_remove_connection (handler, connection);
2766 CONNECTION_UNLOCK (connection);
2770 * Registers an object with the connection. This object is assigned an
2771 * object ID, and will be visible under this ID and with the provided
2772 * interfaces to the peer application on the other end of the
2773 * connection. The object instance should be passed in as object_impl;
2774 * the instance can be any datatype, as long as it fits in a void*.
2776 * As a side effect of calling this function, the "registered"
2777 * callback in the #DBusObjectVTable will be invoked.
2779 * If the object is deleted, be sure to unregister it with
2780 * dbus_connection_unregister_object() or it will continue to get
2783 * @param connection the connection to register the instance with
2784 * @param interfaces #NULL-terminated array of interface names the instance supports
2785 * @param vtable virtual table of functions for manipulating the instance
2786 * @param object_impl object instance
2787 * @param object_id if non-#NULL, object ID to initialize with the new object's ID
2788 * @returns #FALSE if not enough memory to register the object instance
2791 dbus_connection_register_object (DBusConnection *connection,
2792 const char **interfaces,
2793 const DBusObjectVTable *vtable,
2795 DBusObjectID *object_id)
2797 _dbus_return_val_if_fail (connection != NULL, FALSE);
2798 _dbus_return_val_if_fail (vtable != NULL, FALSE);
2799 _dbus_return_val_if_fail (vtable->dbus_internal_pad1 == NULL, FALSE);
2800 _dbus_return_val_if_fail (vtable->dbus_internal_pad2 == NULL, FALSE);
2801 _dbus_return_val_if_fail (vtable->dbus_internal_pad3 == NULL, FALSE);
2803 CONNECTION_LOCK (connection);
2805 return _dbus_object_registry_add_and_unlock (connection->objects,
2813 * Reverses the effects of dbus_connection_register_object(),
2814 * and invokes the "unregistered" callback in the #DBusObjectVTable
2815 * for the given object. The passed-in object ID must be a valid,
2816 * registered object ID or the results are undefined.
2818 * @param connection the connection to unregister the object ID from
2819 * @param object_id the object ID to unregister
2822 dbus_connection_unregister_object (DBusConnection *connection,
2823 const DBusObjectID *object_id)
2825 _dbus_return_if_fail (connection != NULL);
2827 CONNECTION_LOCK (connection);
2829 return _dbus_object_registry_remove_and_unlock (connection->objects,
2833 static DBusDataSlotAllocator slot_allocator;
2834 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
2837 * Allocates an integer ID to be used for storing application-specific
2838 * data on any DBusConnection. The allocated ID may then be used
2839 * with dbus_connection_set_data() and dbus_connection_get_data().
2840 * The passed-in slot must be initialized to -1, and is filled in
2841 * with the slot ID. If the passed-in slot is not -1, it's assumed
2842 * to be already allocated, and its refcount is incremented.
2844 * The allocated slot is global, i.e. all DBusConnection objects will
2845 * have a slot with the given integer ID reserved.
2847 * @param slot_p address of a global variable storing the slot
2848 * @returns #FALSE on failure (no memory)
2851 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
2853 return _dbus_data_slot_allocator_alloc (&slot_allocator,
2854 _DBUS_LOCK_NAME (connection_slots),
2859 * Deallocates a global ID for connection data slots.
2860 * dbus_connection_get_data() and dbus_connection_set_data() may no
2861 * longer be used with this slot. Existing data stored on existing
2862 * DBusConnection objects will be freed when the connection is
2863 * finalized, but may not be retrieved (and may only be replaced if
2864 * someone else reallocates the slot). When the refcount on the
2865 * passed-in slot reaches 0, it is set to -1.
2867 * @param slot_p address storing the slot to deallocate
2870 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
2872 _dbus_return_if_fail (*slot_p >= 0);
2874 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
2878 * Stores a pointer on a DBusConnection, along
2879 * with an optional function to be used for freeing
2880 * the data when the data is set again, or when
2881 * the connection is finalized. The slot number
2882 * must have been allocated with dbus_connection_allocate_data_slot().
2884 * @param connection the connection
2885 * @param slot the slot number
2886 * @param data the data to store
2887 * @param free_data_func finalizer function for the data
2888 * @returns #TRUE if there was enough memory to store the data
2891 dbus_connection_set_data (DBusConnection *connection,
2894 DBusFreeFunction free_data_func)
2896 DBusFreeFunction old_free_func;
2900 _dbus_return_val_if_fail (connection != NULL, FALSE);
2901 _dbus_return_val_if_fail (slot >= 0, FALSE);
2903 CONNECTION_LOCK (connection);
2905 retval = _dbus_data_slot_list_set (&slot_allocator,
2906 &connection->slot_list,
2907 slot, data, free_data_func,
2908 &old_free_func, &old_data);
2910 CONNECTION_UNLOCK (connection);
2914 /* Do the actual free outside the connection lock */
2916 (* old_free_func) (old_data);
2923 * Retrieves data previously set with dbus_connection_set_data().
2924 * The slot must still be allocated (must not have been freed).
2926 * @param connection the connection
2927 * @param slot the slot to get data from
2928 * @returns the data, or #NULL if not found
2931 dbus_connection_get_data (DBusConnection *connection,
2936 _dbus_return_val_if_fail (connection != NULL, NULL);
2938 CONNECTION_LOCK (connection);
2940 res = _dbus_data_slot_list_get (&slot_allocator,
2941 &connection->slot_list,
2944 CONNECTION_UNLOCK (connection);
2950 * This function sets a global flag for whether dbus_connection_new()
2951 * will set SIGPIPE behavior to SIG_IGN.
2953 * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
2956 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
2958 _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
2962 * Specifies the maximum size message this connection is allowed to
2963 * receive. Larger messages will result in disconnecting the
2966 * @param connection a #DBusConnection
2967 * @param size maximum message size the connection can receive, in bytes
2970 dbus_connection_set_max_message_size (DBusConnection *connection,
2973 _dbus_return_if_fail (connection != NULL);
2975 CONNECTION_LOCK (connection);
2976 _dbus_transport_set_max_message_size (connection->transport,
2978 CONNECTION_UNLOCK (connection);
2982 * Gets the value set by dbus_connection_set_max_message_size().
2984 * @param connection the connection
2985 * @returns the max size of a single message
2988 dbus_connection_get_max_message_size (DBusConnection *connection)
2992 _dbus_return_val_if_fail (connection != NULL, 0);
2994 CONNECTION_LOCK (connection);
2995 res = _dbus_transport_get_max_message_size (connection->transport);
2996 CONNECTION_UNLOCK (connection);
3001 * Sets the maximum total number of bytes that can be used for all messages
3002 * received on this connection. Messages count toward the maximum until
3003 * they are finalized. When the maximum is reached, the connection will
3004 * not read more data until some messages are finalized.
3006 * The semantics of the maximum are: if outstanding messages are
3007 * already above the maximum, additional messages will not be read.
3008 * The semantics are not: if the next message would cause us to exceed
3009 * the maximum, we don't read it. The reason is that we don't know the
3010 * size of a message until after we read it.
3012 * Thus, the max live messages size can actually be exceeded
3013 * by up to the maximum size of a single message.
3015 * Also, if we read say 1024 bytes off the wire in a single read(),
3016 * and that contains a half-dozen small messages, we may exceed the
3017 * size max by that amount. But this should be inconsequential.
3019 * This does imply that we can't call read() with a buffer larger
3020 * than we're willing to exceed this limit by.
3022 * @param connection the connection
3023 * @param size the maximum size in bytes of all outstanding messages
3026 dbus_connection_set_max_received_size (DBusConnection *connection,
3029 _dbus_return_if_fail (connection != NULL);
3031 CONNECTION_LOCK (connection);
3032 _dbus_transport_set_max_received_size (connection->transport,
3034 CONNECTION_UNLOCK (connection);
3038 * Gets the value set by dbus_connection_set_max_received_size().
3040 * @param connection the connection
3041 * @returns the max size of all live messages
3044 dbus_connection_get_max_received_size (DBusConnection *connection)
3048 _dbus_return_val_if_fail (connection != NULL, 0);
3050 CONNECTION_LOCK (connection);
3051 res = _dbus_transport_get_max_received_size (connection->transport);
3052 CONNECTION_UNLOCK (connection);
3057 * Gets the approximate size in bytes of all messages in the outgoing
3058 * message queue. The size is approximate in that you shouldn't use
3059 * it to decide how many bytes to read off the network or anything
3060 * of that nature, as optimizations may choose to tell small white lies
3061 * to avoid performance overhead.
3063 * @param connection the connection
3064 * @returns the number of bytes that have been queued up but not sent
3067 dbus_connection_get_outgoing_size (DBusConnection *connection)
3071 _dbus_return_val_if_fail (connection != NULL, 0);
3073 CONNECTION_LOCK (connection);
3074 res = _dbus_counter_get_value (connection->outgoing_counter);
3075 CONNECTION_UNLOCK (connection);