|
sl@0
|
1 |
/* -*- mode: C; c-file-style: "gnu" -*- */
|
|
sl@0
|
2 |
/* dbus.h Convenience header including all other headers
|
|
sl@0
|
3 |
*
|
|
sl@0
|
4 |
* Copyright (C) 2002, 2003 Red Hat Inc.
|
|
sl@0
|
5 |
*
|
|
sl@0
|
6 |
* Licensed under the Academic Free License version 2.1
|
|
sl@0
|
7 |
*
|
|
sl@0
|
8 |
* This program is free software; you can redistribute it and/or modify
|
|
sl@0
|
9 |
* it under the terms of the GNU General Public License as published by
|
|
sl@0
|
10 |
* the Free Software Foundation; either version 2 of the License, or
|
|
sl@0
|
11 |
* (at your option) any later version.
|
|
sl@0
|
12 |
*
|
|
sl@0
|
13 |
* This program is distributed in the hope that it will be useful,
|
|
sl@0
|
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
sl@0
|
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
sl@0
|
16 |
* GNU General Public License for more details.
|
|
sl@0
|
17 |
*
|
|
sl@0
|
18 |
* You should have received a copy of the GNU General Public License
|
|
sl@0
|
19 |
* along with this program; if not, write to the Free Software
|
|
sl@0
|
20 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
sl@0
|
21 |
*
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#ifndef DBUS_H
|
|
sl@0
|
25 |
#define DBUS_H
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#define DBUS_INSIDE_DBUS_H 1
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
#include <dbus/dbus-arch-deps.h>
|
|
sl@0
|
30 |
#include <dbus/dbus-address.h>
|
|
sl@0
|
31 |
#include <dbus/dbus-bus.h>
|
|
sl@0
|
32 |
#include <dbus/dbus-connection.h>
|
|
sl@0
|
33 |
#include <dbus/dbus-errors.h>
|
|
sl@0
|
34 |
#include <dbus/dbus-macros.h>
|
|
sl@0
|
35 |
#include <dbus/dbus-message.h>
|
|
sl@0
|
36 |
#include <dbus/dbus-misc.h>
|
|
sl@0
|
37 |
#include <dbus/dbus-pending-call.h>
|
|
sl@0
|
38 |
#include <dbus/dbus-protocol.h>
|
|
sl@0
|
39 |
#include <dbus/dbus-server.h>
|
|
sl@0
|
40 |
#include <dbus/dbus-shared.h>
|
|
sl@0
|
41 |
#include <dbus/dbus-signature.h>
|
|
sl@0
|
42 |
#include <dbus/dbus-threads.h>
|
|
sl@0
|
43 |
#include <dbus/dbus-types.h>
|
|
sl@0
|
44 |
|
|
sl@0
|
45 |
#undef DBUS_INSIDE_DBUS_H
|
|
sl@0
|
46 |
|
|
sl@0
|
47 |
/**
|
|
sl@0
|
48 |
* @defgroup DBus D-Bus low-level public API
|
|
sl@0
|
49 |
* @brief The low-level public API of the D-Bus library
|
|
sl@0
|
50 |
*
|
|
sl@0
|
51 |
* libdbus provides a low-level C API intended primarily for use by
|
|
sl@0
|
52 |
* bindings to specific object systems and languages. D-Bus is most
|
|
sl@0
|
53 |
* convenient when used with the GLib bindings, Python bindings, Qt
|
|
sl@0
|
54 |
* bindings, Mono bindings, and so forth. This low-level API has a
|
|
sl@0
|
55 |
* lot of complexity useful only for bindings.
|
|
sl@0
|
56 |
*
|
|
sl@0
|
57 |
* @{
|
|
sl@0
|
58 |
*/
|
|
sl@0
|
59 |
|
|
sl@0
|
60 |
/** @} */
|
|
sl@0
|
61 |
|
|
sl@0
|
62 |
/**
|
|
sl@0
|
63 |
* @mainpage
|
|
sl@0
|
64 |
*
|
|
sl@0
|
65 |
* This manual documents the <em>low-level</em> D-Bus C API. <b>If you use
|
|
sl@0
|
66 |
* this low-level API directly, you're signing up for some pain.</b>
|
|
sl@0
|
67 |
*
|
|
sl@0
|
68 |
* Caveats aside, you might get started learning the low-level API by reading
|
|
sl@0
|
69 |
* about @ref DBusConnection and @ref DBusMessage.
|
|
sl@0
|
70 |
*
|
|
sl@0
|
71 |
* There are several other places to look for D-Bus information, such
|
|
sl@0
|
72 |
* as the tutorial and the specification; those can be found at <a
|
|
sl@0
|
73 |
* href="http://www.freedesktop.org/wiki/Software/dbus">the D-Bus
|
|
sl@0
|
74 |
* website</a>. If you're interested in a sysadmin or package
|
|
sl@0
|
75 |
* maintainer's perspective on the dbus-daemon itself and its
|
|
sl@0
|
76 |
* configuration, be sure to check out the man pages as well.
|
|
sl@0
|
77 |
*
|
|
sl@0
|
78 |
* The low-level API documented in this manual deliberately lacks
|
|
sl@0
|
79 |
* most convenience functions - those are left up to higher-level libraries
|
|
sl@0
|
80 |
* based on frameworks such as GLib, Qt, Python, Mono, Java,
|
|
sl@0
|
81 |
* etc. These higher-level libraries (often called "D-Bus bindings")
|
|
sl@0
|
82 |
* have features such as object systems and main loops that allow a
|
|
sl@0
|
83 |
* <em>much</em> more convenient API.
|
|
sl@0
|
84 |
*
|
|
sl@0
|
85 |
* The low-level API also contains plenty of clutter to support
|
|
sl@0
|
86 |
* integration with arbitrary object systems, languages, main loops,
|
|
sl@0
|
87 |
* and so forth. These features add a lot of noise to the API that you
|
|
sl@0
|
88 |
* probably don't care about unless you're coding a binding.
|
|
sl@0
|
89 |
*
|
|
sl@0
|
90 |
* This manual also contains docs for @ref DBusInternals "D-Bus internals",
|
|
sl@0
|
91 |
* so you can use it to get oriented to the D-Bus source code if you're
|
|
sl@0
|
92 |
* interested in patching the code. You should also read the
|
|
sl@0
|
93 |
* file HACKING which comes with the source code if you plan to contribute to
|
|
sl@0
|
94 |
* D-Bus.
|
|
sl@0
|
95 |
*
|
|
sl@0
|
96 |
* As you read the code, you can identify internal D-Bus functions
|
|
sl@0
|
97 |
* because they start with an underscore ('_') character. Also, any
|
|
sl@0
|
98 |
* identifier or macro that lacks a DBus, dbus_, or DBUS_ namepace
|
|
sl@0
|
99 |
* prefix is internal, with a couple of exceptions such as #NULL,
|
|
sl@0
|
100 |
* #TRUE, and #FALSE.
|
|
sl@0
|
101 |
*/
|
|
sl@0
|
102 |
|
|
sl@0
|
103 |
#endif /* DBUS_H */
|