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

系统编程

开发平台:

Unix_Linux

  1. /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
  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. #ifndef DBUS_SHARED_H
  24. #define DBUS_SHARED_H
  25. /* Don't include anything in here from anywhere else. It's
  26.  * intended for use by any random library.
  27.  */
  28. #ifdef  __cplusplus
  29. extern "C" {
  30. #if 0
  31. } /* avoids confusing emacs indentation */
  32. #endif
  33. #endif
  34. /* Normally docs are in .c files, but there isn't a .c file for this. */
  35. /**
  36.  * @defgroup DBusShared Shared constants 
  37.  * @ingroup  DBus
  38.  *
  39.  * @brief Shared header included by both libdbus and C/C++ bindings such as the GLib bindings.
  40.  *
  41.  * Usually a C/C++ binding such as the GLib or Qt binding won't want to include dbus.h in its
  42.  * public headers. However, a few constants and macros may be useful to include; those are
  43.  * found here and in dbus-protocol.h
  44.  *
  45.  * @{
  46.  */
  47. /**
  48.  * Well-known bus types. See dbus_bus_get().
  49.  */
  50. typedef enum
  51. {
  52.   DBUS_BUS_SESSION,    /**< The login session bus */
  53.   DBUS_BUS_SYSTEM,     /**< The systemwide bus */
  54.   DBUS_BUS_STARTER     /**< The bus that started us, if any */
  55. } DBusBusType;
  56. /**
  57.  * Results that a message handler can return.
  58.  */
  59. typedef enum
  60. {
  61.   DBUS_HANDLER_RESULT_HANDLED,         /**< Message has had its effect - no need to run more handlers. */ 
  62.   DBUS_HANDLER_RESULT_NOT_YET_HANDLED, /**< Message has not had any effect - see if other handlers want it. */
  63.   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. */
  64. } DBusHandlerResult;
  65. /* Bus names */
  66. /** The bus name used to talk to the bus itself. */
  67. #define DBUS_SERVICE_DBUS      "org.freedesktop.DBus"
  68. /* Paths */
  69. /** The object path used to talk to the bus itself. */
  70. #define DBUS_PATH_DBUS  "/org/freedesktop/DBus"
  71. /** The object path used in local/in-process-generated messages. */
  72. #define DBUS_PATH_LOCAL "/org/freedesktop/DBus/Local"
  73. /* Interfaces, these #define don't do much other than
  74.  * catch typos at compile time
  75.  */
  76. /** The interface exported by the object with #DBUS_SERVICE_DBUS and #DBUS_PATH_DBUS */
  77. #define DBUS_INTERFACE_DBUS           "org.freedesktop.DBus"
  78. /** The interface supported by introspectable objects */
  79. #define DBUS_INTERFACE_INTROSPECTABLE "org.freedesktop.DBus.Introspectable"
  80. /** The interface supported by objects with properties */
  81. #define DBUS_INTERFACE_PROPERTIES     "org.freedesktop.DBus.Properties"
  82. /** The interface supported by most dbus peers */
  83. #define DBUS_INTERFACE_PEER           "org.freedesktop.DBus.Peer"
  84. /** This is a special interface whose methods can only be invoked
  85.  * by the local implementation (messages from remote apps aren't
  86.  * allowed to specify this interface).
  87.  */
  88. #define DBUS_INTERFACE_LOCAL "org.freedesktop.DBus.Local"
  89. /* Owner flags */
  90. #define DBUS_NAME_FLAG_ALLOW_REPLACEMENT 0x1 /**< Allow another service to become the primary owner if requested */
  91. #define DBUS_NAME_FLAG_REPLACE_EXISTING  0x2 /**< Request to replace the current primary owner */
  92. #define DBUS_NAME_FLAG_DO_NOT_QUEUE      0x4 /**< If we can not become the primary owner do not place us in the queue */
  93. /* Replies to request for a name */
  94. #define DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER  1 /**< Service has become the primary owner of the requested name */
  95. #define DBUS_REQUEST_NAME_REPLY_IN_QUEUE       2 /**< Service could not become the primary owner and has been placed in the queue */
  96. #define DBUS_REQUEST_NAME_REPLY_EXISTS         3 /**< Service is already in the queue */
  97. #define DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER  4 /**< Service is already the primary owner */
  98. /* Replies to releasing a name */
  99. #define DBUS_RELEASE_NAME_REPLY_RELEASED        1 /**< Service was released from the given name */
  100. #define DBUS_RELEASE_NAME_REPLY_NON_EXISTENT    2 /**< The given name does not exist on the bus */
  101. #define DBUS_RELEASE_NAME_REPLY_NOT_OWNER       3 /**< Service is not an owner of the given name */
  102. /* Replies to service starts */
  103. #define DBUS_START_REPLY_SUCCESS         1 /**< Service was auto started */
  104. #define DBUS_START_REPLY_ALREADY_RUNNING 2 /**< Service was already running */
  105. /** @} */
  106. #ifdef __cplusplus
  107. #if 0
  108. { /* avoids confusing emacs indentation */
  109. #endif
  110. }
  111. #endif
  112. #endif /* DBUS_SHARED_H */