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 *name,
62 const char *destination_service);
63 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
64 DBusMessage* dbus_message_new_signal (const char *name);
65 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
66 const char *error_name,
67 const char *error_message);
69 DBusMessage *dbus_message_copy (const DBusMessage *message);
71 void dbus_message_ref (DBusMessage *message);
72 void dbus_message_unref (DBusMessage *message);
73 int dbus_message_get_type (DBusMessage *message);
74 dbus_bool_t dbus_message_set_name (DBusMessage *message,
76 const char* dbus_message_get_name (DBusMessage *message);
77 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
78 const char *destination);
79 const char* dbus_message_get_destination (DBusMessage *message);
80 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
82 const char* dbus_message_get_sender (DBusMessage *message);
83 void dbus_message_set_no_reply (DBusMessage *message,
84 dbus_bool_t no_reply);
85 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
86 dbus_bool_t dbus_message_has_name (DBusMessage *message,
88 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
90 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
92 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
93 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
94 dbus_uint32_t reply_serial);
95 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
97 dbus_bool_t dbus_message_append_args (DBusMessage *message,
100 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
103 dbus_bool_t dbus_message_get_args (DBusMessage *message,
107 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
111 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
115 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
122 void dbus_message_iter_init (DBusMessage *message,
123 DBusMessageIter *iter);
124 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
125 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
126 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
127 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
128 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
129 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
130 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
131 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
132 #ifdef DBUS_HAVE_INT64
133 dbus_int64_t dbus_message_iter_get_int64 (DBusMessageIter *iter);
134 dbus_uint64_t dbus_message_iter_get_uint64 (DBusMessageIter *iter);
135 #endif /* DBUS_HAVE_INT64 */
136 double dbus_message_iter_get_double (DBusMessageIter *iter);
137 char * dbus_message_iter_get_string (DBusMessageIter *iter);
138 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
139 dbus_bool_t dbus_message_iter_get_named (DBusMessageIter *iter,
141 unsigned char **value,
144 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
145 DBusMessageIter *array_iter,
147 dbus_bool_t dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
148 DBusMessageIter *dict_iter);
149 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
150 unsigned char **value,
152 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
153 unsigned char **value,
155 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
156 dbus_int32_t **value,
158 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
159 dbus_uint32_t **value,
161 #ifdef DBUS_HAVE_INT64
162 dbus_bool_t dbus_message_iter_get_int64_array (DBusMessageIter *iter,
163 dbus_int64_t **value,
165 dbus_bool_t dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
166 dbus_uint64_t **value,
168 #endif /* DBUS_HAVE_INT64 */
169 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
172 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
177 void dbus_message_append_iter_init (DBusMessage *message,
178 DBusMessageIter *iter);
179 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
180 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
182 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
183 unsigned char value);
184 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
186 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
187 dbus_uint32_t value);
188 #ifdef DBUS_HAVE_INT64
189 dbus_bool_t dbus_message_iter_append_int64 (DBusMessageIter *iter,
191 dbus_bool_t dbus_message_iter_append_uint64 (DBusMessageIter *iter,
192 dbus_uint64_t value);
193 #endif /* DBUS_HAVE_INT64 */
194 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
196 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
198 dbus_bool_t dbus_message_iter_append_named (DBusMessageIter *iter,
200 const unsigned char *data,
202 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
204 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
205 DBusMessageIter *array_iter,
207 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
208 DBusMessageIter *dict_iter);
210 /* Helpers for normal types: */
211 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
212 unsigned const char *value,
214 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
215 const dbus_int32_t *value,
217 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
218 const dbus_uint32_t *value,
220 #ifdef DBUS_HAVE_INT64
221 dbus_bool_t dbus_message_iter_append_int64_array (DBusMessageIter *iter,
222 const dbus_int64_t *value,
224 dbus_bool_t dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
225 const dbus_uint64_t *value,
227 #endif /* DBUS_HAVE_INT64 */
228 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
231 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
232 unsigned const char *value,
234 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
240 dbus_bool_t dbus_set_error_from_message (DBusError *error,
241 DBusMessage *message);
244 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
245 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
246 dbus_bool_t dbus_message_set_data (DBusMessage *message,
249 DBusFreeFunction free_data_func);
250 void* dbus_message_get_data (DBusMessage *message,
255 #endif /* DBUS_MESSAGE_H */