dbus/dbus-connection.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-connection.h DBusConnection object
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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-message.h>
  32 #include <dbus/dbus-memory.h>
  33
  34 DBUS_BEGIN_DECLS;
  35
  36 typedef struct DBusConnection DBusConnection;
  37 typedef struct DBusWatch DBusWatch;
  38 typedef struct DBusTimeout DBusTimeout;
  39 typedef struct DBusMessageHandler DBusMessageHandler;
  40 typedef struct DBusPreallocatedSend DBusPreallocatedSend;
  41
  42 typedef enum
  43 {
  44   DBUS_HANDLER_RESULT_REMOVE_MESSAGE,     /**< Remove this message, no further processing. */
  45   DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS /**< Run any additional handlers that are interested in this message. */
  46 } DBusHandlerResult;
  47
  48 typedef enum
  49 {
  50   DBUS_WATCH_READABLE = 1 << 0, /**< As in POLLIN */
  51   DBUS_WATCH_WRITABLE = 1 << 1, /**< As in POLLOUT */
  52   DBUS_WATCH_ERROR    = 1 << 2, /**< As in POLLERR (can't watch for this, but
  53                                  *   the flag can be passed to dbus_watch_handle()).
  54                                  */
  55   DBUS_WATCH_HANGUP   = 1 << 3  /**< As in POLLHUP (can't watch for it, but
  56                                  *   can be present in current state). */
  57 } DBusWatchFlags;
  58
  59 typedef enum
  60 {
  61   DBUS_DISPATCH_DATA_REMAINS,  /**< There is more data to potentially convert to messages. */
  62   DBUS_DISPATCH_COMPLETE,      /**< All currently available data has been processed. */
  63   DBUS_DISPATCH_NEED_MEMORY    /**< More memory is needed to continue. */
  64 } DBusDispatchStatus;
  65
  66 typedef dbus_bool_t (* DBusAddWatchFunction)       (DBusWatch      *watch,
  67                                                     void           *data);
  68 typedef void        (* DBusWatchToggledFunction)   (DBusWatch      *watch,
  69                                                     void           *data);
  70 typedef void        (* DBusRemoveWatchFunction)    (DBusWatch      *watch,
  71                                                     void           *data);
  72 typedef dbus_bool_t (* DBusAddTimeoutFunction)     (DBusTimeout    *timeout,
  73                                                     void           *data);
  74 typedef void        (* DBusTimeoutToggledFunction) (DBusTimeout    *timeout,
  75                                                     void           *data);
  76 typedef void        (* DBusRemoveTimeoutFunction)  (DBusTimeout    *timeout,
  77                                                     void           *data);
  78 typedef void        (* DBusDispatchStatusFunction) (DBusConnection *connection,
  79                                                     DBusDispatchStatus new_status,
  80                                                     void           *data);
  81 typedef void        (* DBusWakeupMainFunction)     (void           *data);
  82 typedef dbus_bool_t (* DBusAllowUnixUserFunction)  (DBusConnection *connection,
  83                                                     unsigned long   uid,
  84                                                     void           *data);
  85
  86 DBusConnection*    dbus_connection_open                         (const char                 *address,
  87                                                                  DBusError                  *error);
  88 void               dbus_connection_ref                          (DBusConnection             *connection);
  89 void               dbus_connection_unref                        (DBusConnection             *connection);
  90 void               dbus_connection_disconnect                   (DBusConnection             *connection);
  91 dbus_bool_t        dbus_connection_get_is_connected             (DBusConnection             *connection);
  92 dbus_bool_t        dbus_connection_get_is_authenticated         (DBusConnection             *connection);
  93 void               dbus_connection_flush                        (DBusConnection             *connection);
  94 DBusMessage*       dbus_connection_borrow_message               (DBusConnection             *connection);
  95 void               dbus_connection_return_message               (DBusConnection             *connection,
  96                                                                  DBusMessage                *message);
  97 void               dbus_connection_steal_borrowed_message       (DBusConnection             *connection,
  98                                                                  DBusMessage                *message);
  99 DBusMessage*       dbus_connection_pop_message                  (DBusConnection             *connection);
 100 DBusDispatchStatus dbus_connection_get_dispatch_status          (DBusConnection             *connection);
 101 DBusDispatchStatus dbus_connection_dispatch                     (DBusConnection             *connection);
 102 dbus_bool_t        dbus_connection_send                         (DBusConnection             *connection,
 103                                                                  DBusMessage                *message,
 104                                                                  dbus_uint32_t              *client_serial);
 105 dbus_bool_t        dbus_connection_send_with_reply              (DBusConnection             *connection,
 106                                                                  DBusMessage                *message,
 107                                                                  DBusMessageHandler         *reply_handler,
 108                                                                  int                         timeout_milliseconds);
 109 DBusMessage *      dbus_connection_send_with_reply_and_block    (DBusConnection             *connection,
 110                                                                  DBusMessage                *message,
 111                                                                  int                         timeout_milliseconds,
 112                                                                  DBusError                  *error);
 113 dbus_bool_t        dbus_connection_set_watch_functions          (DBusConnection             *connection,
 114                                                                  DBusAddWatchFunction        add_function,
 115                                                                  DBusRemoveWatchFunction     remove_function,
 116                                                                  DBusWatchToggledFunction    toggled_function,
 117                                                                  void                       *data,
 118                                                                  DBusFreeFunction            free_data_function);
 119 dbus_bool_t        dbus_connection_set_timeout_functions        (DBusConnection             *connection,
 120                                                                  DBusAddTimeoutFunction      add_function,
 121                                                                  DBusRemoveTimeoutFunction   remove_function,
 122                                                                  DBusTimeoutToggledFunction  toggled_function,
 123                                                                  void                       *data,
 124                                                                  DBusFreeFunction            free_data_function);
 125 void               dbus_connection_set_wakeup_main_function     (DBusConnection             *connection,
 126                                                                  DBusWakeupMainFunction      wakeup_main_function,
 127                                                                  void                       *data,
 128                                                                  DBusFreeFunction            free_data_function);
 129 void               dbus_connection_set_dispatch_status_function (DBusConnection             *connection,
 130                                                                  DBusDispatchStatusFunction  function,
 131                                                                  void                       *data,
 132                                                                  DBusFreeFunction            free_data_function);
 133 dbus_bool_t        dbus_connection_get_unix_user                (DBusConnection             *connection,
 134                                                                  unsigned long              *uid);
 135 void               dbus_connection_set_unix_user_function       (DBusConnection             *connection,
 136                                                                  DBusAllowUnixUserFunction   function,
 137                                                                  void                       *data,
 138                                                                  DBusFreeFunction            free_data_function);
 139
 140
 141 int          dbus_watch_get_fd      (DBusWatch        *watch);
 142 unsigned int dbus_watch_get_flags   (DBusWatch        *watch);
 143 void*        dbus_watch_get_data    (DBusWatch        *watch);
 144 void         dbus_watch_set_data    (DBusWatch        *watch,
 145                                      void             *data,
 146                                      DBusFreeFunction  free_data_function);
 147 dbus_bool_t  dbus_watch_handle      (DBusWatch        *watch,
 148                                      unsigned int      flags);
 149 dbus_bool_t  dbus_watch_get_enabled (DBusWatch        *watch);
 150
 151 int         dbus_timeout_get_interval (DBusTimeout      *timeout);
 152 void*       dbus_timeout_get_data     (DBusTimeout      *timeout);
 153 void        dbus_timeout_set_data     (DBusTimeout      *timeout,
 154                                        void             *data,
 155                                        DBusFreeFunction  free_data_function);
 156 dbus_bool_t dbus_timeout_handle       (DBusTimeout      *timeout);
 157 dbus_bool_t dbus_timeout_get_enabled  (DBusTimeout      *timeout);
 158
 159 /* Handlers */
 160 dbus_bool_t dbus_connection_add_filter         (DBusConnection      *connection,
 161                                                 DBusMessageHandler  *handler);
 162 void        dbus_connection_remove_filter      (DBusConnection      *connection,
 163                                                 DBusMessageHandler  *handler);
 164
 165 dbus_bool_t dbus_connection_register_handler   (DBusConnection      *connection,
 166                                                 DBusMessageHandler  *handler,
 167                                                 const char         **messages_to_handle,
 168                                                 int                  n_messages);
 169 void        dbus_connection_unregister_handler (DBusConnection      *connection,
 170                                                 DBusMessageHandler  *handler,
 171                                                 const char         **messages_to_handle,
 172                                                 int                  n_messages);
 173
 174
 175 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t     *slot_p);
 176 void        dbus_connection_free_data_slot     (dbus_int32_t     *slot_p);
 177 dbus_bool_t dbus_connection_set_data           (DBusConnection   *connection,
 178                                                 dbus_int32_t      slot,
 179                                                 void             *data,
 180                                                 DBusFreeFunction  free_data_func);
 181 void*       dbus_connection_get_data           (DBusConnection   *connection,
 182                                                 dbus_int32_t      slot);
 183
 184 void        dbus_connection_set_change_sigpipe (dbus_bool_t       will_modify_sigpipe);
 185
 186 void dbus_connection_set_max_message_size  (DBusConnection *connection,
 187                                             long            size);
 188 long dbus_connection_get_max_message_size  (DBusConnection *connection);
 189 void dbus_connection_set_max_received_size (DBusConnection *connection,
 190                                             long            size);
 191 long dbus_connection_get_max_received_size (DBusConnection *connection);
 192 long dbus_connection_get_outgoing_size     (DBusConnection *connection);
 193
 194 DBusPreallocatedSend* dbus_connection_preallocate_send       (DBusConnection       *connection);
 195 void                  dbus_connection_free_preallocated_send (DBusConnection       *connection,
 196                                                               DBusPreallocatedSend *preallocated);
 197 void                  dbus_connection_send_preallocated      (DBusConnection       *connection,
 198                                                               DBusPreallocatedSend *preallocated,
 199                                                               DBusMessage          *message,
 200                                                               dbus_uint32_t        *client_serial);
 201
 202
 203 DBUS_END_DECLS;
 204
 205 #endif /* DBUS_CONNECTION_H */