1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-connection.h DBusConnection object
4 * Copyright (C) 2002, 2003 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 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
27 #ifndef DBUS_CONNECTION_H
28 #define DBUS_CONNECTION_H
30 #include <dbus/dbus-errors.h>
31 #include <dbus/dbus-memory.h>
32 #include <dbus/dbus-message.h>
33 #include <dbus/dbus-shared.h>
37 typedef struct DBusWatch DBusWatch;
38 typedef struct DBusTimeout DBusTimeout;
39 typedef struct DBusPreallocatedSend DBusPreallocatedSend;
40 typedef struct DBusPendingCall DBusPendingCall;
41 typedef struct DBusConnection DBusConnection;
42 typedef struct DBusObjectPathVTable DBusObjectPathVTable;
46 DBUS_WATCH_READABLE = 1 << 0, /**< As in POLLIN */
47 DBUS_WATCH_WRITABLE = 1 << 1, /**< As in POLLOUT */
48 DBUS_WATCH_ERROR = 1 << 2, /**< As in POLLERR (can't watch for this, but
49 * the flag can be passed to dbus_watch_handle()).
51 DBUS_WATCH_HANGUP = 1 << 3 /**< As in POLLHUP (can't watch for it, but
52 * can be present in current state). */
57 DBUS_DISPATCH_DATA_REMAINS, /**< There is more data to potentially convert to messages. */
58 DBUS_DISPATCH_COMPLETE, /**< All currently available data has been processed. */
59 DBUS_DISPATCH_NEED_MEMORY /**< More memory is needed to continue. */
62 typedef dbus_bool_t (* DBusAddWatchFunction) (DBusWatch *watch,
64 typedef void (* DBusWatchToggledFunction) (DBusWatch *watch,
66 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch,
68 typedef dbus_bool_t (* DBusAddTimeoutFunction) (DBusTimeout *timeout,
70 typedef void (* DBusTimeoutToggledFunction) (DBusTimeout *timeout,
72 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout,
74 typedef void (* DBusDispatchStatusFunction) (DBusConnection *connection,
75 DBusDispatchStatus new_status,
77 typedef void (* DBusWakeupMainFunction) (void *data);
78 typedef dbus_bool_t (* DBusAllowUnixUserFunction) (DBusConnection *connection,
82 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending,
86 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection *connection,
90 DBusConnection* dbus_connection_open (const char *address,
92 DBusConnection* dbus_connection_open_private (const char *address,
94 DBusConnection* dbus_connection_ref (DBusConnection *connection);
95 void dbus_connection_unref (DBusConnection *connection);
96 void dbus_connection_disconnect (DBusConnection *connection);
97 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
98 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
99 void dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
100 dbus_bool_t exit_on_disconnect);
101 void dbus_connection_flush (DBusConnection *connection);
102 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
103 void dbus_connection_return_message (DBusConnection *connection,
104 DBusMessage *message);
105 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
106 DBusMessage *message);
107 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
108 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection);
109 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection);
110 dbus_bool_t dbus_connection_has_messages_to_send (DBusConnection *connection);
111 dbus_bool_t dbus_connection_send (DBusConnection *connection,
112 DBusMessage *message,
113 dbus_uint32_t *client_serial);
114 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
115 DBusMessage *message,
116 DBusPendingCall **pending_return,
117 int timeout_milliseconds);
118 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection,
119 DBusMessage *message,
120 int timeout_milliseconds,
122 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection,
123 DBusAddWatchFunction add_function,
124 DBusRemoveWatchFunction remove_function,
125 DBusWatchToggledFunction toggled_function,
127 DBusFreeFunction free_data_function);
128 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection,
129 DBusAddTimeoutFunction add_function,
130 DBusRemoveTimeoutFunction remove_function,
131 DBusTimeoutToggledFunction toggled_function,
133 DBusFreeFunction free_data_function);
134 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
135 DBusWakeupMainFunction wakeup_main_function,
137 DBusFreeFunction free_data_function);
138 void dbus_connection_set_dispatch_status_function (DBusConnection *connection,
139 DBusDispatchStatusFunction function,
141 DBusFreeFunction free_data_function);
142 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection,
144 dbus_bool_t dbus_connection_get_unix_process_id (DBusConnection *connection,
146 void dbus_connection_set_unix_user_function (DBusConnection *connection,
147 DBusAllowUnixUserFunction function,
149 DBusFreeFunction free_data_function);
152 int dbus_watch_get_fd (DBusWatch *watch);
153 unsigned int dbus_watch_get_flags (DBusWatch *watch);
154 void* dbus_watch_get_data (DBusWatch *watch);
155 void dbus_watch_set_data (DBusWatch *watch,
157 DBusFreeFunction free_data_function);
158 dbus_bool_t dbus_watch_handle (DBusWatch *watch,
160 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch);
162 int dbus_timeout_get_interval (DBusTimeout *timeout);
163 void* dbus_timeout_get_data (DBusTimeout *timeout);
164 void dbus_timeout_set_data (DBusTimeout *timeout,
166 DBusFreeFunction free_data_function);
167 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout);
168 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout);
172 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
173 DBusHandleMessageFunction function,
175 DBusFreeFunction free_data_function);
176 void dbus_connection_remove_filter (DBusConnection *connection,
177 DBusHandleMessageFunction function,
182 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p);
183 void dbus_connection_free_data_slot (dbus_int32_t *slot_p);
184 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
187 DBusFreeFunction free_data_func);
188 void* dbus_connection_get_data (DBusConnection *connection,
191 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
193 void dbus_connection_set_max_message_size (DBusConnection *connection,
195 long dbus_connection_get_max_message_size (DBusConnection *connection);
196 void dbus_connection_set_max_received_size (DBusConnection *connection,
198 long dbus_connection_get_max_received_size (DBusConnection *connection);
199 long dbus_connection_get_outgoing_size (DBusConnection *connection);
201 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
202 void dbus_connection_free_preallocated_send (DBusConnection *connection,
203 DBusPreallocatedSend *preallocated);
204 void dbus_connection_send_preallocated (DBusConnection *connection,
205 DBusPreallocatedSend *preallocated,
206 DBusMessage *message,
207 dbus_uint32_t *client_serial);
210 /* Object tree functionality */
212 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection,
214 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection,
215 DBusMessage *message,
219 * Virtual table that must be implemented to handle a portion of the
220 * object path hierarchy.
222 struct DBusObjectPathVTable
224 DBusObjectPathUnregisterFunction unregister_function; /**< Function to unregister this handler */
225 DBusObjectPathMessageFunction message_function; /**< Function to handle messages */
227 void (* dbus_internal_pad1) (void *); /**< Reserved for future expansion */
228 void (* dbus_internal_pad2) (void *); /**< Reserved for future expansion */
229 void (* dbus_internal_pad3) (void *); /**< Reserved for future expansion */
230 void (* dbus_internal_pad4) (void *); /**< Reserved for future expansion */
233 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection,
235 const DBusObjectPathVTable *vtable,
237 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection,
239 const DBusObjectPathVTable *vtable,
241 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection *connection,
244 dbus_bool_t dbus_connection_list_registered (DBusConnection *connection,
245 const char *parent_path,
246 char ***child_entries);
248 dbus_bool_t dbus_connection_get_unix_fd (DBusConnection *connection,
253 #endif /* DBUS_CONNECTION_H */