2002-11-23 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / dbus / dbus-message.c
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.c  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
24 #include "dbus-message.h"
25
26 /**
27  * @defgroup DBusMessageInternals DBusMessage implementation details
28  * @ingroup DBusInternals
29  * @brief DBusMessage private implementation details.
30  *
31  * The guts of DBusMessage and its methods.
32  *
33  * @{
34  */
35
36 /**
37  * @brief Internals of DBusMessage
38  * 
39  * Object representing a message received from or to be sent to
40  * another application. This is an opaque object, all members
41  * are private.
42  */
43 struct DBusMessage
44 {
45   int refcount; /**< Reference count */
46   
47 };
48
49 /** @} */
50
51 /**
52  * @defgroup DBusMessage DBusMessage
53  * @ingroup  DBus
54  * @brief DBusMessage object
55  *
56  * Types and functions related to the DBusMessage object.
57  *
58  * @{
59  */
60
61 /**
62  * @typedef DBusMessage
63  *
64  * Opaque data type representing a message received from or to be
65  * sent to another application.
66  */
67
68 /**
69  * Constructs a new message.
70  * @return a new DBusMessage, free with dbus_message_unref()
71  * @see dbus_message_unref()
72  */
73 DBusMessage*
74 dbus_message_new (void)
75 {
76   
77   return NULL;
78 }
79
80
81 /**
82  * Increments the reference count of a DBusMessage.
83  *
84  * @param message The message
85  * @see dbus_message_unref
86  */
87 void
88 dbus_message_ref (DBusMessage *message)
89 {
90   
91 }
92
93 /**
94  * Decrements the reference count of a DBusMessage.
95  *
96  * @param message The message
97  * @see dbus_message_ref
98  */
99 void
100 dbus_message_unref (DBusMessage *message)
101 {
102
103
104 }
105
106 /** @} */