dbus/dbus-connection.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 172 DBusConnection*    dbus_connection_open                         (const char                 *address,
 173                                                                  DBusError                  *error);
 174 DBusConnection*    dbus_connection_open_private                 (const char                 *address,
 175                                                                  DBusError                  *error);
 176 DBusConnection*    dbus_connection_ref                          (DBusConnection             *connection);
 177 void               dbus_connection_unref                        (DBusConnection             *connection);
 178 void               dbus_connection_close                        (DBusConnection             *connection);
 179 dbus_bool_t        dbus_connection_get_is_connected             (DBusConnection             *connection);
 180 dbus_bool_t        dbus_connection_get_is_authenticated         (DBusConnection             *connection);
 181 void               dbus_connection_set_exit_on_disconnect       (DBusConnection             *connection,
 182                                                                  dbus_bool_t                 exit_on_disconnect);
 183 void               dbus_connection_flush                        (DBusConnection             *connection);
 184 dbus_bool_t        dbus_connection_read_write_dispatch          (DBusConnection             *connection,
 185                                                                  int                         timeout_milliseconds);
 186 dbus_bool_t        dbus_connection_read_write                   (DBusConnection             *connection,
 187                                                                  int                         timeout_milliseconds);
 188 DBusMessage*       dbus_connection_borrow_message               (DBusConnection             *connection);
 189 void               dbus_connection_return_message               (DBusConnection             *connection,
 190                                                                  DBusMessage                *message);
 191 void               dbus_connection_steal_borrowed_message       (DBusConnection             *connection,
 192                                                                  DBusMessage                *message);
 193 DBusMessage*       dbus_connection_pop_message                  (DBusConnection             *connection);
 194 DBusDispatchStatus dbus_connection_get_dispatch_status          (DBusConnection             *connection);
 195 DBusDispatchStatus dbus_connection_dispatch                     (DBusConnection             *connection);
 196 dbus_bool_t        dbus_connection_has_messages_to_send         (DBusConnection *connection);
 197 dbus_bool_t        dbus_connection_send                         (DBusConnection             *connection,
 198                                                                  DBusMessage                *message,
 199                                                                  dbus_uint32_t              *client_serial);
 200 dbus_bool_t        dbus_connection_send_with_reply              (DBusConnection             *connection,
 201                                                                  DBusMessage                *message,
 202                                                                  DBusPendingCall           **pending_return,
 203                                                                  int                         timeout_milliseconds);
 204 DBusMessage *      dbus_connection_send_with_reply_and_block    (DBusConnection             *connection,
 205                                                                  DBusMessage                *message,
 206                                                                  int                         timeout_milliseconds,
 207                                                                  DBusError                  *error);
 208 dbus_bool_t        dbus_connection_set_watch_functions          (DBusConnection             *connection,
 209                                                                  DBusAddWatchFunction        add_function,
 210                                                                  DBusRemoveWatchFunction     remove_function,
 211                                                                  DBusWatchToggledFunction    toggled_function,
 212                                                                  void                       *data,
 213                                                                  DBusFreeFunction            free_data_function);
 214 dbus_bool_t        dbus_connection_set_timeout_functions        (DBusConnection             *connection,
 215                                                                  DBusAddTimeoutFunction      add_function,
 216                                                                  DBusRemoveTimeoutFunction   remove_function,
 217                                                                  DBusTimeoutToggledFunction  toggled_function,
 218                                                                  void                       *data,
 219                                                                  DBusFreeFunction            free_data_function);
 220 void               dbus_connection_set_wakeup_main_function     (DBusConnection             *connection,
 221                                                                  DBusWakeupMainFunction      wakeup_main_function,
 222                                                                  void                       *data,
 223                                                                  DBusFreeFunction            free_data_function);
 224 void               dbus_connection_set_dispatch_status_function (DBusConnection             *connection,
 225                                                                  DBusDispatchStatusFunction  function,
 226                                                                  void                       *data,
 227                                                                  DBusFreeFunction            free_data_function);
 228 dbus_bool_t        dbus_connection_get_unix_user                (DBusConnection             *connection,
 229                                                                  unsigned long              *uid);
 230 dbus_bool_t        dbus_connection_get_unix_process_id          (DBusConnection             *connection,
 231                                                                  unsigned long              *pid);
 232 void               dbus_connection_set_unix_user_function       (DBusConnection             *connection,
 233                                                                  DBusAllowUnixUserFunction   function,
 234                                                                  void                       *data,
 235                                                                  DBusFreeFunction            free_data_function);
 236 dbus_bool_t        dbus_connection_get_windows_user             (DBusConnection             *connection,
 237                                                                  char                      **windows_sid_p);
 238 void               dbus_connection_set_windows_user_function    (DBusConnection             *connection,
 239                                                                  DBusAllowWindowsUserFunction function,
 240                                                                  void                       *data,
 241                                                                  DBusFreeFunction            free_data_function);
 242 void               dbus_connection_set_route_peer_messages      (DBusConnection             *connection,
 243                                                                  dbus_bool_t                 value);
 244
 245
 246 /* Filters */
 247
 248 dbus_bool_t dbus_connection_add_filter    (DBusConnection            *connection,
 249                                            DBusHandleMessageFunction  function,
 250                                            void                      *user_data,
 251                                            DBusFreeFunction           free_data_function);
 252 void        dbus_connection_remove_filter (DBusConnection            *connection,
 253                                            DBusHandleMessageFunction  function,
 254                                            void                      *user_data);
 255
 256
 257 /* Other */
 258 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t     *slot_p);
 259 void        dbus_connection_free_data_slot     (dbus_int32_t     *slot_p);
 260 dbus_bool_t dbus_connection_set_data           (DBusConnection   *connection,
 261                                                 dbus_int32_t      slot,
 262                                                 void             *data,
 263                                                 DBusFreeFunction  free_data_func);
 264 void*       dbus_connection_get_data           (DBusConnection   *connection,
 265                                                 dbus_int32_t      slot);
 266
 267 void        dbus_connection_set_change_sigpipe (dbus_bool_t       will_modify_sigpipe);
 268
 269 void dbus_connection_set_max_message_size  (DBusConnection *connection,
 270                                             long            size);
 271 long dbus_connection_get_max_message_size  (DBusConnection *connection);
 272 void dbus_connection_set_max_received_size (DBusConnection *connection,
 273                                             long            size);
 274 long dbus_connection_get_max_received_size (DBusConnection *connection);
 275 long dbus_connection_get_outgoing_size     (DBusConnection *connection);
 276
 277 DBusPreallocatedSend* dbus_connection_preallocate_send       (DBusConnection       *connection);
 278 void                  dbus_connection_free_preallocated_send (DBusConnection       *connection,
 279                                                               DBusPreallocatedSend *preallocated);
 280 void                  dbus_connection_send_preallocated      (DBusConnection       *connection,
 281                                                               DBusPreallocatedSend *preallocated,
 282                                                               DBusMessage          *message,
 283                                                               dbus_uint32_t        *client_serial);
 284
 285
 286 /* Object tree functionality */
 287
 288 /**
 289  * Called when a #DBusObjectPathVTable is unregistered (or its connection is freed).
 290  * Found in #DBusObjectPathVTable.
 291  */
 292 typedef void              (* DBusObjectPathUnregisterFunction) (DBusConnection  *connection,
 293                                                                 void            *user_data);
 294 /**
 295  * Called when a message is sent to a registered object path. Found in
 296  * #DBusObjectPathVTable which is registered with dbus_connection_register_object_path()
 297  * or dbus_connection_register_fallback().
 298  */
 299 typedef DBusHandlerResult (* DBusObjectPathMessageFunction)    (DBusConnection  *connection,
 300                                                                 DBusMessage     *message,
 301                                                                 void            *user_data);
 302
 303 /**
 304  * Virtual table that must be implemented to handle a portion of the
 305  * object path hierarchy. Attach the vtable to a particular path using
 306  * dbus_connection_register_object_path() or
 307  * dbus_connection_register_fallback().
 308  */
 309 struct DBusObjectPathVTable
 310 {
 311   DBusObjectPathUnregisterFunction   unregister_function; /**< Function to unregister this handler */
 312   DBusObjectPathMessageFunction      message_function; /**< Function to handle messages */
 313
 314   void (* dbus_internal_pad1) (void *); /**< Reserved for future expansion */
 315   void (* dbus_internal_pad2) (void *); /**< Reserved for future expansion */
 316   void (* dbus_internal_pad3) (void *); /**< Reserved for future expansion */
 317   void (* dbus_internal_pad4) (void *); /**< Reserved for future expansion */
 318 };
 319
 320 dbus_bool_t dbus_connection_register_object_path   (DBusConnection              *connection,
 321                                                     const char                  *path,
 322                                                     const DBusObjectPathVTable  *vtable,
 323                                                     void                        *user_data);
 324 dbus_bool_t dbus_connection_register_fallback      (DBusConnection              *connection,
 325                                                     const char                  *path,
 326                                                     const DBusObjectPathVTable  *vtable,
 327                                                     void                        *user_data);
 328 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection              *connection,
 329                                                     const char                  *path);
 330
 331 dbus_bool_t dbus_connection_get_object_path_data   (DBusConnection              *connection,
 332                                                     const char                  *path,
 333                                                     void                       **data_p);
 334
 335 dbus_bool_t dbus_connection_list_registered        (DBusConnection              *connection,
 336                                                     const char                  *parent_path,
 337                                                     char                      ***child_entries);
 338
 339 dbus_bool_t dbus_connection_get_unix_fd            (DBusConnection              *connection,
 340                                                     int                         *fd);
 341 dbus_bool_t dbus_connection_get_socket             (DBusConnection              *connection,
 342                                                     int                         *fd);
 343
 344 /** @} */
 345
 346
 347 /**
 348  * @addtogroup DBusWatch
 349  * @{
 350  */
 351
 352 int          dbus_watch_get_fd      (DBusWatch        *watch);
 353 unsigned int dbus_watch_get_flags   (DBusWatch        *watch);
 354 void*        dbus_watch_get_data    (DBusWatch        *watch);
 355 void         dbus_watch_set_data    (DBusWatch        *watch,
 356                                      void             *data,
 357                                      DBusFreeFunction  free_data_function);
 358 dbus_bool_t  dbus_watch_handle      (DBusWatch        *watch,
 359                                      unsigned int      flags);
 360 dbus_bool_t  dbus_watch_get_enabled (DBusWatch        *watch);
 361
 362 /** @} */
 363
 364 /**
 365  * @addtogroup DBusTimeout
 366  * @{
 367  */
 368
 369 int         dbus_timeout_get_interval (DBusTimeout      *timeout);
 370 void*       dbus_timeout_get_data     (DBusTimeout      *timeout);
 371 void        dbus_timeout_set_data     (DBusTimeout      *timeout,
 372                                        void             *data,
 373                                        DBusFreeFunction  free_data_function);
 374 dbus_bool_t dbus_timeout_handle       (DBusTimeout      *timeout);
 375 dbus_bool_t dbus_timeout_get_enabled  (DBusTimeout      *timeout);
 376
 377 /** @} */
 378
 379 DBUS_END_DECLS
 380
 381 #endif /* DBUS_CONNECTION_H */