|
sl@0
|
1 |
/* -*- mode: C; c-file-style: "gnu" -*- */
|
|
sl@0
|
2 |
/* dbus-shared.h Stuff used by both dbus/dbus.h low-level and C/C++ binding APIs
|
|
sl@0
|
3 |
*
|
|
sl@0
|
4 |
* Copyright (C) 2004 Red Hat, Inc.
|
|
sl@0
|
5 |
*
|
|
sl@0
|
6 |
* Licensed under the Academic Free License version 2.1
|
|
sl@0
|
7 |
*
|
|
sl@0
|
8 |
* This program is free software; you can redistribute it and/or modify
|
|
sl@0
|
9 |
* it under the terms of the GNU General Public License as published by
|
|
sl@0
|
10 |
* the Free Software Foundation; either version 2 of the License, or
|
|
sl@0
|
11 |
* (at your option) any later version.
|
|
sl@0
|
12 |
*
|
|
sl@0
|
13 |
* This program is distributed in the hope that it will be useful,
|
|
sl@0
|
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
sl@0
|
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
sl@0
|
16 |
* GNU General Public License for more details.
|
|
sl@0
|
17 |
*
|
|
sl@0
|
18 |
* You should have received a copy of the GNU General Public License
|
|
sl@0
|
19 |
* along with this program; if not, write to the Free Software
|
|
sl@0
|
20 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
sl@0
|
21 |
*
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#ifndef DBUS_SHARED_H
|
|
sl@0
|
25 |
#define DBUS_SHARED_H
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
/* Don't include anything in here from anywhere else. It's
|
|
sl@0
|
28 |
* intended for use by any random library.
|
|
sl@0
|
29 |
*/
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
#ifdef __cplusplus
|
|
sl@0
|
32 |
extern "C" {
|
|
sl@0
|
33 |
#if 0
|
|
sl@0
|
34 |
} /* avoids confusing emacs indentation */
|
|
sl@0
|
35 |
#endif
|
|
sl@0
|
36 |
#endif
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
/* Normally docs are in .c files, but there isn't a .c file for this. */
|
|
sl@0
|
39 |
/**
|
|
sl@0
|
40 |
* @defgroup DBusShared Shared constants
|
|
sl@0
|
41 |
* @ingroup DBus
|
|
sl@0
|
42 |
*
|
|
sl@0
|
43 |
* @brief Shared header included by both libdbus and C/C++ bindings such as the GLib bindings.
|
|
sl@0
|
44 |
*
|
|
sl@0
|
45 |
* Usually a C/C++ binding such as the GLib or Qt binding won't want to include dbus.h in its
|
|
sl@0
|
46 |
* public headers. However, a few constants and macros may be useful to include; those are
|
|
sl@0
|
47 |
* found here and in dbus-protocol.h
|
|
sl@0
|
48 |
*
|
|
sl@0
|
49 |
* @{
|
|
sl@0
|
50 |
*/
|
|
sl@0
|
51 |
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
/**
|
|
sl@0
|
54 |
* Well-known bus types. See dbus_bus_get().
|
|
sl@0
|
55 |
*/
|
|
sl@0
|
56 |
typedef enum
|
|
sl@0
|
57 |
{
|
|
sl@0
|
58 |
DBUS_BUS_SESSION, /**< The login session bus */
|
|
sl@0
|
59 |
DBUS_BUS_SYSTEM, /**< The systemwide bus */
|
|
sl@0
|
60 |
DBUS_BUS_STARTER /**< The bus that started us, if any */
|
|
sl@0
|
61 |
} DBusBusType;
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
/**
|
|
sl@0
|
64 |
* Results that a message handler can return.
|
|
sl@0
|
65 |
*/
|
|
sl@0
|
66 |
typedef enum
|
|
sl@0
|
67 |
{
|
|
sl@0
|
68 |
DBUS_HANDLER_RESULT_HANDLED, /**< Message has had its effect - no need to run more handlers. */
|
|
sl@0
|
69 |
DBUS_HANDLER_RESULT_NOT_YET_HANDLED, /**< Message has not had any effect - see if other handlers want it. */
|
|
sl@0
|
70 |
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
|
71 |
} DBusHandlerResult;
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
/* Bus names */
|
|
sl@0
|
74 |
|
|
sl@0
|
75 |
/** The bus name used to talk to the bus itself. */
|
|
sl@0
|
76 |
#define DBUS_SERVICE_DBUS "org.freedesktop.DBus"
|
|
sl@0
|
77 |
|
|
sl@0
|
78 |
/* Paths */
|
|
sl@0
|
79 |
/** The object path used to talk to the bus itself. */
|
|
sl@0
|
80 |
#define DBUS_PATH_DBUS "/org/freedesktop/DBus"
|
|
sl@0
|
81 |
/** The object path used in local/in-process-generated messages. */
|
|
sl@0
|
82 |
#define DBUS_PATH_LOCAL "/org/freedesktop/DBus/Local"
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
/* Interfaces, these #define don't do much other than
|
|
sl@0
|
85 |
* catch typos at compile time
|
|
sl@0
|
86 |
*/
|
|
sl@0
|
87 |
/** The interface exported by the object with #DBUS_SERVICE_DBUS and #DBUS_PATH_DBUS */
|
|
sl@0
|
88 |
#define DBUS_INTERFACE_DBUS "org.freedesktop.DBus"
|
|
sl@0
|
89 |
/** The interface supported by introspectable objects */
|
|
sl@0
|
90 |
#define DBUS_INTERFACE_INTROSPECTABLE "org.freedesktop.DBus.Introspectable"
|
|
sl@0
|
91 |
/** The interface supported by objects with properties */
|
|
sl@0
|
92 |
#define DBUS_INTERFACE_PROPERTIES "org.freedesktop.DBus.Properties"
|
|
sl@0
|
93 |
/** The interface supported by most dbus peers */
|
|
sl@0
|
94 |
#define DBUS_INTERFACE_PEER "org.freedesktop.DBus.Peer"
|
|
sl@0
|
95 |
|
|
sl@0
|
96 |
/** This is a special interface whose methods can only be invoked
|
|
sl@0
|
97 |
* by the local implementation (messages from remote apps aren't
|
|
sl@0
|
98 |
* allowed to specify this interface).
|
|
sl@0
|
99 |
*/
|
|
sl@0
|
100 |
#define DBUS_INTERFACE_LOCAL "org.freedesktop.DBus.Local"
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
/* Owner flags */
|
|
sl@0
|
103 |
#define DBUS_NAME_FLAG_ALLOW_REPLACEMENT 0x1 /**< Allow another service to become the primary owner if requested */
|
|
sl@0
|
104 |
#define DBUS_NAME_FLAG_REPLACE_EXISTING 0x2 /**< Request to replace the current primary owner */
|
|
sl@0
|
105 |
#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
|
106 |
|
|
sl@0
|
107 |
/* Replies to request for a name */
|
|
sl@0
|
108 |
#define DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER 1 /**< Service has become the primary owner of the requested name */
|
|
sl@0
|
109 |
#define DBUS_REQUEST_NAME_REPLY_IN_QUEUE 2 /**< Service could not become the primary owner and has been placed in the queue */
|
|
sl@0
|
110 |
#define DBUS_REQUEST_NAME_REPLY_EXISTS 3 /**< Service is already in the queue */
|
|
sl@0
|
111 |
#define DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER 4 /**< Service is already the primary owner */
|
|
sl@0
|
112 |
|
|
sl@0
|
113 |
/* Replies to releasing a name */
|
|
sl@0
|
114 |
#define DBUS_RELEASE_NAME_REPLY_RELEASED 1 /**< Service was released from the given name */
|
|
sl@0
|
115 |
#define DBUS_RELEASE_NAME_REPLY_NON_EXISTENT 2 /**< The given name does not exist on the bus */
|
|
sl@0
|
116 |
#define DBUS_RELEASE_NAME_REPLY_NOT_OWNER 3 /**< Service is not an owner of the given name */
|
|
sl@0
|
117 |
|
|
sl@0
|
118 |
/* Replies to service starts */
|
|
sl@0
|
119 |
#define DBUS_START_REPLY_SUCCESS 1 /**< Service was auto started */
|
|
sl@0
|
120 |
#define DBUS_START_REPLY_ALREADY_RUNNING 2 /**< Service was already running */
|
|
sl@0
|
121 |
|
|
sl@0
|
122 |
/** @} */
|
|
sl@0
|
123 |
|
|
sl@0
|
124 |
#ifdef __cplusplus
|
|
sl@0
|
125 |
#if 0
|
|
sl@0
|
126 |
{ /* avoids confusing emacs indentation */
|
|
sl@0
|
127 |
#endif
|
|
sl@0
|
128 |
}
|
|
sl@0
|
129 |
#endif
|
|
sl@0
|
130 |
|
|
sl@0
|
131 |
#endif /* DBUS_SHARED_H */
|