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>
39 typedef struct DBusMessage DBusMessage;
40 typedef struct DBusMessageIter DBusMessageIter;
43 * DBusMessageIter struct; contains no public fields
45 struct DBusMessageIter
47 void *dummy1; /**< Don't use this */
48 void *dummy2; /**< Don't use this */
49 dbus_uint32_t dummy3; /**< Don't use this */
50 int dummy4; /**< Don't use this */
51 int dummy5; /**< Don't use this */
52 int dummy6; /**< Don't use this */
53 int dummy7; /**< Don't use this */
54 int dummy8; /**< Don't use this */
55 int dummy9; /**< Don't use this */
56 int dummy10; /**< Don't use this */
57 int dummy11; /**< Don't use this */
58 int pad1; /**< Don't use this */
59 int pad2; /**< Don't use this */
60 void *pad3; /**< Don't use this */
63 DBusMessage* dbus_message_new (int message_type);
64 DBusMessage* dbus_message_new_method_call (const char *bus_name,
66 const char *interface,
68 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
69 DBusMessage* dbus_message_new_signal (const char *path,
70 const char *interface,
72 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
73 const char *error_name,
74 const char *error_message);
75 DBusMessage* dbus_message_new_error_printf (DBusMessage *reply_to,
76 const char *error_name,
77 const char *error_format,
80 DBusMessage* dbus_message_copy (const DBusMessage *message);
82 DBusMessage* dbus_message_ref (DBusMessage *message);
83 void dbus_message_unref (DBusMessage *message);
84 int dbus_message_get_type (DBusMessage *message);
85 dbus_bool_t dbus_message_set_path (DBusMessage *message,
86 const char *object_path);
87 const char* dbus_message_get_path (DBusMessage *message);
88 dbus_bool_t dbus_message_set_interface (DBusMessage *message,
89 const char *interface);
90 const char* dbus_message_get_interface (DBusMessage *message);
91 dbus_bool_t dbus_message_set_member (DBusMessage *message,
93 const char* dbus_message_get_member (DBusMessage *message);
94 dbus_bool_t dbus_message_set_error_name (DBusMessage *message,
96 const char* dbus_message_get_error_name (DBusMessage *message);
97 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
98 const char *destination);
99 const char* dbus_message_get_destination (DBusMessage *message);
100 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
102 const char* dbus_message_get_sender (DBusMessage *message);
103 const char* dbus_message_get_signature (DBusMessage *message);
104 void dbus_message_set_no_reply (DBusMessage *message,
105 dbus_bool_t no_reply);
106 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
107 dbus_bool_t dbus_message_is_method_call (DBusMessage *message,
108 const char *interface,
110 dbus_bool_t dbus_message_is_signal (DBusMessage *message,
111 const char *interface,
112 const char *signal_name);
113 dbus_bool_t dbus_message_is_error (DBusMessage *message,
114 const char *error_name);
115 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
116 const char *bus_name);
117 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
118 const char *unique_bus_name);
119 dbus_bool_t dbus_message_has_signature (DBusMessage *message,
120 const char *signature);
121 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
122 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
123 dbus_uint32_t reply_serial);
124 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
126 void dbus_message_set_auto_start (DBusMessage *message,
127 dbus_bool_t auto_start);
128 dbus_bool_t dbus_message_get_auto_start (DBusMessage *message);
130 dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message,
133 dbus_bool_t dbus_message_append_args (DBusMessage *message,
136 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
139 dbus_bool_t dbus_message_get_args (DBusMessage *message,
143 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
149 dbus_bool_t dbus_message_iter_init (DBusMessage *message,
150 DBusMessageIter *iter);
151 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
152 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
153 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
154 int dbus_message_iter_get_element_type (DBusMessageIter *iter);
155 void dbus_message_iter_recurse (DBusMessageIter *iter,
156 DBusMessageIter *sub);
157 void dbus_message_iter_get_basic (DBusMessageIter *iter,
159 void dbus_message_iter_get_fixed_array (DBusMessageIter *iter,
164 void dbus_message_iter_init_append (DBusMessage *message,
165 DBusMessageIter *iter);
166 dbus_bool_t dbus_message_iter_append_basic (DBusMessageIter *iter,
169 dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
173 dbus_bool_t dbus_message_iter_open_container (DBusMessageIter *iter,
175 const char *contained_signature,
176 DBusMessageIter *sub);
177 dbus_bool_t dbus_message_iter_close_container (DBusMessageIter *iter,
178 DBusMessageIter *sub);
181 dbus_bool_t dbus_set_error_from_message (DBusError *error,
182 DBusMessage *message);
185 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
186 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
187 dbus_bool_t dbus_message_set_data (DBusMessage *message,
190 DBusFreeFunction free_data_func);
191 void* dbus_message_get_data (DBusMessage *message,
194 int dbus_message_type_from_string (const char *type_str);
195 const char * dbus_message_type_to_string (int type);
199 #endif /* DBUS_MESSAGE_H */