1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.h DBusMessage object
4 * Copyright (C) 2002, 2003, 2005 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
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>
40 * @addtogroup DBusMessage
44 typedef struct DBusMessage DBusMessage;
45 typedef struct DBusMessageIter DBusMessageIter;
48 * DBusMessageIter struct; contains no public fields.
50 struct DBusMessageIter
52 void *dummy1; /**< Don't use this */
53 void *dummy2; /**< Don't use this */
54 dbus_uint32_t dummy3; /**< Don't use this */
55 int dummy4; /**< Don't use this */
56 int dummy5; /**< Don't use this */
57 int dummy6; /**< Don't use this */
58 int dummy7; /**< Don't use this */
59 int dummy8; /**< Don't use this */
60 int dummy9; /**< Don't use this */
61 int dummy10; /**< Don't use this */
62 int dummy11; /**< Don't use this */
63 int pad1; /**< Don't use this */
64 int pad2; /**< Don't use this */
65 void *pad3; /**< Don't use this */
68 DBusMessage* dbus_message_new (int message_type);
69 DBusMessage* dbus_message_new_method_call (const char *bus_name,
71 const char *interface,
73 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
74 DBusMessage* dbus_message_new_signal (const char *path,
75 const char *interface,
77 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
78 const char *error_name,
79 const char *error_message);
80 DBusMessage* dbus_message_new_error_printf (DBusMessage *reply_to,
81 const char *error_name,
82 const char *error_format,
85 DBusMessage* dbus_message_copy (const DBusMessage *message);
87 DBusMessage* dbus_message_ref (DBusMessage *message);
88 void dbus_message_unref (DBusMessage *message);
89 int dbus_message_get_type (DBusMessage *message);
90 dbus_bool_t dbus_message_set_path (DBusMessage *message,
91 const char *object_path);
92 const char* dbus_message_get_path (DBusMessage *message);
93 dbus_bool_t dbus_message_has_path (DBusMessage *message,
94 const char *object_path);
95 dbus_bool_t dbus_message_set_interface (DBusMessage *message,
96 const char *interface);
97 const char* dbus_message_get_interface (DBusMessage *message);
98 dbus_bool_t dbus_message_has_interface (DBusMessage *message,
99 const char *interface);
100 dbus_bool_t dbus_message_set_member (DBusMessage *message,
102 const char* dbus_message_get_member (DBusMessage *message);
103 dbus_bool_t dbus_message_has_member (DBusMessage *message,
105 dbus_bool_t dbus_message_set_error_name (DBusMessage *message,
107 const char* dbus_message_get_error_name (DBusMessage *message);
108 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
109 const char *destination);
110 const char* dbus_message_get_destination (DBusMessage *message);
111 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
113 const char* dbus_message_get_sender (DBusMessage *message);
114 const char* dbus_message_get_signature (DBusMessage *message);
115 void dbus_message_set_no_reply (DBusMessage *message,
116 dbus_bool_t no_reply);
117 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
118 dbus_bool_t dbus_message_is_method_call (DBusMessage *message,
119 const char *interface,
121 dbus_bool_t dbus_message_is_signal (DBusMessage *message,
122 const char *interface,
123 const char *signal_name);
124 dbus_bool_t dbus_message_is_error (DBusMessage *message,
125 const char *error_name);
126 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
127 const char *bus_name);
128 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
129 const char *unique_bus_name);
130 dbus_bool_t dbus_message_has_signature (DBusMessage *message,
131 const char *signature);
132 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
133 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
134 dbus_uint32_t reply_serial);
135 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
137 void dbus_message_set_auto_start (DBusMessage *message,
138 dbus_bool_t auto_start);
139 dbus_bool_t dbus_message_get_auto_start (DBusMessage *message);
141 dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message,
144 dbus_bool_t dbus_message_append_args (DBusMessage *message,
147 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
150 dbus_bool_t dbus_message_get_args (DBusMessage *message,
154 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
160 dbus_bool_t dbus_message_iter_init (DBusMessage *message,
161 DBusMessageIter *iter);
162 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
163 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
164 char* dbus_message_iter_get_signature (DBusMessageIter *iter);
165 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
166 int dbus_message_iter_get_element_type (DBusMessageIter *iter);
167 void dbus_message_iter_recurse (DBusMessageIter *iter,
168 DBusMessageIter *sub);
169 void dbus_message_iter_get_basic (DBusMessageIter *iter,
171 #ifndef DBUS_DISABLE_DEPRECATED
172 /* This function returns the wire protocol size of the array in bytes,
173 * you do not want to know that probably
175 int dbus_message_iter_get_array_len (DBusMessageIter *iter) DBUS_GNUC_DEPRECATED;
177 void dbus_message_iter_get_fixed_array (DBusMessageIter *iter,
182 void dbus_message_iter_init_append (DBusMessage *message,
183 DBusMessageIter *iter);
184 dbus_bool_t dbus_message_iter_append_basic (DBusMessageIter *iter,
187 dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
191 dbus_bool_t dbus_message_iter_open_container (DBusMessageIter *iter,
193 const char *contained_signature,
194 DBusMessageIter *sub);
195 dbus_bool_t dbus_message_iter_close_container (DBusMessageIter *iter,
196 DBusMessageIter *sub);
199 dbus_bool_t dbus_set_error_from_message (DBusError *error,
200 DBusMessage *message);
203 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
204 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
205 dbus_bool_t dbus_message_set_data (DBusMessage *message,
208 DBusFreeFunction free_data_func);
209 void* dbus_message_get_data (DBusMessage *message,
212 int dbus_message_type_from_string (const char *type_str);
213 const char * dbus_message_type_to_string (int type);
219 #endif /* DBUS_MESSAGE_H */