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>
38 * @addtogroup DBusConnection
42 /* documented in dbus-watch.c */
43 typedef struct DBusWatch DBusWatch;
44 /* documented in dbus-timeout.c */
45 typedef struct DBusTimeout DBusTimeout;
46 /** Opaque type representing preallocated resources so a message can be sent without further memory allocation. */
47 typedef struct DBusPreallocatedSend DBusPreallocatedSend;
48 /** Opaque type representing a method call that has not yet received a reply. */
49 typedef struct DBusPendingCall DBusPendingCall;
50 /** Opaque type representing a connection to a remote application and associated incoming/outgoing message queues. */
51 typedef struct DBusConnection DBusConnection;
52 /** Set of functions that must be implemented to handle messages sent to a particular object path. */
53 typedef struct DBusObjectPathVTable DBusObjectPathVTable;
56 * Indicates the status of a #DBusWatch.
60 DBUS_WATCH_READABLE = 1 << 0, /**< As in POLLIN */
61 DBUS_WATCH_WRITABLE = 1 << 1, /**< As in POLLOUT */
62 DBUS_WATCH_ERROR = 1 << 2, /**< As in POLLERR (can't watch for
63 * this, but can be present in
64 * current state passed to
65 * dbus_watch_handle()).
67 DBUS_WATCH_HANGUP = 1 << 3 /**< As in POLLHUP (can't watch for
68 * it, but can be present in current
70 * dbus_watch_handle()).
75 * Indicates the status of incoming data on a #DBusConnection. This determines whether
76 * dbus_connection_dispatch() needs to be called.
80 DBUS_DISPATCH_DATA_REMAINS, /**< There is more data to potentially convert to messages. */
81 DBUS_DISPATCH_COMPLETE, /**< All currently available data has been processed. */
82 DBUS_DISPATCH_NEED_MEMORY /**< More memory is needed to continue. */
85 /** Called when libdbus needs a new watch to be monitored by the main
86 * loop. Returns #FALSE if it lacks enough memory to add the
87 * watch. Set by dbus_connection_set_watch_functions() or
88 * dbus_server_set_watch_functions().
90 typedef dbus_bool_t (* DBusAddWatchFunction) (DBusWatch *watch,
92 /** Called when dbus_watch_get_enabled() may return a different value
93 * than it did before. Set by dbus_connection_set_watch_functions()
94 * or dbus_server_set_watch_functions().
96 typedef void (* DBusWatchToggledFunction) (DBusWatch *watch,
98 /** Called when libdbus no longer needs a watch to be monitored by the
99 * main loop. Set by dbus_connection_set_watch_functions() or
100 * dbus_server_set_watch_functions().
102 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch,
104 /** Called when libdbus needs a new timeout to be monitored by the main
105 * loop. Returns #FALSE if it lacks enough memory to add the
106 * watch. Set by dbus_connection_set_timeout_functions() or
107 * dbus_server_set_timeout_functions().
109 typedef dbus_bool_t (* DBusAddTimeoutFunction) (DBusTimeout *timeout,
111 /** Called when dbus_timeout_get_enabled() may return a different
112 * value than it did before.
113 * Set by dbus_connection_set_timeout_functions() or
114 * dbus_server_set_timeout_functions().
116 typedef void (* DBusTimeoutToggledFunction) (DBusTimeout *timeout,
118 /** Called when libdbus no longer needs a timeout to be monitored by the
119 * main loop. Set by dbus_connection_set_timeout_functions() or
120 * dbus_server_set_timeout_functions().
122 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout,
124 /** Called when the return value of dbus_connection_get_dispatch_status()
125 * may have changed. Set with dbus_connection_set_dispatch_status_function().
127 typedef void (* DBusDispatchStatusFunction) (DBusConnection *connection,
128 DBusDispatchStatus new_status,
131 * Called when the main loop's thread should be notified that there's now work
132 * to do. Set with dbus_connection_set_wakeup_main_function().
134 typedef void (* DBusWakeupMainFunction) (void *data);
136 * Called during authentication on UNIX systems to check whether the given
137 * user ID is allowed to connect. Never called on Windows. Set with
138 * dbus_connection_set_unix_user_function().
140 typedef dbus_bool_t (* DBusAllowUnixUserFunction) (DBusConnection *connection,
144 * Called when a pending call now has a reply available. Set with
145 * dbus_pending_call_set_notify().
147 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending,
151 * Called when a message needs to be handled. The result indicates whether or
152 * not more handlers should be run. Set with dbus_connection_add_filter().
154 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection *connection,
155 DBusMessage *message,
158 DBusConnection* dbus_connection_open (const char *address,
160 DBusConnection* dbus_connection_open_private (const char *address,
162 DBusConnection* dbus_connection_ref (DBusConnection *connection);
163 void dbus_connection_unref (DBusConnection *connection);
164 void dbus_connection_close (DBusConnection *connection);
165 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
166 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
167 void dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
168 dbus_bool_t exit_on_disconnect);
169 void dbus_connection_flush (DBusConnection *connection);
170 dbus_bool_t dbus_connection_read_write_dispatch (DBusConnection *connection,
171 int timeout_milliseconds);
172 dbus_bool_t dbus_connection_read_write (DBusConnection *connection,
173 int timeout_milliseconds);
174 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
175 void dbus_connection_return_message (DBusConnection *connection,
176 DBusMessage *message);
177 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
178 DBusMessage *message);
179 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
180 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection);
181 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection);
182 dbus_bool_t dbus_connection_has_messages_to_send (DBusConnection *connection);
183 dbus_bool_t dbus_connection_send (DBusConnection *connection,
184 DBusMessage *message,
185 dbus_uint32_t *client_serial);
186 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
187 DBusMessage *message,
188 DBusPendingCall **pending_return,
189 int timeout_milliseconds);
190 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection,
191 DBusMessage *message,
192 int timeout_milliseconds,
194 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection,
195 DBusAddWatchFunction add_function,
196 DBusRemoveWatchFunction remove_function,
197 DBusWatchToggledFunction toggled_function,
199 DBusFreeFunction free_data_function);
200 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection,
201 DBusAddTimeoutFunction add_function,
202 DBusRemoveTimeoutFunction remove_function,
203 DBusTimeoutToggledFunction toggled_function,
205 DBusFreeFunction free_data_function);
206 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
207 DBusWakeupMainFunction wakeup_main_function,
209 DBusFreeFunction free_data_function);
210 void dbus_connection_set_dispatch_status_function (DBusConnection *connection,
211 DBusDispatchStatusFunction function,
213 DBusFreeFunction free_data_function);
214 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection,
216 dbus_bool_t dbus_connection_get_unix_process_id (DBusConnection *connection,
218 void dbus_connection_set_unix_user_function (DBusConnection *connection,
219 DBusAllowUnixUserFunction function,
221 DBusFreeFunction free_data_function);
222 void dbus_connection_set_route_peer_messages (DBusConnection *connection,
226 int dbus_watch_get_fd (DBusWatch *watch);
227 unsigned int dbus_watch_get_flags (DBusWatch *watch);
228 void* dbus_watch_get_data (DBusWatch *watch);
229 void dbus_watch_set_data (DBusWatch *watch,
231 DBusFreeFunction free_data_function);
232 dbus_bool_t dbus_watch_handle (DBusWatch *watch,
234 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch);
236 int dbus_timeout_get_interval (DBusTimeout *timeout);
237 void* dbus_timeout_get_data (DBusTimeout *timeout);
238 void dbus_timeout_set_data (DBusTimeout *timeout,
240 DBusFreeFunction free_data_function);
241 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout);
242 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout);
246 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
247 DBusHandleMessageFunction function,
249 DBusFreeFunction free_data_function);
250 void dbus_connection_remove_filter (DBusConnection *connection,
251 DBusHandleMessageFunction function,
256 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p);
257 void dbus_connection_free_data_slot (dbus_int32_t *slot_p);
258 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
261 DBusFreeFunction free_data_func);
262 void* dbus_connection_get_data (DBusConnection *connection,
265 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
267 void dbus_connection_set_max_message_size (DBusConnection *connection,
269 long dbus_connection_get_max_message_size (DBusConnection *connection);
270 void dbus_connection_set_max_received_size (DBusConnection *connection,
272 long dbus_connection_get_max_received_size (DBusConnection *connection);
273 long dbus_connection_get_outgoing_size (DBusConnection *connection);
275 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
276 void dbus_connection_free_preallocated_send (DBusConnection *connection,
277 DBusPreallocatedSend *preallocated);
278 void dbus_connection_send_preallocated (DBusConnection *connection,
279 DBusPreallocatedSend *preallocated,
280 DBusMessage *message,
281 dbus_uint32_t *client_serial);
284 /* Object tree functionality */
287 * Called when a #DBusObjectPathVTable is unregistered (or its connection is freed).
288 * Found in #DBusObjectPathVTable.
290 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection,
293 * Called when a message is sent to a registered object path. Found in
294 * #DBusObjectPathVTable which is registered with dbus_connection_register_object_path()
295 * or dbus_connection_register_fallback().
297 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection,
298 DBusMessage *message,
302 * Virtual table that must be implemented to handle a portion of the
303 * object path hierarchy. Attach the vtable to a particular path using
304 * dbus_connection_register_object_path() or
305 * dbus_connection_register_fallback().
307 struct DBusObjectPathVTable
309 DBusObjectPathUnregisterFunction unregister_function; /**< Function to unregister this handler */
310 DBusObjectPathMessageFunction message_function; /**< Function to handle messages */
312 void (* dbus_internal_pad1) (void *); /**< Reserved for future expansion */
313 void (* dbus_internal_pad2) (void *); /**< Reserved for future expansion */
314 void (* dbus_internal_pad3) (void *); /**< Reserved for future expansion */
315 void (* dbus_internal_pad4) (void *); /**< Reserved for future expansion */
318 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection,
320 const DBusObjectPathVTable *vtable,
322 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection,
324 const DBusObjectPathVTable *vtable,
326 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection *connection,
329 dbus_bool_t dbus_connection_get_object_path_data (DBusConnection *connection,
333 dbus_bool_t dbus_connection_list_registered (DBusConnection *connection,
334 const char *parent_path,
335 char ***child_entries);
337 dbus_bool_t dbus_connection_get_unix_fd (DBusConnection *connection,
339 dbus_bool_t dbus_connection_get_socket (DBusConnection *connection,
342 char* dbus_get_local_machine_id (void);
348 #endif /* DBUS_CONNECTION_H */