dbus-1.0/dbus/dbus.h

0001 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
0002 /* dbus.h  Convenience header including all other headers
0003  *
0004  * Copyright (C) 2002, 2003  Red Hat Inc.
0005  *
0006  * Licensed under the Academic Free License version 2.1
0007  *
0008  * This program is free software; you can redistribute it and/or modify
0009  * it under the terms of the GNU General Public License as published by
0010  * the Free Software Foundation; either version 2 of the License, or
0011  * (at your option) any later version.
0012  *
0013  * This program is distributed in the hope that it will be useful,
0014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0016  * GNU General Public License for more details.
0017  *
0018  * You should have received a copy of the GNU General Public License
0019  * along with this program; if not, write to the Free Software
0020  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0021  *
0022  */
0023
0024 #ifndef DBUS_H
0025 #define DBUS_H
0026
0027 #define DBUS_INSIDE_DBUS_H 1
0028
0029 #include <dbus/dbus-arch-deps.h>
0030 #include <dbus/dbus-address.h>
0031 #include <dbus/dbus-bus.h>
0032 #include <dbus/dbus-connection.h>
0033 #include <dbus/dbus-errors.h>
0034 #include <dbus/dbus-macros.h>
0035 #include <dbus/dbus-message.h>
0036 #include <dbus/dbus-misc.h>
0037 #include <dbus/dbus-pending-call.h>
0038 #include <dbus/dbus-protocol.h>
0039 #include <dbus/dbus-server.h>
0040 #include <dbus/dbus-shared.h>
0041 #include <dbus/dbus-signature.h>
0042 #include <dbus/dbus-syntax.h>
0043 #include <dbus/dbus-threads.h>
0044 #include <dbus/dbus-types.h>
0045
0046 #undef DBUS_INSIDE_DBUS_H
0047
0048 /**
0049  * @defgroup DBus D-Bus low-level public API
0050  * @brief The low-level public API of the D-Bus library
0051  *
0052  * libdbus provides a low-level C API intended primarily for use by
0053  * bindings to specific object systems and languages.  D-Bus is most
0054  * convenient when used with the GLib bindings, Python bindings, Qt
0055  * bindings, Mono bindings, and so forth.  This low-level API has a
0056  * lot of complexity useful only for bindings.
0057  *
0058  * @{
0059  */
0060
0061 /** @} */
0062
0063 /**
0064  * @mainpage
0065  *
0066  * This manual documents the <em>low-level</em> D-Bus C API. <b>If you use
0067  * this low-level API directly, you're signing up for some pain.</b>
0068  *
0069  * Caveats aside, you might get started learning the low-level API by reading
0070  * about @ref DBusConnection and @ref DBusMessage.
0071  *
0072  * There are several other places to look for D-Bus information, such
0073  * as the tutorial and the specification; those can be found at <a
0074  * href="http://www.freedesktop.org/wiki/Software/dbus">the D-Bus
0075  * website</a>. If you're interested in a sysadmin or package
0076  * maintainer's perspective on the dbus-daemon itself and its
0077  * configuration, be sure to check out the man pages as well.
0078  *
0079  * The low-level API documented in this manual deliberately lacks
0080  * most convenience functions - those are left up to higher-level libraries
0081  * based on frameworks such as GLib, Qt, Python, Mono, Java,
0082  * etc. These higher-level libraries (often called "D-Bus bindings")
0083  * have features such as object systems and main loops that allow a
0084  * <em>much</em> more convenient API.
0085  *
0086  * The low-level API also contains plenty of clutter to support
0087  * integration with arbitrary object systems, languages, main loops,
0088  * and so forth. These features add a lot of noise to the API that you
0089  * probably don't care about unless you're coding a binding.
0090  *
0091  * This manual also contains docs for @ref DBusInternals "D-Bus internals",
0092  * so you can use it to get oriented to the D-Bus source code if you're
0093  * interested in patching the code. You should also read the
0094  * file CONTRIBUTING.md which comes with the source code if you plan to
0095  * contribute to D-Bus.
0096  *
0097  * As you read the code, you can identify internal D-Bus functions
0098  * because they start with an underscore ('_') character. Also, any
0099  * identifier or macro that lacks a DBus, dbus_, or DBUS_ namepace
0100  * prefix is internal, with a couple of exceptions such as #NULL,
0101  * #TRUE, and #FALSE.
0102  */
0103
0104 #endif /* DBUS_H */