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 (int message_type);
61 DBusMessage* dbus_message_new_method_call (const char *service,
63 const char *interface,
65 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
66 DBusMessage* dbus_message_new_signal (const char *path,
67 const char *interface,
69 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
70 const char *error_name,
71 const char *error_message);
73 DBusMessage *dbus_message_copy (const DBusMessage *message);
75 void dbus_message_ref (DBusMessage *message);
76 void dbus_message_unref (DBusMessage *message);
77 int dbus_message_get_type (DBusMessage *message);
78 dbus_bool_t dbus_message_set_path (DBusMessage *message,
79 const char *object_path);
80 const char* dbus_message_get_path (DBusMessage *message);
81 dbus_bool_t dbus_message_set_interface (DBusMessage *message,
82 const char *interface);
83 const char* dbus_message_get_interface (DBusMessage *message);
84 dbus_bool_t dbus_message_set_member (DBusMessage *message,
86 const char* dbus_message_get_member (DBusMessage *message);
87 dbus_bool_t dbus_message_set_error_name (DBusMessage *message,
89 const char* dbus_message_get_error_name (DBusMessage *message);
90 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
91 const char *destination);
92 const char* dbus_message_get_destination (DBusMessage *message);
93 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
95 const char* dbus_message_get_sender (DBusMessage *message);
96 void dbus_message_set_no_reply (DBusMessage *message,
97 dbus_bool_t no_reply);
98 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
99 dbus_bool_t dbus_message_is_method_call (DBusMessage *message,
100 const char *interface,
102 dbus_bool_t dbus_message_is_signal (DBusMessage *message,
103 const char *interface,
104 const char *signal_name);
105 dbus_bool_t dbus_message_is_error (DBusMessage *message,
106 const char *error_name);
107 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
108 const char *service);
109 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
110 const char *service);
111 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
112 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
113 dbus_uint32_t reply_serial);
114 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
116 dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message,
119 dbus_bool_t dbus_message_append_args (DBusMessage *message,
122 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
125 dbus_bool_t dbus_message_get_args (DBusMessage *message,
129 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
133 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
137 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
144 void dbus_message_iter_init (DBusMessage *message,
145 DBusMessageIter *iter);
146 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
147 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
148 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
149 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
150 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
151 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
152 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
153 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
154 #ifdef DBUS_HAVE_INT64
155 dbus_int64_t dbus_message_iter_get_int64 (DBusMessageIter *iter);
156 dbus_uint64_t dbus_message_iter_get_uint64 (DBusMessageIter *iter);
157 #endif /* DBUS_HAVE_INT64 */
158 double dbus_message_iter_get_double (DBusMessageIter *iter);
159 char * dbus_message_iter_get_string (DBusMessageIter *iter);
160 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
161 dbus_bool_t dbus_message_iter_get_named (DBusMessageIter *iter,
163 unsigned char **value,
166 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
167 DBusMessageIter *array_iter,
169 dbus_bool_t dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
170 DBusMessageIter *dict_iter);
171 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
172 unsigned char **value,
174 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
175 unsigned char **value,
177 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
178 dbus_int32_t **value,
180 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
181 dbus_uint32_t **value,
183 #ifdef DBUS_HAVE_INT64
184 dbus_bool_t dbus_message_iter_get_int64_array (DBusMessageIter *iter,
185 dbus_int64_t **value,
187 dbus_bool_t dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
188 dbus_uint64_t **value,
190 #endif /* DBUS_HAVE_INT64 */
191 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
194 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
199 void dbus_message_append_iter_init (DBusMessage *message,
200 DBusMessageIter *iter);
201 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
202 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
204 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
205 unsigned char value);
206 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
208 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
209 dbus_uint32_t value);
210 #ifdef DBUS_HAVE_INT64
211 dbus_bool_t dbus_message_iter_append_int64 (DBusMessageIter *iter,
213 dbus_bool_t dbus_message_iter_append_uint64 (DBusMessageIter *iter,
214 dbus_uint64_t value);
215 #endif /* DBUS_HAVE_INT64 */
216 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
218 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
220 dbus_bool_t dbus_message_iter_append_named (DBusMessageIter *iter,
222 const unsigned char *data,
224 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
226 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
227 DBusMessageIter *array_iter,
229 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
230 DBusMessageIter *dict_iter);
232 /* Helpers for normal types: */
233 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
234 unsigned const char *value,
236 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
237 const dbus_int32_t *value,
239 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
240 const dbus_uint32_t *value,
242 #ifdef DBUS_HAVE_INT64
243 dbus_bool_t dbus_message_iter_append_int64_array (DBusMessageIter *iter,
244 const dbus_int64_t *value,
246 dbus_bool_t dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
247 const dbus_uint64_t *value,
249 #endif /* DBUS_HAVE_INT64 */
250 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
253 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
254 unsigned const char *value,
256 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
262 dbus_bool_t dbus_set_error_from_message (DBusError *error,
263 DBusMessage *message);
266 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
267 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
268 dbus_bool_t dbus_message_set_data (DBusMessage *message,
271 DBusFreeFunction free_data_func);
272 void* dbus_message_get_data (DBusMessage *message,
277 #endif /* DBUS_MESSAGE_H */