1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ 2 /* dbus-connection.h DBusConnection object 3 * 4 * Copyright (C) 2002, 2003 Red Hat Inc. 5 * 6 * Licensed under the Academic Free License version 2.1 7 * 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. 12 * 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. 17 * 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 21 * 22 */ 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." 25 #endif 26 27 #ifndef DBUS_CONNECTION_H 28 #define DBUS_CONNECTION_H 29 30 #include <dbus/dbus-errors.h> 31 #include <dbus/dbus-memory.h> 32 #include <dbus/dbus-message.h> 33 #include <dbus/dbus-shared.h> 34 35 DBUS_BEGIN_DECLS 36 37 /** 38 * @addtogroup DBusConnection 39 * @{ 40 */ 41 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; 54 55 /** 56 * Indicates the status of a #DBusWatch. 57 */ 58 typedef enum 59 { 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()). 66 */ 67 DBUS_WATCH_HANGUP = 1 << 3 /**< As in POLLHUP (can't watch for 68 * it, but can be present in current 69 * state passed to 70 * dbus_watch_handle()). 71 */ 72 } DBusWatchFlags; 73 74 /** 75 * Indicates the status of incoming data on a #DBusConnection. This determines whether 76 * dbus_connection_dispatch() needs to be called. 77 */ 78 typedef enum 79 { 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. */ 83 } DBusDispatchStatus; 84 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(). 89 */ 90 typedef dbus_bool_t (* DBusAddWatchFunction) (DBusWatch *watch, 91 void *data); 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(). 95 */ 96 typedef void (* DBusWatchToggledFunction) (DBusWatch *watch, 97 void *data); 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(). 101 */ 102 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch, 103 void *data); 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(). 108 */ 109 typedef dbus_bool_t (* DBusAddTimeoutFunction) (DBusTimeout *timeout, 110 void *data); 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(). 115 */ 116 typedef void (* DBusTimeoutToggledFunction) (DBusTimeout *timeout, 117 void *data); 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(). 121 */ 122 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout, 123 void *data); 124 /** Called when the return value of dbus_connection_get_dispatch_status() 125 * may have changed. Set with dbus_connection_set_dispatch_status_function(). 126 */ 127 typedef void (* DBusDispatchStatusFunction) (DBusConnection *connection, 128 DBusDispatchStatus new_status, 129 void *data); 130 /** 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(). 133 */ 134 typedef void (* DBusWakeupMainFunction) (void *data); 135 136 /** 137 * Called during authentication to check whether the given UNIX user 138 * ID is allowed to connect, if the client tried to auth as a UNIX 139 * user ID. Normally on Windows this would never happen. Set with 140 * dbus_connection_set_unix_user_function(). 141 */ 142 typedef dbus_bool_t (* DBusAllowUnixUserFunction) (DBusConnection *connection, 143 unsigned long uid, 144 void *data); 145 146 /** 147 * Called during authentication to check whether the given Windows user 148 * ID is allowed to connect, if the client tried to auth as a Windows 149 * user ID. Normally on UNIX this would never happen. Set with 150 * dbus_connection_set_windows_user_function(). 151 */ 152 typedef dbus_bool_t (* DBusAllowWindowsUserFunction) (DBusConnection *connection, 153 const char *user_sid, 154 void *data); 155 156 157 /** 158 * Called when a pending call now has a reply available. Set with 159 * dbus_pending_call_set_notify(). 160 */ 161 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending, 162 void *user_data); 163 164 /** 165 * Called when a message needs to be handled. The result indicates whether or 166 * not more handlers should be run. Set with dbus_connection_add_filter(). 167 */ 168 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection *connection, 169 DBusMessage *message, 170 void *user_data); 171 DBUS_EXPORT 172 DBusConnection* dbus_connection_open (const char *address, 173 DBusError *error); 174 DBUS_EXPORT 175 DBusConnection* dbus_connection_open_private (const char *address, 176 DBusError *error); 177 DBUS_EXPORT 178 DBusConnection* dbus_connection_ref (DBusConnection *connection); 179 DBUS_EXPORT 180 void dbus_connection_unref (DBusConnection *connection); 181 DBUS_EXPORT 182 void dbus_connection_close (DBusConnection *connection); 183 DBUS_EXPORT 184 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection); 185 DBUS_EXPORT 186 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection); 187 DBUS_EXPORT 188 dbus_bool_t dbus_connection_get_is_anonymous (DBusConnection *connection); 189 DBUS_EXPORT 190 char* dbus_connection_get_server_id (DBusConnection *connection); 191 DBUS_EXPORT 192 dbus_bool_t dbus_connection_can_send_type (DBusConnection *connection, 193 int type); 194 195 DBUS_EXPORT 196 void dbus_connection_set_exit_on_disconnect (DBusConnection *connection, 197 dbus_bool_t exit_on_disconnect); 198 DBUS_EXPORT 199 void dbus_connection_flush (DBusConnection *connection); 200 DBUS_EXPORT 201 dbus_bool_t dbus_connection_read_write_dispatch (DBusConnection *connection, 202 int timeout_milliseconds); 203 DBUS_EXPORT 204 dbus_bool_t dbus_connection_read_write_dispatch_greedy (DBusConnection *connection, 205 int timeout_milliseconds); 206 DBUS_EXPORT 207 dbus_bool_t dbus_connection_read_write (DBusConnection *connection, 208 int timeout_milliseconds); 209 DBUS_EXPORT 210 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection); 211 DBUS_EXPORT 212 void dbus_connection_return_message (DBusConnection *connection, 213 DBusMessage *message); 214 DBUS_EXPORT 215 void dbus_connection_steal_borrowed_message (DBusConnection *connection, 216 DBusMessage *message); 217 DBUS_EXPORT 218 DBusMessage* dbus_connection_pop_message (DBusConnection *connection); 219 DBUS_EXPORT 220 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection); 221 DBUS_EXPORT 222 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection); 223 DBUS_EXPORT 224 dbus_bool_t dbus_connection_has_messages_to_send (DBusConnection *connection); 225 DBUS_EXPORT 226 dbus_bool_t dbus_connection_send (DBusConnection *connection, 227 DBusMessage *message, 228 dbus_uint32_t *client_serial); 229 DBUS_EXPORT 230 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection, 231 DBusMessage *message, 232 DBusPendingCall **pending_return, 233 int timeout_milliseconds); 234 DBUS_EXPORT 235 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection, 236 DBusMessage *message, 237 int timeout_milliseconds, 238 DBusError *error); 239 DBUS_EXPORT 240 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection, 241 DBusAddWatchFunction add_function, 242 DBusRemoveWatchFunction remove_function, 243 DBusWatchToggledFunction toggled_function, 244 void *data, 245 DBusFreeFunction free_data_function); 246 DBUS_EXPORT 247 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection, 248 DBusAddTimeoutFunction add_function, 249 DBusRemoveTimeoutFunction remove_function, 250 DBusTimeoutToggledFunction toggled_function, 251 void *data, 252 DBusFreeFunction free_data_function); 253 DBUS_EXPORT 254 void dbus_connection_set_wakeup_main_function (DBusConnection *connection, 255 DBusWakeupMainFunction wakeup_main_function, 256 void *data, 257 DBusFreeFunction free_data_function); 258 DBUS_EXPORT 259 void dbus_connection_set_dispatch_status_function (DBusConnection *connection, 260 DBusDispatchStatusFunction function, 261 void *data, 262 DBusFreeFunction free_data_function); 263 DBUS_EXPORT 264 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection, 265 unsigned long *uid); 266 DBUS_EXPORT 267 dbus_bool_t dbus_connection_get_unix_process_id (DBusConnection *connection, 268 unsigned long *pid); 269 DBUS_EXPORT 270 dbus_bool_t dbus_connection_get_adt_audit_session_data (DBusConnection *connection, 271 void **data, 272 dbus_int32_t *data_size); 273 DBUS_EXPORT 274 void dbus_connection_set_unix_user_function (DBusConnection *connection, 275 DBusAllowUnixUserFunction function, 276 void *data, 277 DBusFreeFunction free_data_function); 278 DBUS_EXPORT 279 dbus_bool_t dbus_connection_get_windows_user (DBusConnection *connection, 280 char **windows_sid_p); 281 DBUS_EXPORT 282 void dbus_connection_set_windows_user_function (DBusConnection *connection, 283 DBusAllowWindowsUserFunction function, 284 void *data, 285 DBusFreeFunction free_data_function); 286 DBUS_EXPORT 287 void dbus_connection_set_allow_anonymous (DBusConnection *connection, 288 dbus_bool_t value); 289 DBUS_EXPORT 290 void dbus_connection_set_route_peer_messages (DBusConnection *connection, 291 dbus_bool_t value); 292 293 294 /* Filters */ 295 296 DBUS_EXPORT 297 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection, 298 DBusHandleMessageFunction function, 299 void *user_data, 300 DBusFreeFunction free_data_function); 301 DBUS_EXPORT 302 void dbus_connection_remove_filter (DBusConnection *connection, 303 DBusHandleMessageFunction function, 304 void *user_data); 305 306 307 /* Other */ 308 DBUS_EXPORT 309 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p); 310 DBUS_EXPORT 311 void dbus_connection_free_data_slot (dbus_int32_t *slot_p); 312 DBUS_EXPORT 313 dbus_bool_t dbus_connection_set_data (DBusConnection *connection, 314 dbus_int32_t slot, 315 void *data, 316 DBusFreeFunction free_data_func); 317 DBUS_EXPORT 318 void* dbus_connection_get_data (DBusConnection *connection, 319 dbus_int32_t slot); 320 321 DBUS_EXPORT 322 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe); 323 324 DBUS_EXPORT 325 void dbus_connection_set_max_message_size (DBusConnection *connection, 326 long size); 327 DBUS_EXPORT 328 long dbus_connection_get_max_message_size (DBusConnection *connection); 329 DBUS_EXPORT 330 void dbus_connection_set_max_received_size (DBusConnection *connection, 331 long size); 332 DBUS_EXPORT 333 long dbus_connection_get_max_received_size (DBusConnection *connection); 334 335 DBUS_EXPORT 336 void dbus_connection_set_max_message_unix_fds (DBusConnection *connection, 337 long n); 338 DBUS_EXPORT 339 long dbus_connection_get_max_message_unix_fds (DBusConnection *connection); 340 DBUS_EXPORT 341 void dbus_connection_set_max_received_unix_fds(DBusConnection *connection, 342 long n); 343 DBUS_EXPORT 344 long dbus_connection_get_max_received_unix_fds(DBusConnection *connection); 345 346 DBUS_EXPORT 347 long dbus_connection_get_outgoing_size (DBusConnection *connection); 348 DBUS_EXPORT 349 long dbus_connection_get_outgoing_unix_fds (DBusConnection *connection); 350 351 DBUS_EXPORT 352 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection); 353 DBUS_EXPORT 354 void dbus_connection_free_preallocated_send (DBusConnection *connection, 355 DBusPreallocatedSend *preallocated); 356 DBUS_EXPORT 357 void dbus_connection_send_preallocated (DBusConnection *connection, 358 DBusPreallocatedSend *preallocated, 359 DBusMessage *message, 360 dbus_uint32_t *client_serial); 361 362 363 /* Object tree functionality */ 364 365 /** 366 * Called when a #DBusObjectPathVTable is unregistered (or its connection is freed). 367 * Found in #DBusObjectPathVTable. 368 */ 369 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection, 370 void *user_data); 371 /** 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(). 375 */ 376 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection, 377 DBusMessage *message, 378 void *user_data); 379 380 /** 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(). 385 */ 386 struct DBusObjectPathVTable 387 { 388 DBusObjectPathUnregisterFunction unregister_function; /**< Function to unregister this handler */ 389 DBusObjectPathMessageFunction message_function; /**< Function to handle messages */ 390 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 */ 395 }; 396 397 DBUS_EXPORT 398 dbus_bool_t dbus_connection_try_register_object_path (DBusConnection *connection, 399 const char *path, 400 const DBusObjectPathVTable *vtable, 401 void *user_data, 402 DBusError *error); 403 404 DBUS_EXPORT 405 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection, 406 const char *path, 407 const DBusObjectPathVTable *vtable, 408 void *user_data); 409 410 DBUS_EXPORT 411 dbus_bool_t dbus_connection_try_register_fallback (DBusConnection *connection, 412 const char *path, 413 const DBusObjectPathVTable *vtable, 414 void *user_data, 415 DBusError *error); 416 417 DBUS_EXPORT 418 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection, 419 const char *path, 420 const DBusObjectPathVTable *vtable, 421 void *user_data); 422 DBUS_EXPORT 423 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection *connection, 424 const char *path); 425 426 DBUS_EXPORT 427 dbus_bool_t dbus_connection_get_object_path_data (DBusConnection *connection, 428 const char *path, 429 void **data_p); 430 431 DBUS_EXPORT 432 dbus_bool_t dbus_connection_list_registered (DBusConnection *connection, 433 const char *parent_path, 434 char ***child_entries); 435 436 DBUS_EXPORT 437 dbus_bool_t dbus_connection_get_unix_fd (DBusConnection *connection, 438 int *fd); 439 DBUS_EXPORT 440 dbus_bool_t dbus_connection_get_socket (DBusConnection *connection, 441 int *fd); 442 443 /** @} */ 444 445 446 /** 447 * @addtogroup DBusWatch 448 * @{ 449 */ 450 451 #ifndef DBUS_DISABLE_DEPRECATED 452 DBUS_EXPORT 453 DBUS_DEPRECATED int dbus_watch_get_fd (DBusWatch *watch); 454 #endif 455 456 DBUS_EXPORT 457 int dbus_watch_get_unix_fd (DBusWatch *watch); 458 DBUS_EXPORT 459 int dbus_watch_get_socket (DBusWatch *watch); 460 DBUS_EXPORT 461 unsigned int dbus_watch_get_flags (DBusWatch *watch); 462 DBUS_EXPORT 463 void* dbus_watch_get_data (DBusWatch *watch); 464 DBUS_EXPORT 465 void dbus_watch_set_data (DBusWatch *watch, 466 void *data, 467 DBusFreeFunction free_data_function); 468 DBUS_EXPORT 469 dbus_bool_t dbus_watch_handle (DBusWatch *watch, 470 unsigned int flags); 471 DBUS_EXPORT 472 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch); 473 474 /** @} */ 475 476 /** 477 * @addtogroup DBusTimeout 478 * @{ 479 */ 480 481 DBUS_EXPORT 482 int dbus_timeout_get_interval (DBusTimeout *timeout); 483 DBUS_EXPORT 484 void* dbus_timeout_get_data (DBusTimeout *timeout); 485 DBUS_EXPORT 486 void dbus_timeout_set_data (DBusTimeout *timeout, 487 void *data, 488 DBusFreeFunction free_data_function); 489 DBUS_EXPORT 490 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout); 491 DBUS_EXPORT 492 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout); 493 494 /** @} */ 495 496 DBUS_END_DECLS 497 498 #endif /* DBUS_CONNECTION_H */ 499