1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-protocol.h D-Bus protocol constants
4 * Copyright (C) 2002, 2003 CodeFactory AB
5 * Copyright (C) 2004, 2005 Red Hat, Inc.
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #ifndef DBUS_PROTOCOL_H
26 #define DBUS_PROTOCOL_H
28 /* Don't include anything in here from anywhere else. It's
29 * intended for use by any random library.
36 /* Message byte order */
37 #define DBUS_LITTLE_ENDIAN ('l') /* LSB first */
38 #define DBUS_BIG_ENDIAN ('B') /* MSB first */
40 /* Protocol version */
41 #define DBUS_MAJOR_PROTOCOL_VERSION 1
43 /* Never a legitimate type */
44 #define DBUS_TYPE_INVALID ((int) '\0')
45 #define DBUS_TYPE_INVALID_AS_STRING "\0"
48 #define DBUS_TYPE_BYTE ((int) 'y')
49 #define DBUS_TYPE_BYTE_AS_STRING "y"
50 #define DBUS_TYPE_BOOLEAN ((int) 'b')
51 #define DBUS_TYPE_BOOLEAN_AS_STRING "b"
52 #define DBUS_TYPE_INT16 ((int) 'n')
53 #define DBUS_TYPE_INT16_AS_STRING "n"
54 #define DBUS_TYPE_UINT16 ((int) 'q')
55 #define DBUS_TYPE_UINT16_AS_STRING "q"
56 #define DBUS_TYPE_INT32 ((int) 'i')
57 #define DBUS_TYPE_INT32_AS_STRING "i"
58 #define DBUS_TYPE_UINT32 ((int) 'u')
59 #define DBUS_TYPE_UINT32_AS_STRING "u"
60 #define DBUS_TYPE_INT64 ((int) 'x')
61 #define DBUS_TYPE_INT64_AS_STRING "x"
62 #define DBUS_TYPE_UINT64 ((int) 't')
63 #define DBUS_TYPE_UINT64_AS_STRING "t"
65 #define DBUS_TYPE_DOUBLE ((int) 'd')
66 #define DBUS_TYPE_DOUBLE_AS_STRING "d"
67 #define DBUS_TYPE_STRING ((int) 's')
68 #define DBUS_TYPE_STRING_AS_STRING "s"
69 #define DBUS_TYPE_OBJECT_PATH ((int) 'o')
70 #define DBUS_TYPE_OBJECT_PATH_AS_STRING "o"
71 #define DBUS_TYPE_SIGNATURE ((int) 'g')
72 #define DBUS_TYPE_SIGNATURE_AS_STRING "g"
75 #define DBUS_TYPE_ARRAY ((int) 'a')
76 #define DBUS_TYPE_ARRAY_AS_STRING "a"
77 #define DBUS_TYPE_VARIANT ((int) 'v')
78 #define DBUS_TYPE_VARIANT_AS_STRING "v"
80 /* STRUCT and DICT_ENTRY are sort of special since their codes can't
81 * appear in a type string, instead
82 * DBUS_STRUCT_BEGIN_CHAR/DBUS_DICT_ENTRY_BEGIN_CHAR have to appear
84 #define DBUS_TYPE_STRUCT ((int) 'r')
85 #define DBUS_TYPE_STRUCT_AS_STRING "r"
86 #define DBUS_TYPE_DICT_ENTRY ((int) 'e')
87 #define DBUS_TYPE_DICT_ENTRY_AS_STRING "e"
89 /* Does not count INVALID */
90 #define DBUS_NUMBER_OF_TYPES (16)
92 /* characters other than typecodes that appear in type signatures */
93 #define DBUS_STRUCT_BEGIN_CHAR ((int) '(')
94 #define DBUS_STRUCT_BEGIN_CHAR_AS_STRING "("
95 #define DBUS_STRUCT_END_CHAR ((int) ')')
96 #define DBUS_STRUCT_END_CHAR_AS_STRING ")"
97 #define DBUS_DICT_ENTRY_BEGIN_CHAR ((int) '{')
98 #define DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING "{"
99 #define DBUS_DICT_ENTRY_END_CHAR ((int) '}')
100 #define DBUS_DICT_ENTRY_END_CHAR_AS_STRING "}"
102 /* Max length in bytes of a bus name, interface, or member (not object
103 * path, paths are unlimited). This is limited because lots of stuff
104 * is O(n) in this number, plus it would be obnoxious to type in a
105 * paragraph-long method name so most likely something like that would
108 #define DBUS_MAXIMUM_NAME_LENGTH 255
110 /* This one is 255 so it fits in a byte */
111 #define DBUS_MAXIMUM_SIGNATURE_LENGTH 255
113 /* Max length of a match rule string; to keep people from hosing the
114 * daemon with some huge rule
116 #define DBUS_MAXIMUM_MATCH_RULE_LENGTH 1024
118 /* Max length of a marshaled array in bytes (64M, 2^26) We use signed
119 * int for lengths so must be INT_MAX or less. We need something a
120 * bit smaller than INT_MAX because the array is inside a message with
121 * header info, etc. so an INT_MAX array wouldn't allow the message
122 * overhead. The 64M number is an attempt at a larger number than
123 * we'd reasonably ever use, but small enough that your bus would chew
124 * through it fairly quickly without locking up forever. If you have
125 * data that's likely to be larger than this, you should probably be
126 * sending it in multiple incremental messages anyhow.
128 #define DBUS_MAXIMUM_ARRAY_LENGTH (67108864)
129 /* Number of bits you need in an unsigned to store the max array size */
130 #define DBUS_MAXIMUM_ARRAY_LENGTH_BITS 26
132 /* The maximum total message size including header and body; similar
133 * rationale to max array size.
135 #define DBUS_MAXIMUM_MESSAGE_LENGTH (DBUS_MAXIMUM_ARRAY_LENGTH * 2)
136 /* Number of bits you need in an unsigned to store the max message size */
137 #define DBUS_MAXIMUM_MESSAGE_LENGTH_BITS 27
139 /* Depth of recursion in the type tree. This is automatically limited
140 * to DBUS_MAXIMUM_SIGNATURE_LENGTH since you could only have an array
141 * of array of array of ... that fit in the max signature. But that's
142 * probably a bit too large.
144 #define DBUS_MAXIMUM_TYPE_RECURSION_DEPTH 32
146 /* Types of message */
147 #define DBUS_MESSAGE_TYPE_INVALID 0
148 #define DBUS_MESSAGE_TYPE_METHOD_CALL 1
149 #define DBUS_MESSAGE_TYPE_METHOD_RETURN 2
150 #define DBUS_MESSAGE_TYPE_ERROR 3
151 #define DBUS_MESSAGE_TYPE_SIGNAL 4
154 #define DBUS_HEADER_FLAG_NO_REPLY_EXPECTED 0x1
155 #define DBUS_HEADER_FLAG_NO_AUTO_START 0x2
158 #define DBUS_HEADER_FIELD_INVALID 0
159 #define DBUS_HEADER_FIELD_PATH 1
160 #define DBUS_HEADER_FIELD_INTERFACE 2
161 #define DBUS_HEADER_FIELD_MEMBER 3
162 #define DBUS_HEADER_FIELD_ERROR_NAME 4
163 #define DBUS_HEADER_FIELD_REPLY_SERIAL 5
164 #define DBUS_HEADER_FIELD_DESTINATION 6
165 #define DBUS_HEADER_FIELD_SENDER 7
166 #define DBUS_HEADER_FIELD_SIGNATURE 8
168 #define DBUS_HEADER_FIELD_LAST DBUS_HEADER_FIELD_SIGNATURE
170 /* Header format is defined as a signature:
172 * byte message type ID
174 * byte protocol version
177 * array of struct (byte,variant) (field name, value)
179 * The length of the header can be computed as the
180 * fixed size of the initial data, plus the length of
181 * the array at the end, plus padding to an 8-boundary.
183 #define DBUS_HEADER_SIGNATURE \
184 DBUS_TYPE_BYTE_AS_STRING \
185 DBUS_TYPE_BYTE_AS_STRING \
186 DBUS_TYPE_BYTE_AS_STRING \
187 DBUS_TYPE_BYTE_AS_STRING \
188 DBUS_TYPE_UINT32_AS_STRING \
189 DBUS_TYPE_UINT32_AS_STRING \
190 DBUS_TYPE_ARRAY_AS_STRING \
191 DBUS_STRUCT_BEGIN_CHAR_AS_STRING \
192 DBUS_TYPE_BYTE_AS_STRING \
193 DBUS_TYPE_VARIANT_AS_STRING \
194 DBUS_STRUCT_END_CHAR_AS_STRING
198 * The smallest header size that can occur. (It won't be valid due to
199 * missing required header fields.) This is 4 bytes, two uint32, an
200 * array length. This isn't any kind of resource limit, just the
201 * necessary/logical outcome of the header signature.
203 #define DBUS_MINIMUM_HEADER_SIZE 16
206 #define DBUS_SERVICE_DBUS "org.freedesktop.DBus"
209 #define DBUS_PATH_DBUS "/org/freedesktop/DBus"
210 #define DBUS_PATH_LOCAL "/org/freedesktop/DBus/Local"
212 /* Interfaces, these #define don't do much other than
213 * catch typos at compile time
215 #define DBUS_INTERFACE_DBUS "org.freedesktop.DBus"
216 #define DBUS_INTERFACE_INTROSPECTABLE "org.freedesktop.DBus.Introspectable"
217 #define DBUS_INTERFACE_PROPERTIES "org.freedesktop.DBus.Properties"
218 #define DBUS_INTERFACE_PEER "org.freedesktop.DBus.Peer"
220 /* This is a special interface whose methods can only be invoked
221 * by the local implementation (messages from remote apps aren't
222 * allowed to specify this interface).
224 #define DBUS_INTERFACE_LOCAL "org.freedesktop.DBus.Local"
227 #define DBUS_NAME_FLAG_PROHIBIT_REPLACEMENT 0x1
228 #define DBUS_NAME_FLAG_REPLACE_EXISTING 0x2
230 /* Replies to request for a name */
231 #define DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER 1
232 #define DBUS_REQUEST_NAME_REPLY_IN_QUEUE 2
233 #define DBUS_REQUEST_NAME_REPLY_EXISTS 3
234 #define DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER 4
236 /* Replies to service starts */
237 #define DBUS_START_REPLY_SUCCESS 1
238 #define DBUS_START_REPLY_ALREADY_RUNNING 2
241 /* WARNING these get autoconverted to an enum in dbus-glib.h. Thus,
242 * if you change the order it breaks the ABI. Keep them in order.
243 * Also, don't change the formatting since that will break the sed
246 #define DBUS_ERROR_FAILED "org.freedesktop.DBus.Error.Failed"
247 #define DBUS_ERROR_NO_MEMORY "org.freedesktop.DBus.Error.NoMemory"
248 #define DBUS_ERROR_SERVICE_UNKNOWN "org.freedesktop.DBus.Error.ServiceUnknown"
249 #define DBUS_ERROR_NAME_HAS_NO_OWNER "org.freedesktop.DBus.Error.NameHasNoOwner"
250 #define DBUS_ERROR_NO_REPLY "org.freedesktop.DBus.Error.NoReply"
251 #define DBUS_ERROR_IO_ERROR "org.freedesktop.DBus.Error.IOError"
252 #define DBUS_ERROR_BAD_ADDRESS "org.freedesktop.DBus.Error.BadAddress"
253 #define DBUS_ERROR_NOT_SUPPORTED "org.freedesktop.DBus.Error.NotSupported"
254 #define DBUS_ERROR_LIMITS_EXCEEDED "org.freedesktop.DBus.Error.LimitsExceeded"
255 #define DBUS_ERROR_ACCESS_DENIED "org.freedesktop.DBus.Error.AccessDenied"
256 #define DBUS_ERROR_AUTH_FAILED "org.freedesktop.DBus.Error.AuthFailed"
257 #define DBUS_ERROR_NO_SERVER "org.freedesktop.DBus.Error.NoServer"
258 #define DBUS_ERROR_TIMEOUT "org.freedesktop.DBus.Error.Timeout"
259 #define DBUS_ERROR_NO_NETWORK "org.freedesktop.DBus.Error.NoNetwork"
260 #define DBUS_ERROR_ADDRESS_IN_USE "org.freedesktop.DBus.Error.AddressInUse"
261 #define DBUS_ERROR_DISCONNECTED "org.freedesktop.DBus.Error.Disconnected"
262 #define DBUS_ERROR_INVALID_ARGS "org.freedesktop.DBus.Error.InvalidArgs"
263 #define DBUS_ERROR_FILE_NOT_FOUND "org.freedesktop.DBus.Error.FileNotFound"
264 #define DBUS_ERROR_UNKNOWN_METHOD "org.freedesktop.DBus.Error.UnknownMethod"
265 #define DBUS_ERROR_TIMED_OUT "org.freedesktop.DBus.Error.TimedOut"
266 #define DBUS_ERROR_MATCH_RULE_NOT_FOUND "org.freedesktop.DBus.Error.MatchRuleNotFound"
267 #define DBUS_ERROR_MATCH_RULE_INVALID "org.freedesktop.DBus.Error.MatchRuleInvalid"
268 #define DBUS_ERROR_SPAWN_EXEC_FAILED "org.freedesktop.DBus.Error.Spawn.ExecFailed"
269 #define DBUS_ERROR_SPAWN_FORK_FAILED "org.freedesktop.DBus.Error.Spawn.ForkFailed"
270 #define DBUS_ERROR_SPAWN_CHILD_EXITED "org.freedesktop.DBus.Error.Spawn.ChildExited"
271 #define DBUS_ERROR_SPAWN_CHILD_SIGNALED "org.freedesktop.DBus.Error.Spawn.ChildSignaled"
272 #define DBUS_ERROR_SPAWN_FAILED "org.freedesktop.DBus.Error.Spawn.Failed"
273 #define DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN "org.freedesktop.DBus.Error.UnixProcessIdUnknown"
274 #define DBUS_ERROR_INVALID_SIGNATURE "org.freedesktop.DBus.Error.InvalidSignature"
276 #define DBUS_INTROSPECT_1_0_XML_NAMESPACE "http://www.freedesktop.org/standards/dbus"
277 #define DBUS_INTROSPECT_1_0_XML_PUBLIC_IDENTIFIER "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
278 #define DBUS_INTROSPECT_1_0_XML_SYSTEM_IDENTIFIER "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"
279 #define DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<!DOCTYPE node PUBLIC \""DBUS_INTROSPECT_1_0_XML_PUBLIC_IDENTIFIER"\"\n\""DBUS_INTROSPECT_1_0_XML_SYSTEM_IDENTIFIER"\">\n"
286 #endif /* DBUS_PROTOCOL_H */