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