1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.h DBusMessage object
4 * Copyright (C) 2002 Red Hat Inc.
6 * Licensed under the Academic Free License version 1.2
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;
42 struct DBusMessageIter
60 DBusMessage* dbus_message_new_method_call (const char *name,
61 const char *destination_service);
62 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
63 DBusMessage* dbus_message_new_signal (const char *name);
64 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
65 const char *error_name,
66 const char *error_message);
68 DBusMessage *dbus_message_copy (const DBusMessage *message);
70 void dbus_message_ref (DBusMessage *message);
71 void dbus_message_unref (DBusMessage *message);
72 int dbus_message_get_type (DBusMessage *message);
73 const char* dbus_message_get_name (DBusMessage *message);
74 const char* dbus_message_get_destination (DBusMessage *message);
75 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
77 const char* dbus_message_get_sender (DBusMessage *message);
78 void dbus_message_set_is_error (DBusMessage *message,
79 dbus_bool_t is_error_reply);
80 dbus_bool_t dbus_message_get_is_error (DBusMessage *message);
81 dbus_bool_t dbus_message_has_name (DBusMessage *message,
83 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
85 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
87 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
88 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
89 dbus_uint32_t reply_serial);
90 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
92 dbus_bool_t dbus_message_append_args (DBusMessage *message,
95 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
98 dbus_bool_t dbus_message_get_args (DBusMessage *message,
102 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
106 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
110 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
117 void dbus_message_iter_init (DBusMessage *message,
118 DBusMessageIter *iter);
119 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
120 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
121 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
122 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
123 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
124 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
125 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
126 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
127 #ifdef DBUS_HAVE_INT64
128 dbus_int64_t dbus_message_iter_get_int64 (DBusMessageIter *iter);
129 dbus_uint64_t dbus_message_iter_get_uint64 (DBusMessageIter *iter);
130 #endif /* DBUS_HAVE_INT64 */
131 double dbus_message_iter_get_double (DBusMessageIter *iter);
132 char * dbus_message_iter_get_string (DBusMessageIter *iter);
133 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
134 dbus_bool_t dbus_message_iter_get_named (DBusMessageIter *iter,
136 unsigned char **value,
139 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
140 DBusMessageIter *array_iter,
142 dbus_bool_t dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
143 DBusMessageIter *dict_iter);
144 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
145 unsigned char **value,
147 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
148 unsigned char **value,
150 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
151 dbus_int32_t **value,
153 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
154 dbus_uint32_t **value,
156 #ifdef DBUS_HAVE_INT64
157 dbus_bool_t dbus_message_iter_get_int64_array (DBusMessageIter *iter,
158 dbus_int64_t **value,
160 dbus_bool_t dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
161 dbus_uint64_t **value,
163 #endif /* DBUS_HAVE_INT64 */
164 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
167 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
172 void dbus_message_append_iter_init (DBusMessage *message,
173 DBusMessageIter *iter);
174 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
175 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
177 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
178 unsigned char value);
179 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
181 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
182 dbus_uint32_t value);
183 #ifdef DBUS_HAVE_INT64
184 dbus_bool_t dbus_message_iter_append_int64 (DBusMessageIter *iter,
186 dbus_bool_t dbus_message_iter_append_uint64 (DBusMessageIter *iter,
187 dbus_uint64_t value);
188 #endif /* DBUS_HAVE_INT64 */
189 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
191 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
193 dbus_bool_t dbus_message_iter_append_named (DBusMessageIter *iter,
195 const unsigned char *data,
197 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
199 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
200 DBusMessageIter *array_iter,
202 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
203 DBusMessageIter *dict_iter);
205 /* Helpers for normal types: */
206 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
207 unsigned const char *value,
209 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
210 const dbus_int32_t *value,
212 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
213 const dbus_uint32_t *value,
215 #ifdef DBUS_HAVE_INT64
216 dbus_bool_t dbus_message_iter_append_int64_array (DBusMessageIter *iter,
217 const dbus_int64_t *value,
219 dbus_bool_t dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
220 const dbus_uint64_t *value,
222 #endif /* DBUS_HAVE_INT64 */
223 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
226 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
227 unsigned const char *value,
229 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
235 dbus_bool_t dbus_set_error_from_message (DBusError *error,
236 DBusMessage *message);
239 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
240 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
241 dbus_bool_t dbus_message_set_data (DBusMessage *message,
244 DBusFreeFunction free_data_func);
245 void* dbus_message_get_data (DBusMessage *message,
250 #endif /* DBUS_MESSAGE_H */