1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.h DBusMessage object
4 * Copyright (C) 2002, 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.0
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.
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.
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
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."
27 #ifndef DBUS_MESSAGE_H
28 #define DBUS_MESSAGE_H
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>
39 typedef struct DBusMessage DBusMessage;
40 typedef struct DBusMessageIter DBusMessageIter;
43 * DBusMessageIter struct; contains no public fields
45 struct DBusMessageIter
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 */
63 DBusMessage* dbus_message_new (int message_type);
64 DBusMessage* dbus_message_new_method_call (const char *service,
66 const char *interface,
68 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
69 DBusMessage* dbus_message_new_signal (const char *path,
70 const char *interface,
72 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
73 const char *error_name,
74 const char *error_message);
76 DBusMessage* dbus_message_copy (const DBusMessage *message);
78 DBusMessage* dbus_message_ref (DBusMessage *message);
79 void dbus_message_unref (DBusMessage *message);
80 int dbus_message_get_type (DBusMessage *message);
81 dbus_bool_t dbus_message_set_path (DBusMessage *message,
82 const char *object_path);
83 const char* dbus_message_get_path (DBusMessage *message);
84 dbus_bool_t dbus_message_set_interface (DBusMessage *message,
85 const char *interface);
86 const char* dbus_message_get_interface (DBusMessage *message);
87 dbus_bool_t dbus_message_set_member (DBusMessage *message,
89 const char* dbus_message_get_member (DBusMessage *message);
90 dbus_bool_t dbus_message_set_error_name (DBusMessage *message,
92 const char* dbus_message_get_error_name (DBusMessage *message);
93 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
94 const char *destination);
95 const char* dbus_message_get_destination (DBusMessage *message);
96 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
98 const char* dbus_message_get_sender (DBusMessage *message);
99 const char* dbus_message_get_signature (DBusMessage *message);
100 void dbus_message_set_no_reply (DBusMessage *message,
101 dbus_bool_t no_reply);
102 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
103 dbus_bool_t dbus_message_is_method_call (DBusMessage *message,
104 const char *interface,
106 dbus_bool_t dbus_message_is_signal (DBusMessage *message,
107 const char *interface,
108 const char *signal_name);
109 dbus_bool_t dbus_message_is_error (DBusMessage *message,
110 const char *error_name);
111 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
112 const char *service);
113 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
114 const char *service);
115 dbus_bool_t dbus_message_has_signature (DBusMessage *message,
116 const char *signature);
117 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
118 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
119 dbus_uint32_t reply_serial);
120 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
122 void dbus_message_set_auto_activation (DBusMessage *message,
123 dbus_bool_t auto_activation);
124 dbus_bool_t dbus_message_get_auto_activation (DBusMessage *message);
126 dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message,
129 dbus_bool_t dbus_message_append_args (DBusMessage *message,
132 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
135 dbus_bool_t dbus_message_get_args (DBusMessage *message,
139 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
143 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
147 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
153 dbus_bool_t dbus_message_iter_init (DBusMessage *message,
154 DBusMessageIter *iter);
155 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
156 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
157 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
158 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
159 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
160 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
161 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
162 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
163 #ifdef DBUS_HAVE_INT64
164 dbus_int64_t dbus_message_iter_get_int64 (DBusMessageIter *iter);
165 dbus_uint64_t dbus_message_iter_get_uint64 (DBusMessageIter *iter);
166 #endif /* DBUS_HAVE_INT64 */
167 double dbus_message_iter_get_double (DBusMessageIter *iter);
168 char * dbus_message_iter_get_string (DBusMessageIter *iter);
169 char * dbus_message_iter_get_object_path (DBusMessageIter *iter);
170 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
171 dbus_bool_t dbus_message_iter_get_custom (DBusMessageIter *iter,
173 unsigned char **value,
176 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
177 DBusMessageIter *array_iter,
179 dbus_bool_t dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
180 DBusMessageIter *dict_iter);
181 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
182 unsigned char **value,
184 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
185 unsigned char **value,
187 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
188 dbus_int32_t **value,
190 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
191 dbus_uint32_t **value,
193 #ifdef DBUS_HAVE_INT64
194 dbus_bool_t dbus_message_iter_get_int64_array (DBusMessageIter *iter,
195 dbus_int64_t **value,
197 dbus_bool_t dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
198 dbus_uint64_t **value,
200 #endif /* DBUS_HAVE_INT64 */
201 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
204 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
207 dbus_bool_t dbus_message_iter_get_object_path_array (DBusMessageIter *iter,
212 void dbus_message_append_iter_init (DBusMessage *message,
213 DBusMessageIter *iter);
214 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
215 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
217 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
218 unsigned char value);
219 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
221 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
222 dbus_uint32_t value);
223 #ifdef DBUS_HAVE_INT64
224 dbus_bool_t dbus_message_iter_append_int64 (DBusMessageIter *iter,
226 dbus_bool_t dbus_message_iter_append_uint64 (DBusMessageIter *iter,
227 dbus_uint64_t value);
228 #endif /* DBUS_HAVE_INT64 */
229 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
231 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
233 dbus_bool_t dbus_message_iter_append_custom (DBusMessageIter *iter,
235 const unsigned char *data,
237 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
239 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
240 DBusMessageIter *array_iter,
242 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
243 DBusMessageIter *dict_iter);
245 /* Helpers for normal types: */
246 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
247 unsigned const char *value,
249 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
250 const dbus_int32_t *value,
252 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
253 const dbus_uint32_t *value,
255 #ifdef DBUS_HAVE_INT64
256 dbus_bool_t dbus_message_iter_append_int64_array (DBusMessageIter *iter,
257 const dbus_int64_t *value,
259 dbus_bool_t dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
260 const dbus_uint64_t *value,
262 #endif /* DBUS_HAVE_INT64 */
263 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
266 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
267 unsigned const char *value,
269 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
275 dbus_bool_t dbus_set_error_from_message (DBusError *error,
276 DBusMessage *message);
279 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
280 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
281 dbus_bool_t dbus_message_set_data (DBusMessage *message,
284 DBusFreeFunction free_data_func);
285 void* dbus_message_get_data (DBusMessage *message,
288 int dbus_message_type_from_string (const char *type_str);
292 #endif /* DBUS_MESSAGE_H */