dbus.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:4k
源码类别:

系统编程

开发平台:

Unix_Linux

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