dbus/dbus-shared.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-shared.h  Stuff used by both dbus/dbus.h low-level and C/C++ binding APIs
   3  *
   4  * Copyright (C) 2004 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
  24 #ifndef DBUS_SHARED_H
  25 #define DBUS_SHARED_H
  26
  27 /* Don't include anything in here from anywhere else. It's
  28  * intended for use by any random library.
  29  */
  30
  31 #ifdef  __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 typedef enum
  36 {
  37   DBUS_BUS_SESSION,    /**< The login session bus */
  38   DBUS_BUS_SYSTEM,     /**< The systemwide bus */
  39   DBUS_BUS_STARTER     /**< The bus that started us, if any */
  40 } DBusBusType;
  41
  42 typedef enum
  43 {
  44   DBUS_HANDLER_RESULT_HANDLED,         /**< Message has had its effect */
  45   DBUS_HANDLER_RESULT_NOT_YET_HANDLED, /**< Message has not had any effect */
  46   DBUS_HANDLER_RESULT_NEED_MEMORY      /**< Need more memory to return another result */
  47 } DBusHandlerResult;
  48
  49 /* Services */
  50 #define DBUS_SERVICE_DBUS      "org.freedesktop.DBus"
  51
  52 /* Paths */
  53 #define DBUS_PATH_DBUS  "/org/freedesktop/DBus"
  54 #define DBUS_PATH_LOCAL "/org/freedesktop/DBus/Local"
  55
  56 /* Interfaces, these #define don't do much other than
  57  * catch typos at compile time
  58  */
  59 #define DBUS_INTERFACE_DBUS           "org.freedesktop.DBus"
  60 #define DBUS_INTERFACE_INTROSPECTABLE "org.freedesktop.DBus.Introspectable"
  61 #define DBUS_INTERFACE_PROPERTIES     "org.freedesktop.DBus.Properties"
  62 #define DBUS_INTERFACE_PEER           "org.freedesktop.DBus.Peer"
  63
  64 /* This is a special interface whose methods can only be invoked
  65  * by the local implementation (messages from remote apps aren't
  66  * allowed to specify this interface).
  67  */
  68 #define DBUS_INTERFACE_LOCAL "org.freedesktop.DBus.Local"
  69
  70 /* Owner flags */
  71 #define DBUS_NAME_FLAG_PROHIBIT_REPLACEMENT 0x1
  72 #define DBUS_NAME_FLAG_REPLACE_EXISTING     0x2
  73
  74 /* Replies to request for a name */
  75 #define DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER  1
  76 #define DBUS_REQUEST_NAME_REPLY_IN_QUEUE       2
  77 #define DBUS_REQUEST_NAME_REPLY_EXISTS         3
  78 #define DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER  4
  79
  80 /* Replies to releasing a name */
  81 #define DBUS_RELEASE_NAME_REPLY_RELEASED        1
  82 #define DBUS_RELEASE_NAME_REPLY_NON_EXISTENT    2
  83 #define DBUS_RELEASE_NAME_REPLY_NOT_OWNER       3
  84
  85 /* Replies to service starts */
  86 #define DBUS_START_REPLY_SUCCESS         1
  87 #define DBUS_START_REPLY_ALREADY_RUNNING 2
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif /* DBUS_PROTOCOL_H */