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