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