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