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_connection_handle_watch()).
  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 dbus_bool_t (* DBusAddWatchFunction)      (DBusWatch      *watch,
  60                                                    void           *data);
  61 typedef void        (* DBusRemoveWatchFunction)   (DBusWatch      *watch,
  62                                                    void           *data);
  63 typedef void        (* DBusWakeupMainFunction)    (void           *data);
  64 typedef dbus_bool_t (* DBusAddTimeoutFunction)    (DBusTimeout    *timeout,
  65                                                    void           *data);
  66 typedef void        (* DBusRemoveTimeoutFunction) (DBusTimeout    *timeout,
  67                                                    void           *data);
  68
  69 DBusConnection* dbus_connection_open                   (const char     *address,
  70                                                         DBusResultCode *result);
  71 void            dbus_connection_ref                    (DBusConnection *connection);
  72 void            dbus_connection_unref                  (DBusConnection *connection);
  73 void            dbus_connection_disconnect             (DBusConnection *connection);
  74 dbus_bool_t     dbus_connection_get_is_connected       (DBusConnection *connection);
  75 dbus_bool_t     dbus_connection_get_is_authenticated   (DBusConnection *connection);
  76 void            dbus_connection_flush                  (DBusConnection *connection);
  77 int             dbus_connection_get_n_messages         (DBusConnection *connection);
  78 DBusMessage*    dbus_connection_borrow_message         (DBusConnection *connection);
  79 void            dbus_connection_return_message         (DBusConnection *connection,
  80                                                         DBusMessage    *message);
  81 void            dbus_connection_steal_borrowed_message (DBusConnection *connection,
  82                                                         DBusMessage    *message);
  83 DBusMessage*    dbus_connection_pop_message            (DBusConnection *connection);
  84 dbus_bool_t     dbus_connection_dispatch_message       (DBusConnection *connection);
  85
  86
  87 dbus_bool_t  dbus_connection_send                      (DBusConnection     *connection,
  88                                                         DBusMessage        *message,
  89                                                         dbus_int32_t       *client_serial);
  90 dbus_bool_t  dbus_connection_send_with_reply           (DBusConnection     *connection,
  91                                                         DBusMessage        *message,
  92                                                         DBusMessageHandler *reply_handler,
  93                                                         int                 timeout_milliseconds);
  94 DBusMessage *dbus_connection_send_with_reply_and_block (DBusConnection     *connection,
  95                                                         DBusMessage        *message,
  96                                                         int                 timeout_milliseconds,
  97                                                         DBusError          *error);
  98
  99
 100 dbus_bool_t dbus_connection_set_watch_functions      (DBusConnection            *connection,
 101                                                       DBusAddWatchFunction       add_function,
 102                                                       DBusRemoveWatchFunction    remove_function,
 103                                                       void                      *data,
 104                                                       DBusFreeFunction           free_data_function);
 105 dbus_bool_t dbus_connection_set_timeout_functions    (DBusConnection            *connection,
 106                                                       DBusAddTimeoutFunction     add_function,
 107                                                       DBusRemoveTimeoutFunction  remove_function,
 108                                                       void                      *data,
 109                                                       DBusFreeFunction           free_data_function);
 110 void        dbus_connection_set_wakeup_main_function (DBusConnection            *connection,
 111                                                       DBusWakeupMainFunction     wakeup_main_function,
 112                                                       void                      *data,
 113                                                       DBusFreeFunction           free_data_function);
 114 void        dbus_connection_handle_watch             (DBusConnection            *connection,
 115                                                       DBusWatch                 *watch,
 116                                                       unsigned int               condition);
 117
 118
 119
 120
 121 int          dbus_watch_get_fd    (DBusWatch        *watch);
 122 unsigned int dbus_watch_get_flags (DBusWatch        *watch);
 123 void*        dbus_watch_get_data  (DBusWatch        *watch);
 124 void         dbus_watch_set_data  (DBusWatch        *watch,
 125                                    void             *data,
 126                                    DBusFreeFunction  free_data_function);
 127
 128 int   dbus_timeout_get_interval (DBusTimeout      *timeout);
 129 void* dbus_timeout_get_data     (DBusTimeout      *timeout);
 130 void  dbus_timeout_set_data     (DBusTimeout      *timeout,
 131                                  void             *data,
 132                                  DBusFreeFunction  free_data_function);
 133 void  dbus_timeout_handle       (DBusTimeout      *timeout);
 134
 135
 136 /* Handlers */
 137 dbus_bool_t dbus_connection_add_filter         (DBusConnection      *connection,
 138                                                 DBusMessageHandler  *handler);
 139 void        dbus_connection_remove_filter      (DBusConnection      *connection,
 140                                                 DBusMessageHandler  *handler);
 141
 142 dbus_bool_t dbus_connection_register_handler   (DBusConnection      *connection,
 143                                                 DBusMessageHandler  *handler,
 144                                                 const char         **messages_to_handle,
 145                                                 int                  n_messages);
 146 void        dbus_connection_unregister_handler (DBusConnection      *connection,
 147                                                 DBusMessageHandler  *handler,
 148                                                 const char         **messages_to_handle,
 149                                                 int                  n_messages);
 150
 151
 152 int         dbus_connection_allocate_data_slot (void);
 153 void        dbus_connection_free_data_slot     (int               slot);
 154 dbus_bool_t dbus_connection_set_data           (DBusConnection   *connection,
 155                                                 int               slot,
 156                                                 void             *data,
 157                                                 DBusFreeFunction  free_data_func);
 158 void*       dbus_connection_get_data           (DBusConnection   *connection,
 159                                                 int               slot);
 160
 161 void        dbus_connection_set_change_sigpipe (dbus_bool_t       will_modify_sigpipe);
 162
 163 void dbus_connection_set_max_message_size       (DBusConnection *connection,
 164                                                  long            size);
 165 long dbus_connection_get_max_message_size       (DBusConnection *connection);
 166 void dbus_connection_set_max_live_messages_size (DBusConnection *connection,
 167                                                  long            size);
 168 long dbus_connection_get_max_live_messages_size (DBusConnection *connection);
 169
 170 DBusPreallocatedSend* dbus_connection_preallocate_send       (DBusConnection       *connection);
 171 void                  dbus_connection_free_preallocated_send (DBusConnection       *connection,
 172                                                               DBusPreallocatedSend *preallocated);
 173 void                  dbus_connection_send_preallocated      (DBusConnection       *connection,
 174                                                               DBusPreallocatedSend *preallocated,
 175                                                               DBusMessage          *message,
 176                                                               dbus_int32_t         *client_serial);
 177
 178
 179 DBUS_END_DECLS;
 180
 181 #endif /* DBUS_CONNECTION_H */