dbus-connection.h 12.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-connection.h DBusConnection object
 *
 * Copyright (C) 2002  Red Hat Inc.
 *
 * Licensed under the Academic Free License version 1.2
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
#endif

#ifndef DBUS_CONNECTION_H
#define DBUS_CONNECTION_H

#include <dbus/dbus-errors.h>
#include <dbus/dbus-message.h>
#include <dbus/dbus-memory.h>

DBUS_BEGIN_DECLS;

typedef struct DBusConnection DBusConnection;
typedef struct DBusWatch DBusWatch;
38
typedef struct DBusTimeout DBusTimeout;
39
typedef struct DBusMessageHandler DBusMessageHandler;
40
typedef struct DBusPreallocatedSend DBusPreallocatedSend;
41 42 43 44

typedef enum
{
  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 49 50 51 52 53 54 55 56 57 58

typedef enum
{
  DBUS_WATCH_READABLE = 1 << 0, /**< As in POLLIN */
  DBUS_WATCH_WRITABLE = 1 << 1, /**< As in POLLOUT */
  DBUS_WATCH_ERROR    = 1 << 2, /**< As in POLLERR (can't watch for this, but
                                 *   the flag can be passed to dbus_connection_handle_watch()).
                                 */
  DBUS_WATCH_HANGUP   = 1 << 3  /**< As in POLLHUP (can't watch for it, but
                                 *   can be present in current state). */
} DBusWatchFlags;

59 60 61 62 63 64 65
typedef enum
{
  DBUS_DISPATCH_DATA_REMAINS,  /**< There is more data to potentially convert to messages. */
  DBUS_DISPATCH_COMPLETE,      /**< All currently available data has been processed. */
  DBUS_DISPATCH_NEED_MEMORY    /**< More memory is needed to continue. */
} DBusDispatchStatus;

66 67 68 69 70 71 72 73 74 75 76 77
typedef dbus_bool_t (* DBusAddWatchFunction)       (DBusWatch      *watch,
                                                    void           *data);
typedef void        (* DBusWatchToggledFunction)   (DBusWatch      *watch,
                                                    void           *data);
typedef void        (* DBusRemoveWatchFunction)    (DBusWatch      *watch,
                                                    void           *data);
typedef dbus_bool_t (* DBusAddTimeoutFunction)     (DBusTimeout    *timeout,
                                                    void           *data);
typedef void        (* DBusTimeoutToggledFunction) (DBusTimeout    *timeout,
                                                    void           *data);
typedef void        (* DBusRemoveTimeoutFunction)  (DBusTimeout    *timeout,
                                                    void           *data);
78 79 80 81
typedef void        (* DBusWakeupMainFunction)     (void           *data);
typedef dbus_bool_t (* DBusAllowUnixUserFunction)  (DBusConnection *connection,
                                                    unsigned long   uid,
                                                    void           *data);
82

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
DBusConnection*    dbus_connection_open                      (const char                 *address,
                                                              DBusResultCode             *result);
void               dbus_connection_ref                       (DBusConnection             *connection);
void               dbus_connection_unref                     (DBusConnection             *connection);
void               dbus_connection_disconnect                (DBusConnection             *connection);
dbus_bool_t        dbus_connection_get_is_connected          (DBusConnection             *connection);
dbus_bool_t        dbus_connection_get_is_authenticated      (DBusConnection             *connection);
void               dbus_connection_flush                     (DBusConnection             *connection);
DBusMessage*       dbus_connection_borrow_message            (DBusConnection             *connection);
void               dbus_connection_return_message            (DBusConnection             *connection,
                                                              DBusMessage                *message);
void               dbus_connection_steal_borrowed_message    (DBusConnection             *connection,
                                                              DBusMessage                *message);
DBusMessage*       dbus_connection_pop_message               (DBusConnection             *connection);
DBusDispatchStatus dbus_connection_get_dispatch_status       (DBusConnection             *connection);
DBusDispatchStatus dbus_connection_dispatch                  (DBusConnection             *connection);
dbus_bool_t        dbus_connection_send                      (DBusConnection             *connection,
                                                              DBusMessage                *message,
                                                              dbus_int32_t               *client_serial);
dbus_bool_t        dbus_connection_send_with_reply           (DBusConnection             *connection,
                                                              DBusMessage                *message,
                                                              DBusMessageHandler         *reply_handler,
                                                              int                         timeout_milliseconds);
DBusMessage *      dbus_connection_send_with_reply_and_block (DBusConnection             *connection,
                                                              DBusMessage                *message,
                                                              int                         timeout_milliseconds,
                                                              DBusError                  *error);
dbus_bool_t        dbus_connection_set_watch_functions       (DBusConnection             *connection,
                                                              DBusAddWatchFunction        add_function,
                                                              DBusRemoveWatchFunction     remove_function,
                                                              DBusWatchToggledFunction    toggled_function,
                                                              void                       *data,
                                                              DBusFreeFunction            free_data_function);
dbus_bool_t        dbus_connection_set_timeout_functions     (DBusConnection             *connection,
                                                              DBusAddTimeoutFunction      add_function,
                                                              DBusRemoveTimeoutFunction   remove_function,
                                                              DBusTimeoutToggledFunction  toggled_function,
                                                              void                       *data,
                                                              DBusFreeFunction            free_data_function);
void               dbus_connection_set_wakeup_main_function  (DBusConnection             *connection,
                                                              DBusWakeupMainFunction      wakeup_main_function,
                                                              void                       *data,
                                                              DBusFreeFunction            free_data_function);
126
dbus_bool_t        dbus_connection_handle_watch              (DBusConnection             *connection,
127 128
                                                              DBusWatch                  *watch,
                                                              unsigned int                condition);
129 130 131 132 133 134
dbus_bool_t        dbus_connection_get_unix_user             (DBusConnection             *connection,
                                                              unsigned long              *uid);
void               dbus_connection_set_unix_user_function    (DBusConnection             *connection,
                                                              DBusAllowUnixUserFunction   function,
                                                              void                       *data,
                                                              DBusFreeFunction            free_data_function);
135

136 137 138 139 140 141 142
int          dbus_watch_get_fd      (DBusWatch        *watch);
unsigned int dbus_watch_get_flags   (DBusWatch        *watch);
void*        dbus_watch_get_data    (DBusWatch        *watch);
void         dbus_watch_set_data    (DBusWatch        *watch,
                                     void             *data,
                                     DBusFreeFunction  free_data_function);
dbus_bool_t  dbus_watch_get_enabled (DBusWatch        *watch);
143

144 145 146 147 148
int         dbus_timeout_get_interval (DBusTimeout      *timeout);
void*       dbus_timeout_get_data     (DBusTimeout      *timeout);
void        dbus_timeout_set_data     (DBusTimeout      *timeout,
                                       void             *data,
                                       DBusFreeFunction  free_data_function);
149
dbus_bool_t dbus_timeout_handle       (DBusTimeout      *timeout);
150
dbus_bool_t dbus_timeout_get_enabled  (DBusTimeout      *timeout);
151

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
/* Handlers */
dbus_bool_t dbus_connection_add_filter         (DBusConnection      *connection,
                                                DBusMessageHandler  *handler);
void        dbus_connection_remove_filter      (DBusConnection      *connection,
                                                DBusMessageHandler  *handler);

dbus_bool_t dbus_connection_register_handler   (DBusConnection      *connection,
                                                DBusMessageHandler  *handler,
                                                const char         **messages_to_handle,
                                                int                  n_messages);
void        dbus_connection_unregister_handler (DBusConnection      *connection,
                                                DBusMessageHandler  *handler,
                                                const char         **messages_to_handle,
                                                int                  n_messages);

167 168 169 170 171 172 173 174 175 176

int         dbus_connection_allocate_data_slot (void);
void        dbus_connection_free_data_slot     (int               slot);
dbus_bool_t dbus_connection_set_data           (DBusConnection   *connection,
                                                int               slot,
                                                void             *data,
                                                DBusFreeFunction  free_data_func);
void*       dbus_connection_get_data           (DBusConnection   *connection,
                                                int               slot);

177 178
void        dbus_connection_set_change_sigpipe (dbus_bool_t       will_modify_sigpipe); 

179 180 181 182 183 184 185
void dbus_connection_set_max_message_size       (DBusConnection *connection,
                                                 long            size);
long dbus_connection_get_max_message_size       (DBusConnection *connection);
void dbus_connection_set_max_live_messages_size (DBusConnection *connection,
                                                 long            size);
long dbus_connection_get_max_live_messages_size (DBusConnection *connection);

186 187 188 189 190 191 192 193
DBusPreallocatedSend* dbus_connection_preallocate_send       (DBusConnection       *connection);
void                  dbus_connection_free_preallocated_send (DBusConnection       *connection,
                                                              DBusPreallocatedSend *preallocated);
void                  dbus_connection_send_preallocated      (DBusConnection       *connection,
                                                              DBusPreallocatedSend *preallocated,
                                                              DBusMessage          *message,
                                                              dbus_int32_t         *client_serial);

194

195 196 197
DBUS_END_DECLS;

#endif /* DBUS_CONNECTION_H */