dbus/dbus.h

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