00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
00024 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
00025 #endif
00026
00027 #ifndef DBUS_CONNECTION_H
00028 #define DBUS_CONNECTION_H
00029
00030 #include <dbus/dbus-errors.h>
00031 #include <dbus/dbus-memory.h>
00032 #include <dbus/dbus-message.h>
00033 #include <dbus/dbus-shared.h>
00034
00035 DBUS_BEGIN_DECLS
00036
00037 typedef struct DBusWatch DBusWatch;
00038 typedef struct DBusTimeout DBusTimeout;
00039 typedef struct DBusPreallocatedSend DBusPreallocatedSend;
00040 typedef struct DBusPendingCall DBusPendingCall;
00041 typedef struct DBusConnection DBusConnection;
00042 typedef struct DBusObjectPathVTable DBusObjectPathVTable;
00043
00044 typedef enum
00045 {
00046 DBUS_WATCH_READABLE = 1 << 0,
00047 DBUS_WATCH_WRITABLE = 1 << 1,
00048 DBUS_WATCH_ERROR = 1 << 2,
00051 DBUS_WATCH_HANGUP = 1 << 3
00053 } DBusWatchFlags;
00054
00055 typedef enum
00056 {
00057 DBUS_DISPATCH_DATA_REMAINS,
00058 DBUS_DISPATCH_COMPLETE,
00059 DBUS_DISPATCH_NEED_MEMORY
00060 } DBusDispatchStatus;
00061
00062 typedef dbus_bool_t (* DBusAddWatchFunction) (DBusWatch *watch,
00063 void *data);
00064 typedef void (* DBusWatchToggledFunction) (DBusWatch *watch,
00065 void *data);
00066 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch,
00067 void *data);
00068 typedef dbus_bool_t (* DBusAddTimeoutFunction) (DBusTimeout *timeout,
00069 void *data);
00070 typedef void (* DBusTimeoutToggledFunction) (DBusTimeout *timeout,
00071 void *data);
00072 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout,
00073 void *data);
00074 typedef void (* DBusDispatchStatusFunction) (DBusConnection *connection,
00075 DBusDispatchStatus new_status,
00076 void *data);
00077 typedef void (* DBusWakeupMainFunction) (void *data);
00078 typedef dbus_bool_t (* DBusAllowUnixUserFunction) (DBusConnection *connection,
00079 unsigned long uid,
00080 void *data);
00081
00082 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending,
00083 void *user_data);
00084
00085
00086 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection *connection,
00087 DBusMessage *message,
00088 void *user_data);
00089
00090 DBusConnection* dbus_connection_open (const char *address,
00091 DBusError *error);
00092 DBusConnection* dbus_connection_open_private (const char *address,
00093 DBusError *error);
00094 DBusConnection* dbus_connection_ref (DBusConnection *connection);
00095 void dbus_connection_unref (DBusConnection *connection);
00096 void dbus_connection_close (DBusConnection *connection);
00097 void dbus_connection_disconnect (DBusConnection *connection);
00098 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
00099 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
00100 void dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
00101 dbus_bool_t exit_on_disconnect);
00102 void dbus_connection_flush (DBusConnection *connection);
00103 dbus_bool_t dbus_connection_read_write_dispatch (DBusConnection *connection,
00104 int timeout_milliseconds);
00105 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
00106 void dbus_connection_return_message (DBusConnection *connection,
00107 DBusMessage *message);
00108 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
00109 DBusMessage *message);
00110 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
00111 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection);
00112 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection);
00113 dbus_bool_t dbus_connection_has_messages_to_send (DBusConnection *connection);
00114 dbus_bool_t dbus_connection_send (DBusConnection *connection,
00115 DBusMessage *message,
00116 dbus_uint32_t *client_serial);
00117 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
00118 DBusMessage *message,
00119 DBusPendingCall **pending_return,
00120 int timeout_milliseconds);
00121 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection,
00122 DBusMessage *message,
00123 int timeout_milliseconds,
00124 DBusError *error);
00125 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection,
00126 DBusAddWatchFunction add_function,
00127 DBusRemoveWatchFunction remove_function,
00128 DBusWatchToggledFunction toggled_function,
00129 void *data,
00130 DBusFreeFunction free_data_function);
00131 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection,
00132 DBusAddTimeoutFunction add_function,
00133 DBusRemoveTimeoutFunction remove_function,
00134 DBusTimeoutToggledFunction toggled_function,
00135 void *data,
00136 DBusFreeFunction free_data_function);
00137 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
00138 DBusWakeupMainFunction wakeup_main_function,
00139 void *data,
00140 DBusFreeFunction free_data_function);
00141 void dbus_connection_set_dispatch_status_function (DBusConnection *connection,
00142 DBusDispatchStatusFunction function,
00143 void *data,
00144 DBusFreeFunction free_data_function);
00145 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection,
00146 unsigned long *uid);
00147 dbus_bool_t dbus_connection_get_unix_process_id (DBusConnection *connection,
00148 unsigned long *pid);
00149 void dbus_connection_set_unix_user_function (DBusConnection *connection,
00150 DBusAllowUnixUserFunction function,
00151 void *data,
00152 DBusFreeFunction free_data_function);
00153
00154
00155 int dbus_watch_get_fd (DBusWatch *watch);
00156 unsigned int dbus_watch_get_flags (DBusWatch *watch);
00157 void* dbus_watch_get_data (DBusWatch *watch);
00158 void dbus_watch_set_data (DBusWatch *watch,
00159 void *data,
00160 DBusFreeFunction free_data_function);
00161 dbus_bool_t dbus_watch_handle (DBusWatch *watch,
00162 unsigned int flags);
00163 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch);
00164
00165 int dbus_timeout_get_interval (DBusTimeout *timeout);
00166 void* dbus_timeout_get_data (DBusTimeout *timeout);
00167 void dbus_timeout_set_data (DBusTimeout *timeout,
00168 void *data,
00169 DBusFreeFunction free_data_function);
00170 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout);
00171 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout);
00172
00173
00174
00175 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
00176 DBusHandleMessageFunction function,
00177 void *user_data,
00178 DBusFreeFunction free_data_function);
00179 void dbus_connection_remove_filter (DBusConnection *connection,
00180 DBusHandleMessageFunction function,
00181 void *user_data);
00182
00183
00184
00185 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p);
00186 void dbus_connection_free_data_slot (dbus_int32_t *slot_p);
00187 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
00188 dbus_int32_t slot,
00189 void *data,
00190 DBusFreeFunction free_data_func);
00191 void* dbus_connection_get_data (DBusConnection *connection,
00192 dbus_int32_t slot);
00193
00194 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
00195
00196 void dbus_connection_set_max_message_size (DBusConnection *connection,
00197 long size);
00198 long dbus_connection_get_max_message_size (DBusConnection *connection);
00199 void dbus_connection_set_max_received_size (DBusConnection *connection,
00200 long size);
00201 long dbus_connection_get_max_received_size (DBusConnection *connection);
00202 long dbus_connection_get_outgoing_size (DBusConnection *connection);
00203
00204 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
00205 void dbus_connection_free_preallocated_send (DBusConnection *connection,
00206 DBusPreallocatedSend *preallocated);
00207 void dbus_connection_send_preallocated (DBusConnection *connection,
00208 DBusPreallocatedSend *preallocated,
00209 DBusMessage *message,
00210 dbus_uint32_t *client_serial);
00211
00212
00213
00214
00215 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection,
00216 void *user_data);
00217 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection,
00218 DBusMessage *message,
00219 void *user_data);
00220
00225 struct DBusObjectPathVTable
00226 {
00227 DBusObjectPathUnregisterFunction unregister_function;
00228 DBusObjectPathMessageFunction message_function;
00230 void (* dbus_internal_pad1) (void *);
00231 void (* dbus_internal_pad2) (void *);
00232 void (* dbus_internal_pad3) (void *);
00233 void (* dbus_internal_pad4) (void *);
00234 };
00235
00236 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection,
00237 const char *path,
00238 const DBusObjectPathVTable *vtable,
00239 void *user_data);
00240 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection,
00241 const char *path,
00242 const DBusObjectPathVTable *vtable,
00243 void *user_data);
00244 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection *connection,
00245 const char *path);
00246
00247 dbus_bool_t dbus_connection_get_object_path_data (DBusConnection *connection,
00248 const char *path,
00249 void **data_p);
00250
00251 dbus_bool_t dbus_connection_list_registered (DBusConnection *connection,
00252 const char *parent_path,
00253 char ***child_entries);
00254
00255 dbus_bool_t dbus_connection_get_unix_fd (DBusConnection *connection,
00256 int *fd);
00257
00258 DBUS_END_DECLS
00259
00260 #endif