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 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
00098 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
00099 void dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
00100 dbus_bool_t exit_on_disconnect);
00101 void dbus_connection_flush (DBusConnection *connection);
00102 dbus_bool_t dbus_connection_read_write_dispatch (DBusConnection *connection,
00103 int timeout_milliseconds);
00104 dbus_bool_t dbus_connection_read_write (DBusConnection *connection,
00105 int timeout_milliseconds);
00106 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
00107 void dbus_connection_return_message (DBusConnection *connection,
00108 DBusMessage *message);
00109 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
00110 DBusMessage *message);
00111 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
00112 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection);
00113 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection);
00114 dbus_bool_t dbus_connection_has_messages_to_send (DBusConnection *connection);
00115 dbus_bool_t dbus_connection_send (DBusConnection *connection,
00116 DBusMessage *message,
00117 dbus_uint32_t *client_serial);
00118 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
00119 DBusMessage *message,
00120 DBusPendingCall **pending_return,
00121 int timeout_milliseconds);
00122 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection,
00123 DBusMessage *message,
00124 int timeout_milliseconds,
00125 DBusError *error);
00126 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection,
00127 DBusAddWatchFunction add_function,
00128 DBusRemoveWatchFunction remove_function,
00129 DBusWatchToggledFunction toggled_function,
00130 void *data,
00131 DBusFreeFunction free_data_function);
00132 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection,
00133 DBusAddTimeoutFunction add_function,
00134 DBusRemoveTimeoutFunction remove_function,
00135 DBusTimeoutToggledFunction toggled_function,
00136 void *data,
00137 DBusFreeFunction free_data_function);
00138 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
00139 DBusWakeupMainFunction wakeup_main_function,
00140 void *data,
00141 DBusFreeFunction free_data_function);
00142 void dbus_connection_set_dispatch_status_function (DBusConnection *connection,
00143 DBusDispatchStatusFunction function,
00144 void *data,
00145 DBusFreeFunction free_data_function);
00146 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection,
00147 unsigned long *uid);
00148 dbus_bool_t dbus_connection_get_unix_process_id (DBusConnection *connection,
00149 unsigned long *pid);
00150 void dbus_connection_set_unix_user_function (DBusConnection *connection,
00151 DBusAllowUnixUserFunction function,
00152 void *data,
00153 DBusFreeFunction free_data_function);
00154
00155
00156 int dbus_watch_get_fd (DBusWatch *watch);
00157 unsigned int dbus_watch_get_flags (DBusWatch *watch);
00158 void* dbus_watch_get_data (DBusWatch *watch);
00159 void dbus_watch_set_data (DBusWatch *watch,
00160 void *data,
00161 DBusFreeFunction free_data_function);
00162 dbus_bool_t dbus_watch_handle (DBusWatch *watch,
00163 unsigned int flags);
00164 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch);
00165
00166 int dbus_timeout_get_interval (DBusTimeout *timeout);
00167 void* dbus_timeout_get_data (DBusTimeout *timeout);
00168 void dbus_timeout_set_data (DBusTimeout *timeout,
00169 void *data,
00170 DBusFreeFunction free_data_function);
00171 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout);
00172 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout);
00173
00174
00175
00176 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
00177 DBusHandleMessageFunction function,
00178 void *user_data,
00179 DBusFreeFunction free_data_function);
00180 void dbus_connection_remove_filter (DBusConnection *connection,
00181 DBusHandleMessageFunction function,
00182 void *user_data);
00183
00184
00185
00186 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p);
00187 void dbus_connection_free_data_slot (dbus_int32_t *slot_p);
00188 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
00189 dbus_int32_t slot,
00190 void *data,
00191 DBusFreeFunction free_data_func);
00192 void* dbus_connection_get_data (DBusConnection *connection,
00193 dbus_int32_t slot);
00194
00195 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
00196
00197 void dbus_connection_set_max_message_size (DBusConnection *connection,
00198 long size);
00199 long dbus_connection_get_max_message_size (DBusConnection *connection);
00200 void dbus_connection_set_max_received_size (DBusConnection *connection,
00201 long size);
00202 long dbus_connection_get_max_received_size (DBusConnection *connection);
00203 long dbus_connection_get_outgoing_size (DBusConnection *connection);
00204
00205 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
00206 void dbus_connection_free_preallocated_send (DBusConnection *connection,
00207 DBusPreallocatedSend *preallocated);
00208 void dbus_connection_send_preallocated (DBusConnection *connection,
00209 DBusPreallocatedSend *preallocated,
00210 DBusMessage *message,
00211 dbus_uint32_t *client_serial);
00212
00213
00214
00215
00216 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection,
00217 void *user_data);
00218 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection,
00219 DBusMessage *message,
00220 void *user_data);
00221
00226 struct DBusObjectPathVTable
00227 {
00228 DBusObjectPathUnregisterFunction unregister_function;
00229 DBusObjectPathMessageFunction message_function;
00231 void (* dbus_internal_pad1) (void *);
00232 void (* dbus_internal_pad2) (void *);
00233 void (* dbus_internal_pad3) (void *);
00234 void (* dbus_internal_pad4) (void *);
00235 };
00236
00237 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection,
00238 const char *path,
00239 const DBusObjectPathVTable *vtable,
00240 void *user_data);
00241 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection,
00242 const char *path,
00243 const DBusObjectPathVTable *vtable,
00244 void *user_data);
00245 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection *connection,
00246 const char *path);
00247
00248 dbus_bool_t dbus_connection_get_object_path_data (DBusConnection *connection,
00249 const char *path,
00250 void **data_p);
00251
00252 dbus_bool_t dbus_connection_list_registered (DBusConnection *connection,
00253 const char *parent_path,
00254 char ***child_entries);
00255
00256 dbus_bool_t dbus_connection_get_unix_fd (DBusConnection *connection,
00257 int *fd);
00258
00259 DBUS_END_DECLS
00260
00261 #endif