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_MESSAGE_H
00028 #define DBUS_MESSAGE_H
00029
00030 #include <dbus/dbus-macros.h>
00031 #include <dbus/dbus-types.h>
00032 #include <dbus/dbus-arch-deps.h>
00033 #include <dbus/dbus-memory.h>
00034 #include <dbus/dbus-errors.h>
00035 #include <stdarg.h>
00036
00037 DBUS_BEGIN_DECLS;
00038
00039 typedef struct DBusMessage DBusMessage;
00040 typedef struct DBusMessageIter DBusMessageIter;
00041
00045 struct DBusMessageIter
00046 {
00047 void *dummy1;
00048 void *dummy2;
00049 dbus_uint32_t dummy3;
00050 int dummy4;
00051 int dummy5;
00052 int dummy6;
00053 int dummy7;
00054 int dummy8;
00055 int dummy9;
00056 int dummy10;
00057 int dummy11;
00058 int pad1;
00059 int pad2;
00060 void *pad3;
00061 };
00062
00063 DBusMessage* dbus_message_new (int message_type);
00064 DBusMessage* dbus_message_new_method_call (const char *service,
00065 const char *path,
00066 const char *interface,
00067 const char *method);
00068 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
00069 DBusMessage* dbus_message_new_signal (const char *path,
00070 const char *interface,
00071 const char *name);
00072 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
00073 const char *error_name,
00074 const char *error_message);
00075
00076 DBusMessage* dbus_message_copy (const DBusMessage *message);
00077
00078 DBusMessage* dbus_message_ref (DBusMessage *message);
00079 void dbus_message_unref (DBusMessage *message);
00080 int dbus_message_get_type (DBusMessage *message);
00081 dbus_bool_t dbus_message_set_path (DBusMessage *message,
00082 const char *object_path);
00083 const char* dbus_message_get_path (DBusMessage *message);
00084 dbus_bool_t dbus_message_set_interface (DBusMessage *message,
00085 const char *interface);
00086 const char* dbus_message_get_interface (DBusMessage *message);
00087 dbus_bool_t dbus_message_set_member (DBusMessage *message,
00088 const char *member);
00089 const char* dbus_message_get_member (DBusMessage *message);
00090 dbus_bool_t dbus_message_set_error_name (DBusMessage *message,
00091 const char *name);
00092 const char* dbus_message_get_error_name (DBusMessage *message);
00093 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
00094 const char *destination);
00095 const char* dbus_message_get_destination (DBusMessage *message);
00096 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
00097 const char *sender);
00098 const char* dbus_message_get_sender (DBusMessage *message);
00099 const char* dbus_message_get_signature (DBusMessage *message);
00100 void dbus_message_set_no_reply (DBusMessage *message,
00101 dbus_bool_t no_reply);
00102 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
00103 dbus_bool_t dbus_message_is_method_call (DBusMessage *message,
00104 const char *interface,
00105 const char *method);
00106 dbus_bool_t dbus_message_is_signal (DBusMessage *message,
00107 const char *interface,
00108 const char *signal_name);
00109 dbus_bool_t dbus_message_is_error (DBusMessage *message,
00110 const char *error_name);
00111 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
00112 const char *service);
00113 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
00114 const char *service);
00115 dbus_bool_t dbus_message_has_signature (DBusMessage *message,
00116 const char *signature);
00117 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
00118 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
00119 dbus_uint32_t reply_serial);
00120 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
00121
00122 void dbus_message_set_auto_activation (DBusMessage *message,
00123 dbus_bool_t auto_activation);
00124 dbus_bool_t dbus_message_get_auto_activation (DBusMessage *message);
00125
00126 dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message,
00127 char ***path);
00128
00129 dbus_bool_t dbus_message_append_args (DBusMessage *message,
00130 int first_arg_type,
00131 ...);
00132 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
00133 int first_arg_type,
00134 va_list var_args);
00135 dbus_bool_t dbus_message_get_args (DBusMessage *message,
00136 DBusError *error,
00137 int first_arg_type,
00138 ...);
00139 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
00140 DBusError *error,
00141 int first_arg_type,
00142 va_list var_args);
00143 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
00144 DBusError *error,
00145 int first_arg_type,
00146 ...);
00147 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
00148 DBusError *error,
00149 int first_arg_type,
00150 va_list var_args);
00151
00152
00153 void dbus_message_iter_init (DBusMessage *message,
00154 DBusMessageIter *iter);
00155 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
00156 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
00157 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
00158 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
00159 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
00160 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
00161 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
00162 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
00163 #ifdef DBUS_HAVE_INT64
00164 dbus_int64_t dbus_message_iter_get_int64 (DBusMessageIter *iter);
00165 dbus_uint64_t dbus_message_iter_get_uint64 (DBusMessageIter *iter);
00166 #endif
00167 double dbus_message_iter_get_double (DBusMessageIter *iter);
00168 char * dbus_message_iter_get_string (DBusMessageIter *iter);
00169 char * dbus_message_iter_get_object_path (DBusMessageIter *iter);
00170 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
00171 dbus_bool_t dbus_message_iter_get_custom (DBusMessageIter *iter,
00172 char **name,
00173 unsigned char **value,
00174 int *len);
00175
00176 void dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
00177 DBusMessageIter *array_iter,
00178 int *array_type);
00179 void dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
00180 DBusMessageIter *dict_iter);
00181 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
00182 unsigned char **value,
00183 int *len);
00184 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
00185 unsigned char **value,
00186 int *len);
00187 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
00188 dbus_int32_t **value,
00189 int *len);
00190 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
00191 dbus_uint32_t **value,
00192 int *len);
00193 #ifdef DBUS_HAVE_INT64
00194 dbus_bool_t dbus_message_iter_get_int64_array (DBusMessageIter *iter,
00195 dbus_int64_t **value,
00196 int *len);
00197 dbus_bool_t dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
00198 dbus_uint64_t **value,
00199 int *len);
00200 #endif
00201 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
00202 double **value,
00203 int *len);
00204 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
00205 char ***value,
00206 int *len);
00207 dbus_bool_t dbus_message_iter_get_object_path_array (DBusMessageIter *iter,
00208 char ***value,
00209 int *len);
00210
00211
00212 void dbus_message_append_iter_init (DBusMessage *message,
00213 DBusMessageIter *iter);
00214 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
00215 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
00216 dbus_bool_t value);
00217 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
00218 unsigned char value);
00219 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
00220 dbus_int32_t value);
00221 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
00222 dbus_uint32_t value);
00223 #ifdef DBUS_HAVE_INT64
00224 dbus_bool_t dbus_message_iter_append_int64 (DBusMessageIter *iter,
00225 dbus_int64_t value);
00226 dbus_bool_t dbus_message_iter_append_uint64 (DBusMessageIter *iter,
00227 dbus_uint64_t value);
00228 #endif
00229 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
00230 double value);
00231 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
00232 const char *value);
00233 dbus_bool_t dbus_message_iter_append_custom (DBusMessageIter *iter,
00234 const char *name,
00235 const unsigned char *data,
00236 int len);
00237 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
00238 const char *value);
00239 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
00240 DBusMessageIter *array_iter,
00241 int element_type);
00242 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
00243 DBusMessageIter *dict_iter);
00244
00245
00246 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
00247 unsigned const char *value,
00248 int len);
00249 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
00250 const dbus_int32_t *value,
00251 int len);
00252 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
00253 const dbus_uint32_t *value,
00254 int len);
00255 #ifdef DBUS_HAVE_INT64
00256 dbus_bool_t dbus_message_iter_append_int64_array (DBusMessageIter *iter,
00257 const dbus_int64_t *value,
00258 int len);
00259 dbus_bool_t dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
00260 const dbus_uint64_t *value,
00261 int len);
00262 #endif
00263 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
00264 const double *value,
00265 int len);
00266 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
00267 unsigned const char *value,
00268 int len);
00269 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
00270 const char **value,
00271 int len);
00272
00273
00274
00275 dbus_bool_t dbus_set_error_from_message (DBusError *error,
00276 DBusMessage *message);
00277
00278
00279 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
00280 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
00281 dbus_bool_t dbus_message_set_data (DBusMessage *message,
00282 dbus_int32_t slot,
00283 void *data,
00284 DBusFreeFunction free_data_func);
00285 void* dbus_message_get_data (DBusMessage *message,
00286 dbus_int32_t slot);
00287
00288 int dbus_message_type_from_string (const char *type_str);
00289
00290 DBUS_END_DECLS;
00291
00292 #endif