1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-connection-internal.h DBusConnection internal interfaces
4 * Copyright (C) 2002 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #ifndef DBUS_CONNECTION_INTERNAL_H
24 #define DBUS_CONNECTION_INTERNAL_H
26 #include <dbus/dbus-internals.h>
27 #include <dbus/dbus-connection.h>
28 #include <dbus/dbus-message.h>
29 #include <dbus/dbus-transport.h>
30 #include <dbus/dbus-resources.h>
31 #include <dbus/dbus-list.h>
32 #include <dbus/dbus-timeout.h>
33 #include <dbus/dbus-dataslot.h>
39 DBUS_ITERATION_DO_WRITING = 1 << 0, /**< Write messages out. */
40 DBUS_ITERATION_DO_READING = 1 << 1, /**< Read messages in. */
41 DBUS_ITERATION_BLOCK = 1 << 2 /**< Block if nothing to do. */
44 /** default timeout value when waiting for a message reply, 25 seconds */
45 #define _DBUS_DEFAULT_TIMEOUT_VALUE (25 * 1000)
47 void _dbus_connection_lock (DBusConnection *connection);
48 void _dbus_connection_unlock (DBusConnection *connection);
49 DBusConnection * _dbus_connection_ref_unlocked (DBusConnection *connection);
50 void _dbus_connection_unref_unlocked (DBusConnection *connection);
51 dbus_bool_t _dbus_connection_queue_received_message (DBusConnection *connection,
52 DBusMessage *message);
53 void _dbus_connection_queue_received_message_link (DBusConnection *connection,
55 dbus_bool_t _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection);
56 DBusMessage* _dbus_connection_get_message_to_send (DBusConnection *connection);
57 void _dbus_connection_message_sent (DBusConnection *connection,
58 DBusMessage *message);
59 dbus_bool_t _dbus_connection_add_watch (DBusConnection *connection,
61 void _dbus_connection_remove_watch (DBusConnection *connection,
63 void _dbus_connection_toggle_watch (DBusConnection *connection,
66 dbus_bool_t _dbus_connection_handle_watch (DBusWatch *watch,
67 unsigned int condition,
69 dbus_bool_t _dbus_connection_add_timeout (DBusConnection *connection,
70 DBusTimeout *timeout);
71 void _dbus_connection_remove_timeout (DBusConnection *connection,
72 DBusTimeout *timeout);
73 void _dbus_connection_toggle_timeout (DBusConnection *connection,
76 DBusConnection* _dbus_connection_new_for_transport (DBusTransport *transport);
77 void _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
79 int timeout_milliseconds);
81 DBusPendingCall* _dbus_pending_call_new (DBusConnection *connection,
82 int timeout_milliseconds,
83 DBusTimeoutHandler timeout_handler);
84 void _dbus_pending_call_notify (DBusPendingCall *pending);
85 void _dbus_connection_remove_pending_call (DBusConnection *connection,
86 DBusPendingCall *pending);
87 DBusMessage* _dbus_connection_block_for_reply (DBusConnection *connection,
88 dbus_uint32_t client_serial,
89 int timeout_milliseconds);
90 void _dbus_pending_call_complete_and_unlock (DBusPendingCall *pending,
91 DBusMessage *message);
92 dbus_bool_t _dbus_connection_send_and_unlock (DBusConnection *connection,
94 dbus_uint32_t *client_serial);
97 * @addtogroup DBusPendingCallInternals DBusPendingCall implementation details
101 * @brief Internals of DBusPendingCall
103 * Object representing a reply message that we're waiting for.
105 struct DBusPendingCall
107 DBusAtomic refcount; /**< reference count */
109 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
111 DBusPendingCallNotifyFunction function; /**< Notifier when reply arrives. */
113 DBusConnection *connection; /**< Connections we're associated with */
114 DBusMessage *reply; /**< Reply (after we've received it) */
115 DBusTimeout *timeout; /**< Timeout */
117 DBusList *timeout_link; /**< Preallocated timeout response */
119 dbus_uint32_t reply_serial; /**< Expected serial of reply */
121 unsigned int completed : 1; /**< TRUE if completed */
122 unsigned int timeout_added : 1; /**< Have added the timeout */
125 /** @} End of DBusPendingCallInternals */
130 #endif /* DBUS_CONNECTION_INTERNAL_H */