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>
36 typedef struct DBusMessage DBusMessage;
37 typedef struct DBusMessageIter DBusMessageIter;
39 struct DBusMessageIter
58 DBusMessage* dbus_message_new (const char *service,
60 DBusMessage* dbus_message_new_reply (DBusMessage *original_message);
61 DBusMessage* dbus_message_new_error_reply (DBusMessage *original_message,
62 const char *error_name,
63 const char *error_message);
64 DBusMessage *dbus_message_copy (const DBusMessage *message);
66 void dbus_message_ref (DBusMessage *message);
67 void dbus_message_unref (DBusMessage *message);
68 const char* dbus_message_get_name (DBusMessage *message);
69 const char* dbus_message_get_service (DBusMessage *message);
70 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
72 const char* dbus_message_get_sender (DBusMessage *message);
73 void dbus_message_set_is_error (DBusMessage *message,
74 dbus_bool_t is_error_reply);
75 dbus_bool_t dbus_message_get_is_error (DBusMessage *message);
76 dbus_bool_t dbus_message_name_is (DBusMessage *message,
78 dbus_bool_t dbus_message_service_is (DBusMessage *message,
80 dbus_bool_t dbus_message_sender_is (DBusMessage *message,
82 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
83 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
84 dbus_uint32_t reply_serial);
85 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
87 dbus_bool_t dbus_message_append_args (DBusMessage *message,
90 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
93 dbus_bool_t dbus_message_get_args (DBusMessage *message,
97 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
101 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
105 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
112 void dbus_message_iter_init (DBusMessage *message,
113 DBusMessageIter *iter);
114 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
115 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
116 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
117 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
118 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
119 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
120 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
121 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
122 double dbus_message_iter_get_double (DBusMessageIter *iter);
123 char * dbus_message_iter_get_string (DBusMessageIter *iter);
124 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
125 dbus_bool_t dbus_message_iter_get_named (DBusMessageIter *iter,
127 unsigned char **value,
130 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
131 DBusMessageIter *array_iter,
133 dbus_bool_t dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
134 DBusMessageIter *dict_iter);
135 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
136 unsigned char **value,
138 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
139 unsigned char **value,
141 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
142 dbus_int32_t **value,
144 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
145 dbus_uint32_t **value,
147 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
150 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
155 void dbus_message_append_iter_init (DBusMessage *message,
156 DBusMessageIter *iter);
157 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
158 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
160 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
161 unsigned char value);
162 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
164 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
165 dbus_uint32_t value);
166 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
168 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
170 dbus_bool_t dbus_message_iter_append_named (DBusMessageIter *iter,
172 const unsigned char *data,
174 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
176 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
177 DBusMessageIter *array_iter,
179 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
180 DBusMessageIter *dict_iter);
182 /* Helpers for normal types: */
183 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
184 unsigned const char *value,
186 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
187 const dbus_int32_t *value,
189 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
190 const dbus_uint32_t *value,
192 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
195 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
196 unsigned const char *value,
198 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
204 dbus_bool_t dbus_set_error_from_message (DBusError *error,
205 DBusMessage *message);
209 #endif /* DBUS_MESSAGE_H */