dbus/dbus-connection.h

   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   /* Internal to libdbus, there is also _DBUS_WATCH_NVAL in dbus-watch.h */
  73 } DBusWatchFlags;
  74
  75 /**
  76  * Indicates the status of incoming data on a #DBusConnection. This determines whether
  77  * dbus_connection_dispatch() needs to be called.
  78  */
  79 typedef enum
  80 {
  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. */
  84 } DBusDispatchStatus;
  85
  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().
  90  */
  91 typedef dbus_bool_t (* DBusAddWatchFunction)       (DBusWatch      *watch,
  92                                                     void           *data);
  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().
  96  */
  97 typedef void        (* DBusWatchToggledFunction)   (DBusWatch      *watch,
  98                                                     void           *data);
  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().
 102  */
 103 typedef void        (* DBusRemoveWatchFunction)    (DBusWatch      *watch,
 104                                                     void           *data);
 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().
 109  */
 110 typedef dbus_bool_t (* DBusAddTimeoutFunction)     (DBusTimeout    *timeout,
 111                                                     void           *data);
 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().
 116  */
 117 typedef void        (* DBusTimeoutToggledFunction) (DBusTimeout    *timeout,
 118                                                     void           *data);
 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().
 122  */
 123 typedef void        (* DBusRemoveTimeoutFunction)  (DBusTimeout    *timeout,
 124                                                     void           *data);
 125 /** Called when the return value of dbus_connection_get_dispatch_status()
 126  * may have changed. Set with dbus_connection_set_dispatch_status_function().
 127  */
 128 typedef void        (* DBusDispatchStatusFunction) (DBusConnection *connection,
 129                                                     DBusDispatchStatus new_status,
 130                                                     void           *data);
 131 /**
 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().
 134  */
 135 typedef void        (* DBusWakeupMainFunction)     (void           *data);
 136
 137 /**
 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().
 142  */
 143 typedef dbus_bool_t (* DBusAllowUnixUserFunction)  (DBusConnection *connection,
 144                                                     unsigned long   uid,
 145                                                     void           *data);
 146
 147 /**
 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().
 152  */
 153 typedef dbus_bool_t (* DBusAllowWindowsUserFunction)  (DBusConnection *connection,
 154                                                        const char     *user_sid,
 155                                                        void           *data);
 156
 157
 158 /**
 159  * Called when a pending call now has a reply available. Set with
 160  * dbus_pending_call_set_notify().
 161  */
 162 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending,
 163                                                 void            *user_data);
 164
 165 /**
 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().
 168  */
 169 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection     *connection,
 170                                                          DBusMessage        *message,
 171                                                          void               *user_data);
 172
 173 DBUS_EXPORT
 174 DBusMessage *      generate_local_error_message                                 (dbus_uint32_t serial,
 175                                                                                                  char *error_name,
 176                                                                                                  char *error_msg);
 177 DBUS_EXPORT
 178 DBusConnection*    dbus_connection_open                         (const char                 *address,
 179                                                                  DBusError                  *error);
 180 DBUS_EXPORT
 181 DBusConnection*    dbus_connection_open_private                 (const char                 *address,
 182                                                                  DBusError                  *error);
 183 DBUS_EXPORT
 184 DBusConnection*    dbus_connection_ref                          (DBusConnection             *connection);
 185 DBUS_EXPORT
 186 void               dbus_connection_unref                        (DBusConnection             *connection);
 187 DBUS_EXPORT
 188 void               dbus_connection_close                        (DBusConnection             *connection);
 189 DBUS_EXPORT
 190 dbus_bool_t        dbus_connection_get_is_connected             (DBusConnection             *connection);
 191 DBUS_EXPORT
 192 dbus_bool_t        dbus_connection_get_is_authenticated         (DBusConnection             *connection);
 193 DBUS_EXPORT
 194 dbus_bool_t        dbus_connection_set_is_authenticated         (DBusConnection             *connection);
 195 DBUS_EXPORT
 196 dbus_bool_t        dbus_connection_get_is_anonymous             (DBusConnection             *connection);
 197 DBUS_EXPORT
 198 char*              dbus_connection_get_server_id                (DBusConnection             *connection);
 199 DBUS_EXPORT
 200 dbus_bool_t        dbus_connection_can_send_type                (DBusConnection             *connection,
 201                                                                  int                         type);
 202
 203 DBUS_EXPORT
 204 void               dbus_connection_set_exit_on_disconnect       (DBusConnection             *connection,
 205                                                                  dbus_bool_t                 exit_on_disconnect);
 206 DBUS_EXPORT
 207 void               dbus_connection_flush                        (DBusConnection             *connection);
 208 DBUS_EXPORT
 209 dbus_bool_t        dbus_connection_read_write_dispatch          (DBusConnection             *connection,
 210                                                                  int                         timeout_milliseconds);
 211 DBUS_EXPORT
 212 dbus_bool_t        dbus_connection_read_write                   (DBusConnection             *connection,
 213                                                                  int                         timeout_milliseconds);
 214 DBUS_EXPORT
 215 DBusMessage*       dbus_connection_borrow_message               (DBusConnection             *connection);
 216 DBUS_EXPORT
 217 void               dbus_connection_return_message               (DBusConnection             *connection,
 218                                                                  DBusMessage                *message);
 219 DBUS_EXPORT
 220 void               dbus_connection_steal_borrowed_message       (DBusConnection             *connection,
 221                                                                  DBusMessage                *message);
 222 DBUS_EXPORT
 223 DBusMessage*       dbus_connection_pop_message                  (DBusConnection             *connection);
 224 DBUS_EXPORT
 225 DBusDispatchStatus dbus_connection_get_dispatch_status          (DBusConnection             *connection);
 226 DBUS_EXPORT
 227 DBusDispatchStatus dbus_connection_dispatch                     (DBusConnection             *connection);
 228 DBUS_EXPORT
 229 dbus_bool_t        dbus_connection_has_messages_to_send         (DBusConnection *connection);
 230 DBUS_EXPORT
 231 dbus_bool_t        dbus_connection_send                         (DBusConnection             *connection,
 232                                                                  DBusMessage                *message,
 233                                                                  dbus_uint32_t              *client_serial);
 234 DBUS_EXPORT
 235 dbus_bool_t        dbus_connection_send_with_reply              (DBusConnection             *connection,
 236                                                                  DBusMessage                *message,
 237                                                                  DBusPendingCall           **pending_return,
 238                                                                  int                         timeout_milliseconds);
 239 DBUS_EXPORT
 240 DBusMessage *      dbus_connection_send_with_reply_and_block    (DBusConnection             *connection,
 241                                                                  DBusMessage                *message,
 242                                                                  int                         timeout_milliseconds,
 243                                                                  DBusError                  *error);
 244 DBUS_EXPORT
 245 dbus_bool_t        dbus_connection_set_watch_functions          (DBusConnection             *connection,
 246                                                                  DBusAddWatchFunction        add_function,
 247                                                                  DBusRemoveWatchFunction     remove_function,
 248                                                                  DBusWatchToggledFunction    toggled_function,
 249                                                                  void                       *data,
 250                                                                  DBusFreeFunction            free_data_function);
 251 DBUS_EXPORT
 252 dbus_bool_t        dbus_connection_set_timeout_functions        (DBusConnection             *connection,
 253                                                                  DBusAddTimeoutFunction      add_function,
 254                                                                  DBusRemoveTimeoutFunction   remove_function,
 255                                                                  DBusTimeoutToggledFunction  toggled_function,
 256                                                                  void                       *data,
 257                                                                  DBusFreeFunction            free_data_function);
 258 DBUS_EXPORT
 259 void               dbus_connection_set_wakeup_main_function     (DBusConnection             *connection,
 260                                                                  DBusWakeupMainFunction      wakeup_main_function,
 261                                                                  void                       *data,
 262                                                                  DBusFreeFunction            free_data_function);
 263 DBUS_EXPORT
 264 void               dbus_connection_set_dispatch_status_function (DBusConnection             *connection,
 265                                                                  DBusDispatchStatusFunction  function,
 266                                                                  void                       *data,
 267                                                                  DBusFreeFunction            free_data_function);
 268 DBUS_EXPORT
 269 dbus_bool_t        dbus_connection_get_unix_user                (DBusConnection             *connection,
 270                                                                  unsigned long              *uid);
 271 DBUS_EXPORT
 272 dbus_bool_t        dbus_connection_get_unix_process_id          (DBusConnection             *connection,
 273                                                                  unsigned long              *pid);
 274 DBUS_EXPORT
 275 dbus_bool_t        dbus_connection_get_adt_audit_session_data   (DBusConnection             *connection,
 276                                                                  void                      **data,
 277                                                                  dbus_int32_t               *data_size);
 278 DBUS_EXPORT
 279 void               dbus_connection_set_unix_user_function       (DBusConnection             *connection,
 280                                                                  DBusAllowUnixUserFunction   function,
 281                                                                  void                       *data,
 282                                                                  DBusFreeFunction            free_data_function);
 283 DBUS_EXPORT
 284 dbus_bool_t        dbus_connection_get_windows_user             (DBusConnection             *connection,
 285                                                                  char                      **windows_sid_p);
 286 DBUS_EXPORT
 287 void               dbus_connection_set_windows_user_function    (DBusConnection             *connection,
 288                                                                  DBusAllowWindowsUserFunction function,
 289                                                                  void                       *data,
 290                                                                  DBusFreeFunction            free_data_function);
 291 DBUS_EXPORT
 292 void               dbus_connection_set_allow_anonymous          (DBusConnection             *connection,
 293                                                                  dbus_bool_t                 value);
 294 DBUS_EXPORT
 295 void               dbus_connection_set_route_peer_messages      (DBusConnection             *connection,
 296                                                                  dbus_bool_t                 value);
 297
 298
 299 /* Filters */
 300
 301 DBUS_EXPORT
 302 dbus_bool_t dbus_connection_add_filter    (DBusConnection            *connection,
 303                                            DBusHandleMessageFunction  function,
 304                                            void                      *user_data,
 305                                            DBusFreeFunction           free_data_function);
 306 DBUS_EXPORT
 307 void        dbus_connection_remove_filter (DBusConnection            *connection,
 308                                            DBusHandleMessageFunction  function,
 309                                            void                      *user_data);
 310
 311
 312 /* Other */
 313 DBUS_EXPORT
 314 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t     *slot_p);
 315 DBUS_EXPORT
 316 void        dbus_connection_free_data_slot     (dbus_int32_t     *slot_p);
 317 DBUS_EXPORT
 318 dbus_bool_t dbus_connection_set_data           (DBusConnection   *connection,
 319                                                 dbus_int32_t      slot,
 320                                                 void             *data,
 321                                                 DBusFreeFunction  free_data_func);
 322 DBUS_EXPORT
 323 void*       dbus_connection_get_data           (DBusConnection   *connection,
 324                                                 dbus_int32_t      slot);
 325
 326 DBUS_EXPORT
 327 void        dbus_connection_set_change_sigpipe (dbus_bool_t       will_modify_sigpipe);
 328
 329 DBUS_EXPORT
 330 void dbus_connection_set_max_message_size  (DBusConnection *connection,
 331                                             long            size);
 332 DBUS_EXPORT
 333 long dbus_connection_get_max_message_size  (DBusConnection *connection);
 334 DBUS_EXPORT
 335 void dbus_connection_set_max_received_size (DBusConnection *connection,
 336                                             long            size);
 337 DBUS_EXPORT
 338 long dbus_connection_get_max_received_size (DBusConnection *connection);
 339
 340 DBUS_EXPORT
 341 void dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
 342                                                long            n);
 343 DBUS_EXPORT
 344 long dbus_connection_get_max_message_unix_fds (DBusConnection *connection);
 345 DBUS_EXPORT
 346 void dbus_connection_set_max_received_unix_fds(DBusConnection *connection,
 347                                                long            n);
 348 DBUS_EXPORT
 349 long dbus_connection_get_max_received_unix_fds(DBusConnection *connection);
 350
 351 DBUS_EXPORT
 352 long dbus_connection_get_outgoing_size     (DBusConnection *connection);
 353 DBUS_EXPORT
 354 long dbus_connection_get_outgoing_unix_fds (DBusConnection *connection);
 355
 356 DBUS_EXPORT
 357 DBusPreallocatedSend* dbus_connection_preallocate_send       (DBusConnection       *connection);
 358 DBUS_EXPORT
 359 void                  dbus_connection_free_preallocated_send (DBusConnection       *connection,
 360                                                               DBusPreallocatedSend *preallocated);
 361 DBUS_EXPORT
 362 void                  dbus_connection_send_preallocated      (DBusConnection       *connection,
 363                                                               DBusPreallocatedSend *preallocated,
 364                                                               DBusMessage          *message,
 365                                                               dbus_uint32_t        *client_serial);
 366
 367
 368 /* Object tree functionality */
 369
 370 /**
 371  * Called when a #DBusObjectPathVTable is unregistered (or its connection is freed).
 372  * Found in #DBusObjectPathVTable.
 373  */
 374 typedef void              (* DBusObjectPathUnregisterFunction) (DBusConnection  *connection,
 375                                                                 void            *user_data);
 376 /**
 377  * Called when a message is sent to a registered object path. Found in
 378  * #DBusObjectPathVTable which is registered with dbus_connection_register_object_path()
 379  * or dbus_connection_register_fallback().
 380  */
 381 typedef DBusHandlerResult (* DBusObjectPathMessageFunction)    (DBusConnection  *connection,
 382                                                                 DBusMessage     *message,
 383                                                                 void            *user_data);
 384
 385 /**
 386  * Virtual table that must be implemented to handle a portion of the
 387  * object path hierarchy. Attach the vtable to a particular path using
 388  * dbus_connection_register_object_path() or
 389  * dbus_connection_register_fallback().
 390  */
 391 struct DBusObjectPathVTable
 392 {
 393   DBusObjectPathUnregisterFunction   unregister_function; /**< Function to unregister this handler */
 394   DBusObjectPathMessageFunction      message_function; /**< Function to handle messages */
 395
 396   void (* dbus_internal_pad1) (void *); /**< Reserved for future expansion */
 397   void (* dbus_internal_pad2) (void *); /**< Reserved for future expansion */
 398   void (* dbus_internal_pad3) (void *); /**< Reserved for future expansion */
 399   void (* dbus_internal_pad4) (void *); /**< Reserved for future expansion */
 400 };
 401
 402 DBUS_EXPORT
 403 dbus_bool_t dbus_connection_try_register_object_path (DBusConnection              *connection,
 404                                                       const char                  *path,
 405                                                       const DBusObjectPathVTable  *vtable,
 406                                                       void                        *user_data,
 407                                                       DBusError                   *error);
 408
 409 DBUS_EXPORT
 410 dbus_bool_t dbus_connection_register_object_path   (DBusConnection              *connection,
 411                                                     const char                  *path,
 412                                                     const DBusObjectPathVTable  *vtable,
 413                                                     void                        *user_data);
 414
 415 DBUS_EXPORT
 416 dbus_bool_t dbus_connection_try_register_fallback (DBusConnection              *connection,
 417                                                    const char                  *path,
 418                                                    const DBusObjectPathVTable  *vtable,
 419                                                    void                        *user_data,
 420                                                    DBusError                   *error);
 421
 422 DBUS_EXPORT
 423 dbus_bool_t dbus_connection_register_fallback      (DBusConnection              *connection,
 424                                                     const char                  *path,
 425                                                     const DBusObjectPathVTable  *vtable,
 426                                                     void                        *user_data);
 427 DBUS_EXPORT
 428 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection              *connection,
 429                                                     const char                  *path);
 430
 431 DBUS_EXPORT
 432 dbus_bool_t dbus_connection_get_object_path_data   (DBusConnection              *connection,
 433                                                     const char                  *path,
 434                                                     void                       **data_p);
 435
 436 DBUS_EXPORT
 437 dbus_bool_t dbus_connection_list_registered        (DBusConnection              *connection,
 438                                                     const char                  *parent_path,
 439                                                     char                      ***child_entries);
 440
 441 DBUS_EXPORT
 442 dbus_bool_t dbus_connection_get_unix_fd            (DBusConnection              *connection,
 443                                                     int                         *fd);
 444 DBUS_EXPORT
 445 dbus_bool_t dbus_connection_get_socket             (DBusConnection              *connection,
 446                                                     int                         *fd);
 447
 448 /** @} */
 449
 450
 451 /**
 452  * @addtogroup DBusWatch
 453  * @{
 454  */
 455
 456 #ifndef DBUS_DISABLE_DEPRECATED
 457 DBUS_EXPORT
 458 DBUS_DEPRECATED int dbus_watch_get_fd      (DBusWatch        *watch);
 459 #endif
 460
 461 DBUS_EXPORT
 462 int          dbus_watch_get_unix_fd (DBusWatch        *watch);
 463 DBUS_EXPORT
 464 int          dbus_watch_get_socket  (DBusWatch        *watch);
 465 DBUS_EXPORT
 466 unsigned int dbus_watch_get_flags   (DBusWatch        *watch);
 467 DBUS_EXPORT
 468 void*        dbus_watch_get_data    (DBusWatch        *watch);
 469 DBUS_EXPORT
 470 void         dbus_watch_set_data    (DBusWatch        *watch,
 471                                      void             *data,
 472                                      DBusFreeFunction  free_data_function);
 473 DBUS_EXPORT
 474 dbus_bool_t  dbus_watch_handle      (DBusWatch        *watch,
 475                                      unsigned int      flags);
 476 DBUS_EXPORT
 477 dbus_bool_t  dbus_watch_get_enabled (DBusWatch        *watch);
 478
 479 /** @} */
 480
 481 /**
 482  * @addtogroup DBusTimeout
 483  * @{
 484  */
 485
 486 DBUS_EXPORT
 487 int         dbus_timeout_get_interval (DBusTimeout      *timeout);
 488 DBUS_EXPORT
 489 void*       dbus_timeout_get_data     (DBusTimeout      *timeout);
 490 DBUS_EXPORT
 491 void        dbus_timeout_set_data     (DBusTimeout      *timeout,
 492                                        void             *data,
 493                                        DBusFreeFunction  free_data_function);
 494 DBUS_EXPORT
 495 dbus_bool_t dbus_timeout_handle       (DBusTimeout      *timeout);
 496 DBUS_EXPORT
 497 dbus_bool_t dbus_timeout_get_enabled  (DBusTimeout      *timeout);
 498
 499 /** @} */
 500
 501 DBUS_END_DECLS
 502
 503 #endif /* DBUS_CONNECTION_H */