1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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()).
72 /* Internal to libdbus, there is also _DBUS_WATCH_NVAL in dbus-watch.h */
76 * Indicates the status of incoming data on a #DBusConnection. This determines whether
77 * dbus_connection_dispatch() needs to be called.
81 DBUS_DISPATCH_DATA_REMAINS, /**< There is more data to potentially convert to messages. */
82 DBUS_DISPATCH_COMPLETE, /**< All currently available data has been processed. */
83 DBUS_DISPATCH_NEED_MEMORY /**< More memory is needed to continue. */
86 /** Called when libdbus needs a new watch to be monitored by the main
87 * loop. Returns #FALSE if it lacks enough memory to add the
88 * watch. Set by dbus_connection_set_watch_functions() or
89 * dbus_server_set_watch_functions().
91 typedef dbus_bool_t (* DBusAddWatchFunction) (DBusWatch *watch,
93 /** Called when dbus_watch_get_enabled() may return a different value
94 * than it did before. Set by dbus_connection_set_watch_functions()
95 * or dbus_server_set_watch_functions().
97 typedef void (* DBusWatchToggledFunction) (DBusWatch *watch,
99 /** Called when libdbus no longer needs a watch to be monitored by the
100 * main loop. Set by dbus_connection_set_watch_functions() or
101 * dbus_server_set_watch_functions().
103 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch,
105 /** Called when libdbus needs a new timeout to be monitored by the main
106 * loop. Returns #FALSE if it lacks enough memory to add the
107 * watch. Set by dbus_connection_set_timeout_functions() or
108 * dbus_server_set_timeout_functions().
110 typedef dbus_bool_t (* DBusAddTimeoutFunction) (DBusTimeout *timeout,
112 /** Called when dbus_timeout_get_enabled() may return a different
113 * value than it did before.
114 * Set by dbus_connection_set_timeout_functions() or
115 * dbus_server_set_timeout_functions().
117 typedef void (* DBusTimeoutToggledFunction) (DBusTimeout *timeout,
119 /** Called when libdbus no longer needs a timeout to be monitored by the
120 * main loop. Set by dbus_connection_set_timeout_functions() or
121 * dbus_server_set_timeout_functions().
123 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout,
125 /** Called when the return value of dbus_connection_get_dispatch_status()
126 * may have changed. Set with dbus_connection_set_dispatch_status_function().
128 typedef void (* DBusDispatchStatusFunction) (DBusConnection *connection,
129 DBusDispatchStatus new_status,
132 * Called when the main loop's thread should be notified that there's now work
133 * to do. Set with dbus_connection_set_wakeup_main_function().
135 typedef void (* DBusWakeupMainFunction) (void *data);
138 * Called during authentication to check whether the given UNIX user
139 * ID is allowed to connect, if the client tried to auth as a UNIX
140 * user ID. Normally on Windows this would never happen. Set with
141 * dbus_connection_set_unix_user_function().
143 typedef dbus_bool_t (* DBusAllowUnixUserFunction) (DBusConnection *connection,
148 * Called during authentication to check whether the given Windows user
149 * ID is allowed to connect, if the client tried to auth as a Windows
150 * user ID. Normally on UNIX this would never happen. Set with
151 * dbus_connection_set_windows_user_function().
153 typedef dbus_bool_t (* DBusAllowWindowsUserFunction) (DBusConnection *connection,
154 const char *user_sid,
159 * Called when a pending call now has a reply available. Set with
160 * dbus_pending_call_set_notify().
162 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending,
166 * Called when a message needs to be handled. The result indicates whether or
167 * not more handlers should be run. Set with dbus_connection_add_filter().
169 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection *connection,
170 DBusMessage *message,
173 DBusConnection* dbus_connection_open (const char *address,
176 DBusConnection* dbus_connection_open_private (const char *address,
179 DBusConnection* dbus_connection_ref (DBusConnection *connection);
181 void dbus_connection_unref (DBusConnection *connection);
183 void dbus_connection_close (DBusConnection *connection);
185 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
187 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
189 dbus_bool_t dbus_connection_set_is_authenticated (DBusConnection *connection);
191 dbus_bool_t dbus_connection_get_is_anonymous (DBusConnection *connection);
193 char* dbus_connection_get_server_id (DBusConnection *connection);
195 dbus_bool_t dbus_connection_can_send_type (DBusConnection *connection,
199 void dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
200 dbus_bool_t exit_on_disconnect);
202 void dbus_connection_flush (DBusConnection *connection);
204 dbus_bool_t dbus_connection_read_write_dispatch (DBusConnection *connection,
205 int timeout_milliseconds);
207 dbus_bool_t dbus_connection_read_write (DBusConnection *connection,
208 int timeout_milliseconds);
210 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
212 void dbus_connection_return_message (DBusConnection *connection,
213 DBusMessage *message);
215 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
216 DBusMessage *message);
218 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
220 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection);
222 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection);
224 dbus_bool_t dbus_connection_has_messages_to_send (DBusConnection *connection);
226 dbus_bool_t dbus_connection_send (DBusConnection *connection,
227 DBusMessage *message,
228 dbus_uint32_t *client_serial);
230 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
231 DBusMessage *message,
232 DBusPendingCall **pending_return,
233 int timeout_milliseconds);
235 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection,
236 DBusMessage *message,
237 int timeout_milliseconds,
240 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection,
241 DBusAddWatchFunction add_function,
242 DBusRemoveWatchFunction remove_function,
243 DBusWatchToggledFunction toggled_function,
245 DBusFreeFunction free_data_function);
247 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection,
248 DBusAddTimeoutFunction add_function,
249 DBusRemoveTimeoutFunction remove_function,
250 DBusTimeoutToggledFunction toggled_function,
252 DBusFreeFunction free_data_function);
254 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
255 DBusWakeupMainFunction wakeup_main_function,
257 DBusFreeFunction free_data_function);
259 void dbus_connection_set_dispatch_status_function (DBusConnection *connection,
260 DBusDispatchStatusFunction function,
262 DBusFreeFunction free_data_function);
264 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection,
267 dbus_bool_t dbus_connection_get_unix_process_id (DBusConnection *connection,
270 dbus_bool_t dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
272 dbus_int32_t *data_size);
274 void dbus_connection_set_unix_user_function (DBusConnection *connection,
275 DBusAllowUnixUserFunction function,
277 DBusFreeFunction free_data_function);
279 dbus_bool_t dbus_connection_get_windows_user (DBusConnection *connection,
280 char **windows_sid_p);
282 void dbus_connection_set_windows_user_function (DBusConnection *connection,
283 DBusAllowWindowsUserFunction function,
285 DBusFreeFunction free_data_function);
287 void dbus_connection_set_allow_anonymous (DBusConnection *connection,
290 void dbus_connection_set_route_peer_messages (DBusConnection *connection,
297 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
298 DBusHandleMessageFunction function,
300 DBusFreeFunction free_data_function);
302 void dbus_connection_remove_filter (DBusConnection *connection,
303 DBusHandleMessageFunction function,
309 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p);
311 void dbus_connection_free_data_slot (dbus_int32_t *slot_p);
313 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
316 DBusFreeFunction free_data_func);
318 void* dbus_connection_get_data (DBusConnection *connection,
322 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
325 void dbus_connection_set_max_message_size (DBusConnection *connection,
328 long dbus_connection_get_max_message_size (DBusConnection *connection);
330 void dbus_connection_set_max_received_size (DBusConnection *connection,
333 long dbus_connection_get_max_received_size (DBusConnection *connection);
336 void dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
339 long dbus_connection_get_max_message_unix_fds (DBusConnection *connection);
341 void dbus_connection_set_max_received_unix_fds(DBusConnection *connection,
344 long dbus_connection_get_max_received_unix_fds(DBusConnection *connection);
347 long dbus_connection_get_outgoing_size (DBusConnection *connection);
349 long dbus_connection_get_outgoing_unix_fds (DBusConnection *connection);
352 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
354 void dbus_connection_free_preallocated_send (DBusConnection *connection,
355 DBusPreallocatedSend *preallocated);
357 void dbus_connection_send_preallocated (DBusConnection *connection,
358 DBusPreallocatedSend *preallocated,
359 DBusMessage *message,
360 dbus_uint32_t *client_serial);
363 /* Object tree functionality */
366 * Called when a #DBusObjectPathVTable is unregistered (or its connection is freed).
367 * Found in #DBusObjectPathVTable.
369 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection,
372 * Called when a message is sent to a registered object path. Found in
373 * #DBusObjectPathVTable which is registered with dbus_connection_register_object_path()
374 * or dbus_connection_register_fallback().
376 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection,
377 DBusMessage *message,
381 * Virtual table that must be implemented to handle a portion of the
382 * object path hierarchy. Attach the vtable to a particular path using
383 * dbus_connection_register_object_path() or
384 * dbus_connection_register_fallback().
386 struct DBusObjectPathVTable
388 DBusObjectPathUnregisterFunction unregister_function; /**< Function to unregister this handler */
389 DBusObjectPathMessageFunction message_function; /**< Function to handle messages */
391 void (* dbus_internal_pad1) (void *); /**< Reserved for future expansion */
392 void (* dbus_internal_pad2) (void *); /**< Reserved for future expansion */
393 void (* dbus_internal_pad3) (void *); /**< Reserved for future expansion */
394 void (* dbus_internal_pad4) (void *); /**< Reserved for future expansion */
398 dbus_bool_t dbus_connection_try_register_object_path (DBusConnection *connection,
400 const DBusObjectPathVTable *vtable,
405 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection,
407 const DBusObjectPathVTable *vtable,
411 dbus_bool_t dbus_connection_try_register_fallback (DBusConnection *connection,
413 const DBusObjectPathVTable *vtable,
418 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection,
420 const DBusObjectPathVTable *vtable,
423 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection *connection,
427 dbus_bool_t dbus_connection_get_object_path_data (DBusConnection *connection,
432 dbus_bool_t dbus_connection_list_registered (DBusConnection *connection,
433 const char *parent_path,
434 char ***child_entries);
437 dbus_bool_t dbus_connection_get_unix_fd (DBusConnection *connection,
440 dbus_bool_t dbus_connection_get_socket (DBusConnection *connection,
447 * @addtogroup DBusWatch
451 #ifndef DBUS_DISABLE_DEPRECATED
453 DBUS_DEPRECATED int dbus_watch_get_fd (DBusWatch *watch);
457 int dbus_watch_get_unix_fd (DBusWatch *watch);
459 int dbus_watch_get_socket (DBusWatch *watch);
461 unsigned int dbus_watch_get_flags (DBusWatch *watch);
463 void* dbus_watch_get_data (DBusWatch *watch);
465 void dbus_watch_set_data (DBusWatch *watch,
467 DBusFreeFunction free_data_function);
469 dbus_bool_t dbus_watch_handle (DBusWatch *watch,
472 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch);
477 * @addtogroup DBusTimeout
482 int dbus_timeout_get_interval (DBusTimeout *timeout);
484 void* dbus_timeout_get_data (DBusTimeout *timeout);
486 void dbus_timeout_set_data (DBusTimeout *timeout,
488 DBusFreeFunction free_data_function);
490 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout);
492 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout);
498 #endif /* DBUS_CONNECTION_H */