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.
35 } /* avoids confusing emacs indentation */
39 /* Normally docs are in .c files, but there isn't a .c file for this. */
41 * @defgroup DBusProtocol Protocol constants
44 * D-Bus protocol constants
46 * @brief Defines constants which are part of the D-Bus protocol
51 /* Message byte order */
52 #define DBUS_LITTLE_ENDIAN ('l') /**< LSB first */
53 #define DBUS_BIG_ENDIAN ('B') /**< MSB first */
55 /** Protocol version */
56 #define DBUS_MAJOR_PROTOCOL_VERSION 1
58 /** Type code that is never equal to a legitimate type code */
59 #define DBUS_TYPE_INVALID ((int) '\0')
60 /** #DBUS_TYPE_INVALID as a string literal instead of a int literal */
61 #define DBUS_TYPE_INVALID_AS_STRING "\0"
64 /** Type code marking an 8-bit unsigned integer */
65 #define DBUS_TYPE_BYTE ((int) 'y')
66 /** #DBUS_TYPE_BYTE as a string literal instead of a int literal */
67 #define DBUS_TYPE_BYTE_AS_STRING "y"
68 /** Type code marking a boolean */
69 #define DBUS_TYPE_BOOLEAN ((int) 'b')
70 /** #DBUS_TYPE_BOOLEAN as a string literal instead of a int literal */
71 #define DBUS_TYPE_BOOLEAN_AS_STRING "b"
72 /** Type code marking a 16-bit signed integer */
73 #define DBUS_TYPE_INT16 ((int) 'n')
74 /** #DBUS_TYPE_INT16 as a string literal instead of a int literal */
75 #define DBUS_TYPE_INT16_AS_STRING "n"
76 /** Type code marking a 16-bit unsigned integer */
77 #define DBUS_TYPE_UINT16 ((int) 'q')
78 /** #DBUS_TYPE_UINT16 as a string literal instead of a int literal */
79 #define DBUS_TYPE_UINT16_AS_STRING "q"
80 /** Type code marking a 32-bit signed integer */
81 #define DBUS_TYPE_INT32 ((int) 'i')
82 /** #DBUS_TYPE_INT32 as a string literal instead of a int literal */
83 #define DBUS_TYPE_INT32_AS_STRING "i"
84 /** Type code marking a 32-bit unsigned integer */
85 #define DBUS_TYPE_UINT32 ((int) 'u')
86 /** #DBUS_TYPE_UINT32 as a string literal instead of a int literal */
87 #define DBUS_TYPE_UINT32_AS_STRING "u"
88 /** Type code marking a 64-bit signed integer */
89 #define DBUS_TYPE_INT64 ((int) 'x')
90 /** #DBUS_TYPE_INT64 as a string literal instead of a int literal */
91 #define DBUS_TYPE_INT64_AS_STRING "x"
92 /** Type code marking a 64-bit unsigned integer */
93 #define DBUS_TYPE_UINT64 ((int) 't')
94 /** #DBUS_TYPE_UINT64 as a string literal instead of a int literal */
95 #define DBUS_TYPE_UINT64_AS_STRING "t"
96 /** Type code marking an 8-byte double in IEEE 754 format */
97 #define DBUS_TYPE_DOUBLE ((int) 'd')
98 /** #DBUS_TYPE_DOUBLE as a string literal instead of a int literal */
99 #define DBUS_TYPE_DOUBLE_AS_STRING "d"
100 /** Type code marking a UTF-8 encoded, nul-terminated Unicode string */
101 #define DBUS_TYPE_STRING ((int) 's')
102 /** #DBUS_TYPE_STRING as a string literal instead of a int literal */
103 #define DBUS_TYPE_STRING_AS_STRING "s"
104 /** Type code marking a D-Bus object path */
105 #define DBUS_TYPE_OBJECT_PATH ((int) 'o')
106 /** #DBUS_TYPE_OBJECT_PATH as a string literal instead of a int literal */
107 #define DBUS_TYPE_OBJECT_PATH_AS_STRING "o"
108 /** Type code marking a D-Bus type signature */
109 #define DBUS_TYPE_SIGNATURE ((int) 'g')
110 /** #DBUS_TYPE_SIGNATURE as a string literal instead of a int literal */
111 #define DBUS_TYPE_SIGNATURE_AS_STRING "g"
114 /** Type code marking a D-Bus array type */
115 #define DBUS_TYPE_ARRAY ((int) 'a')
116 /** #DBUS_TYPE_ARRAY as a string literal instead of a int literal */
117 #define DBUS_TYPE_ARRAY_AS_STRING "a"
118 /** Type code marking a D-Bus variant type */
119 #define DBUS_TYPE_VARIANT ((int) 'v')
120 /** #DBUS_TYPE_VARIANT as a string literal instead of a int literal */
121 #define DBUS_TYPE_VARIANT_AS_STRING "v"
123 /** STRUCT and DICT_ENTRY are sort of special since their codes can't
124 * appear in a type string, instead
125 * DBUS_STRUCT_BEGIN_CHAR/DBUS_DICT_ENTRY_BEGIN_CHAR have to appear
127 /** Type code used to represent a struct; however, this type code does not appear
128 * in type signatures, instead #DBUS_STRUCT_BEGIN_CHAR and #DBUS_STRUCT_END_CHAR will
129 * appear in a signature.
131 #define DBUS_TYPE_STRUCT ((int) 'r')
132 /** #DBUS_TYPE_STRUCT as a string literal instead of a int literal */
133 #define DBUS_TYPE_STRUCT_AS_STRING "r"
134 /** Type code used to represent a dict entry; however, this type code does not appear
135 * in type signatures, instead #DBUS_DICT_ENTRY_BEGIN_CHAR and #DBUS_DICT_ENTRY_END_CHAR will
136 * appear in a signature.
138 #define DBUS_TYPE_DICT_ENTRY ((int) 'e')
139 /** #DBUS_TYPE_DICT_ENTRY as a string literal instead of a int literal */
140 #define DBUS_TYPE_DICT_ENTRY_AS_STRING "e"
142 /** Does not include #DBUS_TYPE_INVALID, #DBUS_STRUCT_BEGIN_CHAR, #DBUS_STRUCT_END_CHAR,
143 * #DBUS_DICT_ENTRY_BEGIN_CHAR, or #DBUS_DICT_ENTRY_END_CHAR - i.e. it is the number of
144 * valid types, not the number of distinct characters that may appear in a type signature.
146 #define DBUS_NUMBER_OF_TYPES (16)
148 /* characters other than typecodes that appear in type signatures */
150 /** Code marking the start of a struct type in a type signature */
151 #define DBUS_STRUCT_BEGIN_CHAR ((int) '(')
152 /** #DBUS_STRUCT_BEGIN_CHAR as a string literal instead of a int literal */
153 #define DBUS_STRUCT_BEGIN_CHAR_AS_STRING "("
154 /** Code marking the end of a struct type in a type signature */
155 #define DBUS_STRUCT_END_CHAR ((int) ')')
156 /** #DBUS_STRUCT_END_CHAR a string literal instead of a int literal */
157 #define DBUS_STRUCT_END_CHAR_AS_STRING ")"
158 /** Code marking the start of a dict entry type in a type signature */
159 #define DBUS_DICT_ENTRY_BEGIN_CHAR ((int) '{')
160 /** #DBUS_DICT_ENTRY_BEGIN_CHAR as a string literal instead of a int literal */
161 #define DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING "{"
162 /** Code marking the end of a dict entry type in a type signature */
163 #define DBUS_DICT_ENTRY_END_CHAR ((int) '}')
164 /** #DBUS_DICT_ENTRY_END_CHAR as a string literal instead of a int literal */
165 #define DBUS_DICT_ENTRY_END_CHAR_AS_STRING "}"
167 /** Max length in bytes of a bus name, interface, or member (not object
168 * path, paths are unlimited). This is limited because lots of stuff
169 * is O(n) in this number, plus it would be obnoxious to type in a
170 * paragraph-long method name so most likely something like that would
173 #define DBUS_MAXIMUM_NAME_LENGTH 255
175 /** This one is 255 so it fits in a byte */
176 #define DBUS_MAXIMUM_SIGNATURE_LENGTH 255
178 /** Max length of a match rule string; to keep people from hosing the
179 * daemon with some huge rule
181 #define DBUS_MAXIMUM_MATCH_RULE_LENGTH 1024
183 /** Max arg number you can match on in a match rule, e.g.
184 * arg0='hello' is OK, arg3489720987='hello' is not
186 #define DBUS_MAXIMUM_MATCH_RULE_ARG_NUMBER 63
188 /** Max length of a marshaled array in bytes (64M, 2^26) We use signed
189 * int for lengths so must be INT_MAX or less. We need something a
190 * bit smaller than INT_MAX because the array is inside a message with
191 * header info, etc. so an INT_MAX array wouldn't allow the message
192 * overhead. The 64M number is an attempt at a larger number than
193 * we'd reasonably ever use, but small enough that your bus would chew
194 * through it fairly quickly without locking up forever. If you have
195 * data that's likely to be larger than this, you should probably be
196 * sending it in multiple incremental messages anyhow.
198 #define DBUS_MAXIMUM_ARRAY_LENGTH (67108864)
199 /** Number of bits you need in an unsigned to store the max array size */
200 #define DBUS_MAXIMUM_ARRAY_LENGTH_BITS 26
202 /** The maximum total message size including header and body; similar
203 * rationale to max array size.
205 #define DBUS_MAXIMUM_MESSAGE_LENGTH (DBUS_MAXIMUM_ARRAY_LENGTH * 2)
206 /** Number of bits you need in an unsigned to store the max message size */
207 #define DBUS_MAXIMUM_MESSAGE_LENGTH_BITS 27
209 /** Depth of recursion in the type tree. This is automatically limited
210 * to DBUS_MAXIMUM_SIGNATURE_LENGTH since you could only have an array
211 * of array of array of ... that fit in the max signature. But that's
212 * probably a bit too large.
214 #define DBUS_MAXIMUM_TYPE_RECURSION_DEPTH 32
216 /* Types of message */
218 /** This value is never a valid message type, see dbus_message_get_type() */
219 #define DBUS_MESSAGE_TYPE_INVALID 0
220 /** Message type of a method call message, see dbus_message_get_type() */
221 #define DBUS_MESSAGE_TYPE_METHOD_CALL 1
222 /** Message type of a method return message, see dbus_message_get_type() */
223 #define DBUS_MESSAGE_TYPE_METHOD_RETURN 2
224 /** Message type of an error reply message, see dbus_message_get_type() */
225 #define DBUS_MESSAGE_TYPE_ERROR 3
226 /** Message type of a signal message, see dbus_message_get_type() */
227 #define DBUS_MESSAGE_TYPE_SIGNAL 4
231 /** If set, this flag means that the sender of a message does not care about getting
232 * a reply, so the recipient need not send one. See dbus_message_set_no_reply().
234 #define DBUS_HEADER_FLAG_NO_REPLY_EXPECTED 0x1
236 * If set, this flag means that even if the message bus knows how to start an owner for
237 * the destination bus name (see dbus_message_set_destination()), it should not
238 * do so. If this flag is not set, the bus may launch a program to process the
241 #define DBUS_HEADER_FLAG_NO_AUTO_START 0x2
245 /** Not equal to any valid header field code */
246 #define DBUS_HEADER_FIELD_INVALID 0
247 /** Header field code for the path - the path is the object emitting a signal or the object receiving a method call.
248 * See dbus_message_set_path().
250 #define DBUS_HEADER_FIELD_PATH 1
251 /** Header field code for the interface containing a member (method or signal).
252 * See dbus_message_set_interface().
254 #define DBUS_HEADER_FIELD_INTERFACE 2
255 /** Header field code for a member (method or signal). See dbus_message_set_member(). */
256 #define DBUS_HEADER_FIELD_MEMBER 3
257 /** Header field code for an error name (found in #DBUS_MESSAGE_TYPE_ERROR messages).
258 * See dbus_message_set_error_name().
260 #define DBUS_HEADER_FIELD_ERROR_NAME 4
261 /** Header field code for a reply serial, used to match a #DBUS_MESSAGE_TYPE_METHOD_RETURN message with the
262 * message that it's a reply to. See dbus_message_set_reply_serial().
264 #define DBUS_HEADER_FIELD_REPLY_SERIAL 5
266 * Header field code for the destination bus name of a message. See dbus_message_set_destination().
268 #define DBUS_HEADER_FIELD_DESTINATION 6
270 * Header field code for the sender of a message; usually initialized by the message bus.
271 * See dbus_message_set_sender().
273 #define DBUS_HEADER_FIELD_SENDER 7
275 * Header field code for the type signature of a message.
277 #define DBUS_HEADER_FIELD_SIGNATURE 8
280 * Value of the highest-numbered header field code, can be used to determine
281 * the size of an array indexed by header field code. Remember though
282 * that unknown codes must be ignored, so check for that before
283 * indexing the array.
285 #define DBUS_HEADER_FIELD_LAST DBUS_HEADER_FIELD_SIGNATURE
287 /** Header format is defined as a signature:
289 * byte message type ID
291 * byte protocol version
294 * array of struct (byte,variant) (field name, value)
296 * The length of the header can be computed as the
297 * fixed size of the initial data, plus the length of
298 * the array at the end, plus padding to an 8-boundary.
300 #define DBUS_HEADER_SIGNATURE \
301 DBUS_TYPE_BYTE_AS_STRING \
302 DBUS_TYPE_BYTE_AS_STRING \
303 DBUS_TYPE_BYTE_AS_STRING \
304 DBUS_TYPE_BYTE_AS_STRING \
305 DBUS_TYPE_UINT32_AS_STRING \
306 DBUS_TYPE_UINT32_AS_STRING \
307 DBUS_TYPE_ARRAY_AS_STRING \
308 DBUS_STRUCT_BEGIN_CHAR_AS_STRING \
309 DBUS_TYPE_BYTE_AS_STRING \
310 DBUS_TYPE_VARIANT_AS_STRING \
311 DBUS_STRUCT_END_CHAR_AS_STRING
315 * The smallest header size that can occur. (It won't be valid due to
316 * missing required header fields.) This is 4 bytes, two uint32, an
317 * array length. This isn't any kind of resource limit, just the
318 * necessary/logical outcome of the header signature.
320 #define DBUS_MINIMUM_HEADER_SIZE 16
323 /* WARNING these get autoconverted to an enum in dbus-glib.h. Thus,
324 * if you change the order it breaks the ABI. Keep them in order.
325 * Also, don't change the formatting since that will break the sed
328 /** A generic error; "something went wrong" - see the error message for more. */
329 #define DBUS_ERROR_FAILED "org.freedesktop.DBus.Error.Failed"
330 /** There was not enough memory to complete an operation. */
331 #define DBUS_ERROR_NO_MEMORY "org.freedesktop.DBus.Error.NoMemory"
332 /** The bus doesn't know how to launch a service to supply the bus name you wanted. */
333 #define DBUS_ERROR_SERVICE_UNKNOWN "org.freedesktop.DBus.Error.ServiceUnknown"
334 /** The bus name you referenced doesn't exist (i.e. no application owns it). */
335 #define DBUS_ERROR_NAME_HAS_NO_OWNER "org.freedesktop.DBus.Error.NameHasNoOwner"
336 /** No reply to a message expecting one, usually means a timeout occurred. */
337 #define DBUS_ERROR_NO_REPLY "org.freedesktop.DBus.Error.NoReply"
338 /** Something went wrong reading or writing to a socket, for example. */
339 #define DBUS_ERROR_IO_ERROR "org.freedesktop.DBus.Error.IOError"
340 /** A D-Bus bus address was malformed. */
341 #define DBUS_ERROR_BAD_ADDRESS "org.freedesktop.DBus.Error.BadAddress"
342 /** Requested operation isn't supported (like ENOSYS on UNIX). */
343 #define DBUS_ERROR_NOT_SUPPORTED "org.freedesktop.DBus.Error.NotSupported"
344 /** Some limited resource is exhausted. */
345 #define DBUS_ERROR_LIMITS_EXCEEDED "org.freedesktop.DBus.Error.LimitsExceeded"
346 /** Security restrictions don't allow doing what you're trying to do. */
347 #define DBUS_ERROR_ACCESS_DENIED "org.freedesktop.DBus.Error.AccessDenied"
348 /** Authentication didn't work. */
349 #define DBUS_ERROR_AUTH_FAILED "org.freedesktop.DBus.Error.AuthFailed"
350 /** Unable to connect to server (probably caused by ECONNREFUSED on a socket). */
351 #define DBUS_ERROR_NO_SERVER "org.freedesktop.DBus.Error.NoServer"
352 /** Certain timeout errors, possibly ETIMEDOUT on a socket. Note that #DBUS_ERROR_NO_REPLY is used for message reply timeouts. */
353 #define DBUS_ERROR_TIMEOUT "org.freedesktop.DBus.Error.Timeout"
354 /** No network access (probably ENETUNREACH on a socket). */
355 #define DBUS_ERROR_NO_NETWORK "org.freedesktop.DBus.Error.NoNetwork"
356 /** Can't bind a socket since its address is in use (i.e. EADDRINUSE). */
357 #define DBUS_ERROR_ADDRESS_IN_USE "org.freedesktop.DBus.Error.AddressInUse"
358 /** The connection is disconnected and you're trying to use it. */
359 #define DBUS_ERROR_DISCONNECTED "org.freedesktop.DBus.Error.Disconnected"
360 /** Invalid arguments passed to a method call. */
361 #define DBUS_ERROR_INVALID_ARGS "org.freedesktop.DBus.Error.InvalidArgs"
363 #define DBUS_ERROR_FILE_NOT_FOUND "org.freedesktop.DBus.Error.FileNotFound"
364 /** Existing file and the operation you're using does not silently overwrite. */
365 #define DBUS_ERROR_FILE_EXISTS "org.freedesktop.DBus.Error.FileExists"
366 /** Method name you invoked isn't known by the object you invoked it on. */
367 #define DBUS_ERROR_UNKNOWN_METHOD "org.freedesktop.DBus.Error.UnknownMethod"
368 /** Certain other timeout errors, e.g. while starting a service. @todo redundant with #DBUS_ERROR_TIMEOUT */
369 #define DBUS_ERROR_TIMED_OUT "org.freedesktop.DBus.Error.TimedOut"
370 /** Tried to remove or modify a match rule that didn't exist. */
371 #define DBUS_ERROR_MATCH_RULE_NOT_FOUND "org.freedesktop.DBus.Error.MatchRuleNotFound"
372 /** The match rule isn't syntactically valid. */
373 #define DBUS_ERROR_MATCH_RULE_INVALID "org.freedesktop.DBus.Error.MatchRuleInvalid"
374 /** While starting a new process, the exec() call failed. */
375 #define DBUS_ERROR_SPAWN_EXEC_FAILED "org.freedesktop.DBus.Error.Spawn.ExecFailed"
376 /** While starting a new process, the fork() call failed. */
377 #define DBUS_ERROR_SPAWN_FORK_FAILED "org.freedesktop.DBus.Error.Spawn.ForkFailed"
378 /** While starting a new process, the child exited with a status code. */
379 #define DBUS_ERROR_SPAWN_CHILD_EXITED "org.freedesktop.DBus.Error.Spawn.ChildExited"
380 /** While starting a new process, the child exited on a signal. */
381 #define DBUS_ERROR_SPAWN_CHILD_SIGNALED "org.freedesktop.DBus.Error.Spawn.ChildSignaled"
382 /** While starting a new process, something went wrong. */
383 #define DBUS_ERROR_SPAWN_FAILED "org.freedesktop.DBus.Error.Spawn.Failed"
384 /** Tried to get a UNIX process ID and it wasn't available. */
385 #define DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN "org.freedesktop.DBus.Error.UnixProcessIdUnknown"
386 /** A type signature is not valid. */
387 #define DBUS_ERROR_INVALID_SIGNATURE "org.freedesktop.DBus.Error.InvalidSignature"
388 /** A file contains invalid syntax or is otherwise broken. */
389 #define DBUS_ERROR_INVALID_FILE_CONTENT "org.freedesktop.DBus.Error.InvalidFileContent"
390 /** Asked for SELinux security context and it wasn't available. */
391 #define DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown"
393 /* XML introspection format */
395 /** XML namespace of the introspection format version 1.0 */
396 #define DBUS_INTROSPECT_1_0_XML_NAMESPACE "http://www.freedesktop.org/standards/dbus"
397 /** XML public identifier of the introspection format version 1.0 */
398 #define DBUS_INTROSPECT_1_0_XML_PUBLIC_IDENTIFIER "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
399 /** XML system identifier of the introspection format version 1.0 */
400 #define DBUS_INTROSPECT_1_0_XML_SYSTEM_IDENTIFIER "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"
401 /** XML document type declaration of the introspection format version 1.0 */
402 #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"
408 { /* avoids confusing emacs indentation */
413 #endif /* DBUS_PROTOCOL_H */