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-dict.h>
32 #include <dbus/dbus-types.h>
37 typedef struct DBusMessage DBusMessage;
38 typedef struct DBusMessageIter DBusMessageIter;
40 DBusMessage* dbus_message_new (const char *service,
42 DBusMessage* dbus_message_new_reply (DBusMessage *original_message);
43 DBusMessage* dbus_message_new_error_reply (DBusMessage *original_message,
44 const char *error_name,
45 const char *error_message);
46 DBusMessage *dbus_message_copy (const DBusMessage *message);
48 void dbus_message_ref (DBusMessage *message);
49 void dbus_message_unref (DBusMessage *message);
51 const char* dbus_message_get_name (DBusMessage *message);
52 const char* dbus_message_get_service (DBusMessage *message);
53 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
55 const char* dbus_message_get_sender (DBusMessage *message);
56 void dbus_message_set_is_error (DBusMessage *message,
57 dbus_bool_t is_error_reply);
58 dbus_bool_t dbus_message_get_is_error (DBusMessage *message);
59 dbus_bool_t dbus_message_name_is (DBusMessage *message,
61 dbus_bool_t dbus_message_service_is (DBusMessage *message,
63 dbus_bool_t dbus_message_sender_is (DBusMessage *message,
65 dbus_int32_t dbus_message_get_serial (DBusMessage *message);
66 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
67 dbus_int32_t reply_serial);
68 dbus_int32_t dbus_message_get_reply_serial (DBusMessage *message);
71 dbus_bool_t dbus_message_append_args (DBusMessage *message,
74 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
77 dbus_bool_t dbus_message_append_nil (DBusMessage *message);
78 dbus_bool_t dbus_message_append_boolean (DBusMessage *message,
80 dbus_bool_t dbus_message_append_int32 (DBusMessage *message,
82 dbus_bool_t dbus_message_append_uint32 (DBusMessage *message,
84 dbus_bool_t dbus_message_append_double (DBusMessage *message,
86 dbus_bool_t dbus_message_append_string (DBusMessage *message,
88 dbus_bool_t dbus_message_append_boolean_array (DBusMessage *message,
89 unsigned const char *value,
91 dbus_bool_t dbus_message_append_int32_array (DBusMessage *message,
92 const dbus_int32_t *value,
94 dbus_bool_t dbus_message_append_uint32_array (DBusMessage *message,
95 const dbus_uint32_t *value,
97 dbus_bool_t dbus_message_append_double_array (DBusMessage *message,
100 dbus_bool_t dbus_message_append_byte_array (DBusMessage *message,
101 unsigned const char *value,
103 dbus_bool_t dbus_message_append_string_array (DBusMessage *message,
106 dbus_bool_t dbus_message_append_dict (DBusMessage *message,
109 DBusMessageIter *dbus_message_get_args_iter (DBusMessage *message);
110 dbus_bool_t dbus_message_get_args (DBusMessage *message,
114 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
120 void dbus_message_iter_ref (DBusMessageIter *iter);
121 void dbus_message_iter_unref (DBusMessageIter *iter);
122 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
123 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
124 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
125 dbus_bool_t dbus_message_iter_get_boolean (DBusMessageIter *iter);
126 int dbus_message_iter_get_int32 (DBusMessageIter *iter);
127 int dbus_message_iter_get_uint32 (DBusMessageIter *iter);
128 double dbus_message_iter_get_double (DBusMessageIter *iter);
129 char * dbus_message_iter_get_string (DBusMessageIter *iter);
130 dbus_bool_t dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
131 unsigned char **value,
133 dbus_bool_t dbus_message_iter_get_int32_array (DBusMessageIter *iter,
134 dbus_int32_t **value,
136 dbus_bool_t dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
137 dbus_uint32_t **value,
139 dbus_bool_t dbus_message_iter_get_double_array (DBusMessageIter *iter,
142 dbus_bool_t dbus_message_iter_get_byte_array (DBusMessageIter *iter,
143 unsigned char **value,
145 dbus_bool_t dbus_message_iter_get_string_array (DBusMessageIter *iter,
148 dbus_bool_t dbus_message_iter_get_dict (DBusMessageIter *iter,
153 #endif /* DBUS_MESSAGE_H */