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>
37 typedef struct DBusMessage DBusMessage;
38 typedef struct DBusMessageIter DBusMessageIter;
40 struct DBusMessageIter
59 DBusMessage* dbus_message_new (const char *service,
61 DBusMessage* dbus_message_new_reply (DBusMessage *original_message);
62 DBusMessage* dbus_message_new_error_reply (DBusMessage *original_message,
63 const char *error_name,
64 const char *error_message);
65 DBusMessage *dbus_message_copy (const DBusMessage *message);
67 void dbus_message_ref (DBusMessage *message);
68 void dbus_message_unref (DBusMessage *message);
69 const char* dbus_message_get_name (DBusMessage *message);
70 const char* dbus_message_get_service (DBusMessage *message);
71 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
73 const char* dbus_message_get_sender (DBusMessage *message);
74 void dbus_message_set_is_error (DBusMessage *message,
75 dbus_bool_t is_error_reply);
76 dbus_bool_t dbus_message_get_is_error (DBusMessage *message);
77 dbus_bool_t dbus_message_name_is (DBusMessage *message,
79 dbus_bool_t dbus_message_service_is (DBusMessage *message,
81 dbus_bool_t dbus_message_sender_is (DBusMessage *message,
83 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
84 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
85 dbus_uint32_t reply_serial);
86 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
88 dbus_bool_t dbus_message_append_args (DBusMessage *message,
91 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
94 dbus_bool_t dbus_message_get_args (DBusMessage *message,
98 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
102 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
106 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
113 void dbus_message_iter_init (DBusMessage *message,
114 DBusMessageIter *iter);
115 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
116 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
117 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
118 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
119 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
120 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
121 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
122 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
123 #ifdef DBUS_HAVE_INT64
124 dbus_int64_t dbus_message_iter_get_int64 (DBusMessageIter *iter);
125 dbus_uint64_t dbus_message_iter_get_uint64 (DBusMessageIter *iter);
126 #endif /* DBUS_HAVE_INT64 */
127 double dbus_message_iter_get_double (DBusMessageIter *iter);
128 char * dbus_message_iter_get_string (DBusMessageIter *iter);
129 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
130 dbus_bool_t dbus_message_iter_get_named (DBusMessageIter *iter,
132 unsigned char **value,
135 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
136 DBusMessageIter *array_iter,
138 dbus_bool_t dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
139 DBusMessageIter *dict_iter);
140 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
141 unsigned char **value,
143 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
144 unsigned char **value,
146 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
147 dbus_int32_t **value,
149 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
150 dbus_uint32_t **value,
152 #ifdef DBUS_HAVE_INT64
153 dbus_bool_t dbus_message_iter_get_int64_array (DBusMessageIter *iter,
154 dbus_int64_t **value,
156 dbus_bool_t dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
157 dbus_uint64_t **value,
159 #endif /* DBUS_HAVE_INT64 */
160 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
163 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
168 void dbus_message_append_iter_init (DBusMessage *message,
169 DBusMessageIter *iter);
170 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
171 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
173 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
174 unsigned char value);
175 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
177 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
178 dbus_uint32_t value);
179 #ifdef DBUS_HAVE_INT64
180 dbus_bool_t dbus_message_iter_append_int64 (DBusMessageIter *iter,
182 dbus_bool_t dbus_message_iter_append_uint64 (DBusMessageIter *iter,
183 dbus_uint64_t value);
184 #endif /* DBUS_HAVE_INT64 */
185 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
187 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
189 dbus_bool_t dbus_message_iter_append_named (DBusMessageIter *iter,
191 const unsigned char *data,
193 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
195 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
196 DBusMessageIter *array_iter,
198 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
199 DBusMessageIter *dict_iter);
201 /* Helpers for normal types: */
202 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
203 unsigned const char *value,
205 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
206 const dbus_int32_t *value,
208 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
209 const dbus_uint32_t *value,
211 #ifdef DBUS_HAVE_INT64
212 dbus_bool_t dbus_message_iter_append_int64_array (DBusMessageIter *iter,
213 const dbus_int64_t *value,
215 dbus_bool_t dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
216 const dbus_uint64_t *value,
218 #endif /* DBUS_HAVE_INT64 */
219 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
222 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
223 unsigned const char *value,
225 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
231 dbus_bool_t dbus_set_error_from_message (DBusError *error,
232 DBusMessage *message);
236 #endif /* DBUS_MESSAGE_H */