2003-01-07 Anders Carlsson <andersca@codefactory.se>
[platform/upstream/dbus.git] / dbus / dbus-message.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.h DBusMessage object
3  *
4  * Copyright (C) 2002  Red Hat Inc.
5  *
6  * Licensed under the Academic Free License version 1.2
7  * 
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.
12  *
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.
17  * 
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
21  *
22  */
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."
25 #endif
26
27 #ifndef DBUS_MESSAGE_H
28 #define DBUS_MESSAGE_H
29
30 #include <dbus/dbus-macros.h>
31 #include <dbus/dbus-types.h>
32
33 DBUS_BEGIN_DECLS;
34
35 typedef struct DBusMessage DBusMessage;
36 typedef struct DBusMessageIter DBusMessageIter;
37
38 DBusMessage* dbus_message_new   (const char *service,
39                                  const char *name);
40
41 void         dbus_message_ref   (DBusMessage *message);
42 void         dbus_message_unref (DBusMessage *message);
43
44 const char*  dbus_message_get_name (DBusMessage *message);
45
46 dbus_bool_t dbus_message_append_int32      (DBusMessage         *message,
47                                             dbus_int32_t         value);
48 dbus_bool_t dbus_message_append_uint32     (DBusMessage         *message,
49                                             dbus_uint32_t        value);
50 dbus_bool_t dbus_message_append_double     (DBusMessage         *message,
51                                             double               value);
52 dbus_bool_t dbus_message_append_string     (DBusMessage         *message,
53                                             const char          *value);
54 dbus_bool_t dbus_message_append_byte_array (DBusMessage         *message,
55                                             unsigned const char *value,
56                                             int                  len);
57
58 DBusMessageIter *dbus_message_get_fields_iter     (DBusMessage     *message);
59
60 void        dbus_message_iter_ref            (DBusMessageIter *iter);
61 void        dbus_message_iter_unref          (DBusMessageIter *iter);
62
63 dbus_bool_t dbus_message_iter_has_next       (DBusMessageIter *iter);
64 dbus_bool_t dbus_message_iter_next           (DBusMessageIter *iter);
65 int         dbus_message_iter_get_field_type (DBusMessageIter *iter);
66 int         dbus_message_iter_get_int32      (DBusMessageIter *iter);
67 int         dbus_message_iter_get_uint32     (DBusMessageIter *iter);
68 double      dbus_message_iter_get_double     (DBusMessageIter *iter);
69 char *      dbus_message_iter_get_string     (DBusMessageIter *iter);
70
71
72
73 DBUS_END_DECLS;
74
75 #endif /* DBUS_MESSAGE_H */