sl@0: /* -*- mode: C; c-file-style: "gnu" -*- */
sl@0: /* dbus-shared.h  Stuff used by both dbus/dbus.h low-level and C/C++ binding APIs
sl@0:  *
sl@0:  * Copyright (C) 2004 Red Hat, Inc.
sl@0:  *
sl@0:  * Licensed under the Academic Free License version 2.1
sl@0:  * 
sl@0:  * This program is free software; you can redistribute it and/or modify
sl@0:  * it under the terms of the GNU General Public License as published by
sl@0:  * the Free Software Foundation; either version 2 of the License, or
sl@0:  * (at your option) any later version.
sl@0:  *
sl@0:  * This program is distributed in the hope that it will be useful,
sl@0:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
sl@0:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
sl@0:  * GNU General Public License for more details.
sl@0:  * 
sl@0:  * You should have received a copy of the GNU General Public License
sl@0:  * along with this program; if not, write to the Free Software
sl@0:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
sl@0:  *
sl@0:  */
sl@0: 
sl@0: #ifndef DBUS_SHARED_H
sl@0: #define DBUS_SHARED_H
sl@0: 
sl@0: /* Don't include anything in here from anywhere else. It's
sl@0:  * intended for use by any random library.
sl@0:  */
sl@0: 
sl@0: #ifdef  __cplusplus
sl@0: extern "C" {
sl@0: #if 0
sl@0: } /* avoids confusing emacs indentation */
sl@0: #endif
sl@0: #endif
sl@0: 
sl@0: /* Normally docs are in .c files, but there isn't a .c file for this. */
sl@0: /**
sl@0:  * @defgroup DBusShared Shared constants 
sl@0:  * @ingroup  DBus
sl@0:  *
sl@0:  * @brief Shared header included by both libdbus and C/C++ bindings such as the GLib bindings.
sl@0:  *
sl@0:  * Usually a C/C++ binding such as the GLib or Qt binding won't want to include dbus.h in its
sl@0:  * public headers. However, a few constants and macros may be useful to include; those are
sl@0:  * found here and in dbus-protocol.h
sl@0:  *
sl@0:  * @{
sl@0:  */
sl@0: 
sl@0: 
sl@0: /**
sl@0:  * Well-known bus types. See dbus_bus_get().
sl@0:  */
sl@0: typedef enum
sl@0: {
sl@0:   DBUS_BUS_SESSION,    /**< The login session bus */
sl@0:   DBUS_BUS_SYSTEM,     /**< The systemwide bus */
sl@0:   DBUS_BUS_STARTER     /**< The bus that started us, if any */
sl@0: } DBusBusType;
sl@0: 
sl@0: /**
sl@0:  * Results that a message handler can return.
sl@0:  */
sl@0: typedef enum
sl@0: {
sl@0:   DBUS_HANDLER_RESULT_HANDLED,         /**< Message has had its effect - no need to run more handlers. */ 
sl@0:   DBUS_HANDLER_RESULT_NOT_YET_HANDLED, /**< Message has not had any effect - see if other handlers want it. */
sl@0:   DBUS_HANDLER_RESULT_NEED_MEMORY      /**< Need more memory in order to return #DBUS_HANDLER_RESULT_HANDLED or #DBUS_HANDLER_RESULT_NOT_YET_HANDLED. Please try again later with more memory. */
sl@0: } DBusHandlerResult;
sl@0: 
sl@0: /* Bus names */
sl@0: 
sl@0: /** The bus name used to talk to the bus itself. */
sl@0: #define DBUS_SERVICE_DBUS      "org.freedesktop.DBus"
sl@0: 
sl@0: /* Paths */
sl@0: /** The object path used to talk to the bus itself. */
sl@0: #define DBUS_PATH_DBUS  "/org/freedesktop/DBus"
sl@0: /** The object path used in local/in-process-generated messages. */
sl@0: #define DBUS_PATH_LOCAL "/org/freedesktop/DBus/Local"
sl@0: 
sl@0: /* Interfaces, these #define don't do much other than
sl@0:  * catch typos at compile time
sl@0:  */
sl@0: /** The interface exported by the object with #DBUS_SERVICE_DBUS and #DBUS_PATH_DBUS */
sl@0: #define DBUS_INTERFACE_DBUS           "org.freedesktop.DBus"
sl@0: /** The interface supported by introspectable objects */
sl@0: #define DBUS_INTERFACE_INTROSPECTABLE "org.freedesktop.DBus.Introspectable"
sl@0: /** The interface supported by objects with properties */
sl@0: #define DBUS_INTERFACE_PROPERTIES     "org.freedesktop.DBus.Properties"
sl@0: /** The interface supported by most dbus peers */
sl@0: #define DBUS_INTERFACE_PEER           "org.freedesktop.DBus.Peer"
sl@0: 
sl@0: /** This is a special interface whose methods can only be invoked
sl@0:  * by the local implementation (messages from remote apps aren't
sl@0:  * allowed to specify this interface).
sl@0:  */
sl@0: #define DBUS_INTERFACE_LOCAL "org.freedesktop.DBus.Local"
sl@0: 
sl@0: /* Owner flags */
sl@0: #define DBUS_NAME_FLAG_ALLOW_REPLACEMENT 0x1 /**< Allow another service to become the primary owner if requested */
sl@0: #define DBUS_NAME_FLAG_REPLACE_EXISTING  0x2 /**< Request to replace the current primary owner */
sl@0: #define DBUS_NAME_FLAG_DO_NOT_QUEUE      0x4 /**< If we can not become the primary owner do not place us in the queue */
sl@0: 
sl@0: /* Replies to request for a name */
sl@0: #define DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER  1 /**< Service has become the primary owner of the requested name */
sl@0: #define DBUS_REQUEST_NAME_REPLY_IN_QUEUE       2 /**< Service could not become the primary owner and has been placed in the queue */
sl@0: #define DBUS_REQUEST_NAME_REPLY_EXISTS         3 /**< Service is already in the queue */
sl@0: #define DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER  4 /**< Service is already the primary owner */
sl@0: 
sl@0: /* Replies to releasing a name */
sl@0: #define DBUS_RELEASE_NAME_REPLY_RELEASED        1 /**< Service was released from the given name */
sl@0: #define DBUS_RELEASE_NAME_REPLY_NON_EXISTENT    2 /**< The given name does not exist on the bus */
sl@0: #define DBUS_RELEASE_NAME_REPLY_NOT_OWNER       3 /**< Service is not an owner of the given name */
sl@0: 
sl@0: /* Replies to service starts */
sl@0: #define DBUS_START_REPLY_SUCCESS         1 /**< Service was auto started */
sl@0: #define DBUS_START_REPLY_ALREADY_RUNNING 2 /**< Service was already running */
sl@0: 
sl@0: /** @} */
sl@0: 
sl@0: #ifdef __cplusplus
sl@0: #if 0
sl@0: { /* avoids confusing emacs indentation */
sl@0: #endif
sl@0: }
sl@0: #endif
sl@0: 
sl@0: #endif /* DBUS_SHARED_H */