dbus-protocol.h

00001 /* -*- mode: C; c-file-style: "gnu" -*- */
00002 /* dbus-protocol.h  D-Bus protocol constants
00003  *
00004  * Copyright (C) 2002, 2003  CodeFactory AB
00005  * Copyright (C) 2004, 2005 Red Hat, Inc.
00006  *
00007  * Licensed under the Academic Free License version 2.1
00008  *
00009  * This program is free software; you can redistribute it and/or modify
00010  * it under the terms of the GNU General Public License as published by
00011  * the Free Software Foundation; either version 2 of the License, or
00012  * (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  *
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022  *
00023  */
00024 
00025 #ifndef DBUS_PROTOCOL_H
00026 #define DBUS_PROTOCOL_H
00027 
00028 /* Don't include anything in here from anywhere else. It's
00029  * intended for use by any random library.
00030  */
00031 
00032 #ifdef  __cplusplus
00033 extern "C" {
00034 #endif
00035 
00036 /* Normally docs are in .c files, but there isn't a .c file for this. */
00048 /* Message byte order */
00049 #define DBUS_LITTLE_ENDIAN ('l')  
00050 #define DBUS_BIG_ENDIAN    ('B')  
00053 #define DBUS_MAJOR_PROTOCOL_VERSION 1
00054 
00056 #define DBUS_TYPE_INVALID       ((int) '\0')
00057 #define DBUS_TYPE_INVALID_AS_STRING        "\0"
00058 
00059 /* Primitive types */
00060 #define DBUS_TYPE_BYTE          ((int) 'y')
00061 #define DBUS_TYPE_BYTE_AS_STRING           "y"
00062 #define DBUS_TYPE_BOOLEAN       ((int) 'b')
00063 #define DBUS_TYPE_BOOLEAN_AS_STRING        "b"
00064 #define DBUS_TYPE_INT16         ((int) 'n')
00065 #define DBUS_TYPE_INT16_AS_STRING          "n"
00066 #define DBUS_TYPE_UINT16        ((int) 'q')
00067 #define DBUS_TYPE_UINT16_AS_STRING         "q"
00068 #define DBUS_TYPE_INT32         ((int) 'i')
00069 #define DBUS_TYPE_INT32_AS_STRING          "i"
00070 #define DBUS_TYPE_UINT32        ((int) 'u')
00071 #define DBUS_TYPE_UINT32_AS_STRING         "u"
00072 #define DBUS_TYPE_INT64         ((int) 'x')
00073 #define DBUS_TYPE_INT64_AS_STRING          "x"
00074 #define DBUS_TYPE_UINT64        ((int) 't')
00075 #define DBUS_TYPE_UINT64_AS_STRING         "t"
00076 #define DBUS_TYPE_DOUBLE        ((int) 'd')
00077 #define DBUS_TYPE_DOUBLE_AS_STRING         "d"
00078 #define DBUS_TYPE_STRING        ((int) 's')
00079 #define DBUS_TYPE_STRING_AS_STRING         "s"
00080 #define DBUS_TYPE_OBJECT_PATH   ((int) 'o')
00081 #define DBUS_TYPE_OBJECT_PATH_AS_STRING    "o"
00082 #define DBUS_TYPE_SIGNATURE     ((int) 'g')
00083 #define DBUS_TYPE_SIGNATURE_AS_STRING      "g"
00084 
00085 /* Compound types */
00086 #define DBUS_TYPE_ARRAY         ((int) 'a')
00087 #define DBUS_TYPE_ARRAY_AS_STRING          "a"
00088 #define DBUS_TYPE_VARIANT       ((int) 'v')
00089 #define DBUS_TYPE_VARIANT_AS_STRING        "v"
00090 
00095 #define DBUS_TYPE_STRUCT        ((int) 'r')
00096 #define DBUS_TYPE_STRUCT_AS_STRING         "r"
00097 #define DBUS_TYPE_DICT_ENTRY    ((int) 'e')
00098 #define DBUS_TYPE_DICT_ENTRY_AS_STRING     "e"
00099 
00101 #define DBUS_NUMBER_OF_TYPES    (16)
00102 
00103 /* characters other than typecodes that appear in type signatures */
00104 #define DBUS_STRUCT_BEGIN_CHAR   ((int) '(')
00105 #define DBUS_STRUCT_BEGIN_CHAR_AS_STRING   "("
00106 #define DBUS_STRUCT_END_CHAR     ((int) ')')
00107 #define DBUS_STRUCT_END_CHAR_AS_STRING     ")"
00108 #define DBUS_DICT_ENTRY_BEGIN_CHAR   ((int) '{')
00109 #define DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING   "{"
00110 #define DBUS_DICT_ENTRY_END_CHAR     ((int) '}')
00111 #define DBUS_DICT_ENTRY_END_CHAR_AS_STRING     "}"
00112 
00119 #define DBUS_MAXIMUM_NAME_LENGTH 255
00120 
00122 #define DBUS_MAXIMUM_SIGNATURE_LENGTH 255
00123 
00127 #define DBUS_MAXIMUM_MATCH_RULE_LENGTH 1024
00128 
00132 #define DBUS_MAXIMUM_MATCH_RULE_ARG_NUMBER 63
00133   
00144 #define DBUS_MAXIMUM_ARRAY_LENGTH (67108864)
00145 
00146 #define DBUS_MAXIMUM_ARRAY_LENGTH_BITS 26
00147 
00151 #define DBUS_MAXIMUM_MESSAGE_LENGTH (DBUS_MAXIMUM_ARRAY_LENGTH * 2)
00152 
00153 #define DBUS_MAXIMUM_MESSAGE_LENGTH_BITS 27
00154 
00160 #define DBUS_MAXIMUM_TYPE_RECURSION_DEPTH 32
00161 
00162 /* Types of message */
00163 #define DBUS_MESSAGE_TYPE_INVALID       0
00164 #define DBUS_MESSAGE_TYPE_METHOD_CALL   1
00165 #define DBUS_MESSAGE_TYPE_METHOD_RETURN 2
00166 #define DBUS_MESSAGE_TYPE_ERROR         3
00167 #define DBUS_MESSAGE_TYPE_SIGNAL        4
00168 
00169 /* Header flags */
00170 #define DBUS_HEADER_FLAG_NO_REPLY_EXPECTED 0x1
00171 #define DBUS_HEADER_FLAG_NO_AUTO_START     0x2
00172 
00173 /* Header fields */
00174 #define DBUS_HEADER_FIELD_INVALID        0
00175 #define DBUS_HEADER_FIELD_PATH           1
00176 #define DBUS_HEADER_FIELD_INTERFACE      2
00177 #define DBUS_HEADER_FIELD_MEMBER         3
00178 #define DBUS_HEADER_FIELD_ERROR_NAME     4
00179 #define DBUS_HEADER_FIELD_REPLY_SERIAL   5
00180 #define DBUS_HEADER_FIELD_DESTINATION    6
00181 #define DBUS_HEADER_FIELD_SENDER         7
00182 #define DBUS_HEADER_FIELD_SIGNATURE      8
00183 
00184 #define DBUS_HEADER_FIELD_LAST DBUS_HEADER_FIELD_SIGNATURE
00185 
00199 #define DBUS_HEADER_SIGNATURE                   \
00200      DBUS_TYPE_BYTE_AS_STRING                   \
00201      DBUS_TYPE_BYTE_AS_STRING                   \
00202      DBUS_TYPE_BYTE_AS_STRING                   \
00203      DBUS_TYPE_BYTE_AS_STRING                   \
00204      DBUS_TYPE_UINT32_AS_STRING                 \
00205      DBUS_TYPE_UINT32_AS_STRING                 \
00206      DBUS_TYPE_ARRAY_AS_STRING                  \
00207      DBUS_STRUCT_BEGIN_CHAR_AS_STRING           \
00208      DBUS_TYPE_BYTE_AS_STRING                   \
00209      DBUS_TYPE_VARIANT_AS_STRING                \
00210      DBUS_STRUCT_END_CHAR_AS_STRING
00211 
00212 
00219 #define DBUS_MINIMUM_HEADER_SIZE 16
00220 
00221 /* Errors */
00222 /* WARNING these get autoconverted to an enum in dbus-glib.h. Thus,
00223  * if you change the order it breaks the ABI. Keep them in order.
00224  * Also, don't change the formatting since that will break the sed
00225  * script.
00226  */
00227 #define DBUS_ERROR_FAILED                     "org.freedesktop.DBus.Error.Failed"
00228 #define DBUS_ERROR_NO_MEMORY                  "org.freedesktop.DBus.Error.NoMemory"
00229 #define DBUS_ERROR_SERVICE_UNKNOWN            "org.freedesktop.DBus.Error.ServiceUnknown"
00230 #define DBUS_ERROR_NAME_HAS_NO_OWNER          "org.freedesktop.DBus.Error.NameHasNoOwner"
00231 #define DBUS_ERROR_NO_REPLY                   "org.freedesktop.DBus.Error.NoReply"
00232 #define DBUS_ERROR_IO_ERROR                   "org.freedesktop.DBus.Error.IOError"
00233 #define DBUS_ERROR_BAD_ADDRESS                "org.freedesktop.DBus.Error.BadAddress"
00234 #define DBUS_ERROR_NOT_SUPPORTED              "org.freedesktop.DBus.Error.NotSupported"
00235 #define DBUS_ERROR_LIMITS_EXCEEDED            "org.freedesktop.DBus.Error.LimitsExceeded"
00236 #define DBUS_ERROR_ACCESS_DENIED              "org.freedesktop.DBus.Error.AccessDenied"
00237 #define DBUS_ERROR_AUTH_FAILED                "org.freedesktop.DBus.Error.AuthFailed"
00238 #define DBUS_ERROR_NO_SERVER                  "org.freedesktop.DBus.Error.NoServer"
00239 #define DBUS_ERROR_TIMEOUT                    "org.freedesktop.DBus.Error.Timeout"
00240 #define DBUS_ERROR_NO_NETWORK                 "org.freedesktop.DBus.Error.NoNetwork"
00241 #define DBUS_ERROR_ADDRESS_IN_USE             "org.freedesktop.DBus.Error.AddressInUse"
00242 #define DBUS_ERROR_DISCONNECTED               "org.freedesktop.DBus.Error.Disconnected"
00243 #define DBUS_ERROR_INVALID_ARGS               "org.freedesktop.DBus.Error.InvalidArgs"
00244 #define DBUS_ERROR_FILE_NOT_FOUND             "org.freedesktop.DBus.Error.FileNotFound"
00245 #define DBUS_ERROR_UNKNOWN_METHOD             "org.freedesktop.DBus.Error.UnknownMethod"
00246 #define DBUS_ERROR_TIMED_OUT                  "org.freedesktop.DBus.Error.TimedOut"
00247 #define DBUS_ERROR_MATCH_RULE_NOT_FOUND       "org.freedesktop.DBus.Error.MatchRuleNotFound"
00248 #define DBUS_ERROR_MATCH_RULE_INVALID         "org.freedesktop.DBus.Error.MatchRuleInvalid"
00249 #define DBUS_ERROR_SPAWN_EXEC_FAILED          "org.freedesktop.DBus.Error.Spawn.ExecFailed"
00250 #define DBUS_ERROR_SPAWN_FORK_FAILED          "org.freedesktop.DBus.Error.Spawn.ForkFailed"
00251 #define DBUS_ERROR_SPAWN_CHILD_EXITED         "org.freedesktop.DBus.Error.Spawn.ChildExited"
00252 #define DBUS_ERROR_SPAWN_CHILD_SIGNALED       "org.freedesktop.DBus.Error.Spawn.ChildSignaled"
00253 #define DBUS_ERROR_SPAWN_FAILED               "org.freedesktop.DBus.Error.Spawn.Failed"
00254 #define DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN    "org.freedesktop.DBus.Error.UnixProcessIdUnknown"
00255 #define DBUS_ERROR_INVALID_SIGNATURE          "org.freedesktop.DBus.Error.InvalidSignature"
00256 #define DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN    "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown"
00257 
00258 #define DBUS_INTROSPECT_1_0_XML_NAMESPACE         "http://www.freedesktop.org/standards/dbus"
00259 #define DBUS_INTROSPECT_1_0_XML_PUBLIC_IDENTIFIER "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
00260 #define DBUS_INTROSPECT_1_0_XML_SYSTEM_IDENTIFIER "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"
00261 #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"
00262 
00265 #ifdef __cplusplus
00266 }
00267 #endif
00268 
00269 #endif /* DBUS_PROTOCOL_H */

Generated on Wed Jan 3 04:58:28 2007 for D-Bus by  doxygen 1.4.7