?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
adopt previous changes. (NicJA)
[AROS.git] / rom / dbus / include / dbus-message.h
blob4cd702d8467bedbaa268fa4ea8b186ebe22d5c1e
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.h DBusMessage object
3 *
4 * Copyright (C) 2002, 2003 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 *
22 */
23 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25 #endif
26
27 #ifndef DBUS_MESSAGE_H
28 #define DBUS_MESSAGE_H
29
30 #include <dbus/dbus-macros.h>
31 #include <dbus/dbus-types.h>
32 #include <dbus/dbus-arch-deps.h>
33 #include <dbus/dbus-memory.h>
34 #include <dbus/dbus-errors.h>
35 #include <stdarg.h>
36
37 DBUS_BEGIN_DECLS;
38
39 typedef struct DBusMessage DBusMessage;
40 typedef struct DBusMessageIter DBusMessageIter;
41
42 /**
43 * DBusMessageIter struct; contains no public fields
44 */
45 struct DBusMessageIter
46 {
47 void *dummy1; /**< Don't use this */
48 void *dummy2; /**< Don't use this */
49 dbus_uint32_t dummy3; /**< Don't use this */
50 int dummy4; /**< Don't use this */
51 int dummy5; /**< Don't use this */
52 int dummy6; /**< Don't use this */
53 int dummy7; /**< Don't use this */
54 int dummy8; /**< Don't use this */
55 int dummy9; /**< Don't use this */
56 int dummy10; /**< Don't use this */
57 int dummy11; /**< Don't use this */
58 int pad1; /**< Don't use this */
59 int pad2; /**< Don't use this */
60 void *pad3; /**< Don't use this */
61 };
62
63 DBusMessage* dbus_message_new (int message_type);
64 DBusMessage* dbus_message_new_method_call (const char *service,
65 const char *path,
66 const char *interface,
67 const char *method);
68 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
69 DBusMessage* dbus_message_new_signal (const char *path,
70 const char *interface,
71 const char *name);
72 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
73 const char *error_name,
74 const char *error_message);
75 DBusMessage* dbus_message_new_error_printf (DBusMessage *reply_to,
76 const char *error_name,
77 const char *error_format,
78 ...);
79
80 DBusMessage* dbus_message_copy (const DBusMessage *message);
81
82 DBusMessage* dbus_message_ref (DBusMessage *message);
83 void dbus_message_unref (DBusMessage *message);
84 int dbus_message_get_type (DBusMessage *message);
85 dbus_bool_t dbus_message_set_path (DBusMessage *message,
86 const char *object_path);
87 const char* dbus_message_get_path (DBusMessage *message);
88 dbus_bool_t dbus_message_set_interface (DBusMessage *message,
89 const char *interface);
90 const char* dbus_message_get_interface (DBusMessage *message);
91 dbus_bool_t dbus_message_set_member (DBusMessage *message,
92 const char *member);
93 const char* dbus_message_get_member (DBusMessage *message);
94 dbus_bool_t dbus_message_set_error_name (DBusMessage *message,
95 const char *name);
96 const char* dbus_message_get_error_name (DBusMessage *message);
97 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
98 const char *destination);
99 const char* dbus_message_get_destination (DBusMessage *message);
100 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
101 const char *sender);
102 const char* dbus_message_get_sender (DBusMessage *message);
103 const char* dbus_message_get_signature (DBusMessage *message);
104 void dbus_message_set_no_reply (DBusMessage *message,
105 dbus_bool_t no_reply);
106 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
107 dbus_bool_t dbus_message_is_method_call (DBusMessage *message,
108 const char *interface,
109 const char *method);
110 dbus_bool_t dbus_message_is_signal (DBusMessage *message,
111 const char *interface,
112 const char *signal_name);
113 dbus_bool_t dbus_message_is_error (DBusMessage *message,
114 const char *error_name);
115 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
116 const char *service);
117 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
118 const char *service);
119 dbus_bool_t dbus_message_has_signature (DBusMessage *message,
120 const char *signature);
121 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
122 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
123 dbus_uint32_t reply_serial);
124 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
125
126 void dbus_message_set_auto_activation (DBusMessage *message,
127 dbus_bool_t auto_activation);
128 dbus_bool_t dbus_message_get_auto_activation (DBusMessage *message);
129
130 dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message,
131 char ***path);
132
133 dbus_bool_t dbus_message_append_args (DBusMessage *message,
134 int first_arg_type,
135 ...);
136 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
137 int first_arg_type,
138 va_list var_args);
139 dbus_bool_t dbus_message_get_args (DBusMessage *message,
140 DBusError *error,
141 int first_arg_type,
142 ...);
143 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
144 DBusError *error,
145 int first_arg_type,
146 va_list var_args);
147 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
148 DBusError *error,
149 int first_arg_type,
150 ...);
151 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
152 DBusError *error,
153 int first_arg_type,
154 va_list var_args);
155
156
157 dbus_bool_t dbus_message_iter_init (DBusMessage *message,
158 DBusMessageIter *iter);
159 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
160 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
161 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
162 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
163 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
164 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
165 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
166 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
167 #ifdef DBUS_HAVE_INT64
168 dbus_int64_t dbus_message_iter_get_int64 (DBusMessageIter *iter);
169 dbus_uint64_t dbus_message_iter_get_uint64 (DBusMessageIter *iter);
170 #endif /* DBUS_HAVE_INT64 */
171 double dbus_message_iter_get_double (DBusMessageIter *iter);
172 char * dbus_message_iter_get_string (DBusMessageIter *iter);
173 char * dbus_message_iter_get_object_path (DBusMessageIter *iter);
174 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
175 dbus_bool_t dbus_message_iter_get_custom (DBusMessageIter *iter,
176 char **name,
177 unsigned char **value,
178 int *len);
179
180 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
181 DBusMessageIter *array_iter,
182 int *array_type);
183 dbus_bool_t dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
184 DBusMessageIter *dict_iter);
185 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
186 unsigned char **value,
187 int *len);
188 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
189 unsigned char **value,
190 int *len);
191 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
192 dbus_int32_t **value,
193 int *len);
194 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
195 dbus_uint32_t **value,
196 int *len);
197 #ifdef DBUS_HAVE_INT64
198 dbus_bool_t dbus_message_iter_get_int64_array (DBusMessageIter *iter,
199 dbus_int64_t **value,
200 int *len);
201 dbus_bool_t dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
202 dbus_uint64_t **value,
203 int *len);
204 #endif /* DBUS_HAVE_INT64 */
205 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
206 double **value,
207 int *len);
208 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
209 char ***value,
210 int *len);
211 dbus_bool_t dbus_message_iter_get_object_path_array (DBusMessageIter *iter,
212 char ***value,
213 int *len);
214
215
216 void dbus_message_append_iter_init (DBusMessage *message,
217 DBusMessageIter *iter);
218 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
219 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
220 dbus_bool_t value);
221 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
222 unsigned char value);
223 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
224 dbus_int32_t value);
225 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
226 dbus_uint32_t value);
227 #ifdef DBUS_HAVE_INT64
228 dbus_bool_t dbus_message_iter_append_int64 (DBusMessageIter *iter,
229 dbus_int64_t value);
230 dbus_bool_t dbus_message_iter_append_uint64 (DBusMessageIter *iter,
231 dbus_uint64_t value);
232 #endif /* DBUS_HAVE_INT64 */
233 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
234 double value);
235 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
236 const char *value);
237 dbus_bool_t dbus_message_iter_append_object_path (DBusMessageIter *iter,
238 const char *value);
239 dbus_bool_t dbus_message_iter_append_custom (DBusMessageIter *iter,
240 const char *name,
241 const unsigned char *data,
242 int len);
243 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
244 const char *value);
245 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
246 DBusMessageIter *array_iter,
247 int element_type);
248 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
249 DBusMessageIter *dict_iter);
250
251 /* Helpers for normal types: */
252 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
253 unsigned const char *value,
254 int len);
255 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
256 const dbus_int32_t *value,
257 int len);
258 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
259 const dbus_uint32_t *value,
260 int len);
261 #ifdef DBUS_HAVE_INT64
262 dbus_bool_t dbus_message_iter_append_int64_array (DBusMessageIter *iter,
263 const dbus_int64_t *value,
264 int len);
265 dbus_bool_t dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
266 const dbus_uint64_t *value,
267 int len);
268 #endif /* DBUS_HAVE_INT64 */
269 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
270 const double *value,
271 int len);
272 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
273 unsigned const char *value,
274 int len);
275 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
276 const char **value,
277 int len);
278 dbus_bool_t dbus_message_iter_append_object_path_array (DBusMessageIter *iter,
279 const char **value,
280 int len);
281
282
283
284 dbus_bool_t dbus_set_error_from_message (DBusError *error,
285 DBusMessage *message);
286
287
288 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
289 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
290 dbus_bool_t dbus_message_set_data (DBusMessage *message,
291 dbus_int32_t slot,
292 void *data,
293 DBusFreeFunction free_data_func);
294 void* dbus_message_get_data (DBusMessage *message,
295 dbus_int32_t slot);
296
297 int dbus_message_type_from_string (const char *type_str);
298
299 DBUS_END_DECLS;
300
301 #endif /* DBUS_MESSAGE_H */
Mirror of AROS' svn.