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
54 DBusMessage* dbus_message_new (const char *service,
56 DBusMessage* dbus_message_new_reply (DBusMessage *original_message);
57 DBusMessage* dbus_message_new_error_reply (DBusMessage *original_message,
58 const char *error_name,
59 const char *error_message);
60 DBusMessage *dbus_message_copy (const DBusMessage *message);
62 void dbus_message_ref (DBusMessage *message);
63 void dbus_message_unref (DBusMessage *message);
65 const char* dbus_message_get_name (DBusMessage *message);
66 const char* dbus_message_get_service (DBusMessage *message);
67 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
69 const char* dbus_message_get_sender (DBusMessage *message);
70 void dbus_message_set_is_error (DBusMessage *message,
71 dbus_bool_t is_error_reply);
72 dbus_bool_t dbus_message_get_is_error (DBusMessage *message);
73 dbus_bool_t dbus_message_name_is (DBusMessage *message,
75 dbus_bool_t dbus_message_service_is (DBusMessage *message,
77 dbus_bool_t dbus_message_sender_is (DBusMessage *message,
79 dbus_int32_t dbus_message_get_serial (DBusMessage *message);
80 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
81 dbus_int32_t reply_serial);
82 dbus_int32_t dbus_message_get_reply_serial (DBusMessage *message);
85 dbus_bool_t dbus_message_append_args (DBusMessage *message,
88 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
91 dbus_bool_t dbus_message_get_args (DBusMessage *message,
95 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
99 dbus_bool_t dbus_message_iter_get_args (DBusMessageIter *iter,
103 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
110 void dbus_message_iter_init (DBusMessage *message,
111 DBusMessageIter *iter);
112 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
113 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
114 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
115 int dbus_message_iter_get_array_type (DBusMessageIter *iter);
116 unsigned char dbus_message_iter_get_byte (DBusMessageIter *iter);
117 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
118 dbus_int32_t dbus_message_iter_get_int32 (DBusMessageIter *iter);
119 dbus_uint32_t dbus_message_iter_get_uint32 (DBusMessageIter *iter);
120 double dbus_message_iter_get_double (DBusMessageIter *iter);
121 char * dbus_message_iter_get_string (DBusMessageIter *iter);
122 char * dbus_message_iter_get_dict_key (DBusMessageIter *iter);
123 char * dbus_message_iter_get_named (DBusMessageIter *iter,
124 unsigned char **value,
127 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
128 DBusMessageIter *array_iter,
130 dbus_bool_t dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
131 DBusMessageIter *dict_iter);
132 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
133 unsigned char **value,
135 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
136 unsigned char **value,
138 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
139 dbus_int32_t **value,
141 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
142 dbus_uint32_t **value,
144 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
147 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
152 void dbus_message_append_iter_init (DBusMessage *message,
153 DBusMessageIter *iter);
154 dbus_bool_t dbus_message_iter_append_nil (DBusMessageIter *iter);
155 dbus_bool_t dbus_message_iter_append_boolean (DBusMessageIter *iter,
157 dbus_bool_t dbus_message_iter_append_byte (DBusMessageIter *iter,
158 unsigned char value);
159 dbus_bool_t dbus_message_iter_append_int32 (DBusMessageIter *iter,
161 dbus_bool_t dbus_message_iter_append_uint32 (DBusMessageIter *iter,
162 dbus_uint32_t value);
163 dbus_bool_t dbus_message_iter_append_double (DBusMessageIter *iter,
165 dbus_bool_t dbus_message_iter_append_string (DBusMessageIter *iter,
167 dbus_bool_t dbus_message_iter_append_named (DBusMessageIter *iter,
169 const unsigned char *data,
171 dbus_bool_t dbus_message_iter_append_dict_key (DBusMessageIter *iter,
173 dbus_bool_t dbus_message_iter_append_array (DBusMessageIter *iter,
174 DBusMessageIter *array_iter,
176 dbus_bool_t dbus_message_iter_append_dict (DBusMessageIter *iter,
177 DBusMessageIter *dict_iter);
179 /* Helpers for normal types: */
180 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
181 unsigned const char *value,
183 dbus_bool_t dbus_message_iter_append_int32_array (DBusMessageIter *iter,
184 const dbus_int32_t *value,
186 dbus_bool_t dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
187 const dbus_uint32_t *value,
189 dbus_bool_t dbus_message_iter_append_double_array (DBusMessageIter *iter,
192 dbus_bool_t dbus_message_iter_append_byte_array (DBusMessageIter *iter,
193 unsigned const char *value,
195 dbus_bool_t dbus_message_iter_append_string_array (DBusMessageIter *iter,
201 dbus_bool_t dbus_set_error_from_message (DBusError *error,
202 DBusMessage *message);
206 #endif /* DBUS_MESSAGE_H */