dbus/dbus-protocol.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-protocol.h  D-Bus protocol constants
   3  *
   4  * Copyright (C) 2002, 2003  CodeFactory AB
   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
  24 #ifndef DBUS_PROTOCOL_H
  25 #define DBUS_PROTOCOL_H
  26
  27 /* Don't include anything in here from anywhere else. It's
  28  * intended for use by any random library.
  29  */
  30
  31 #ifdef  __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /* Message byte order */
  36 #define DBUS_LITTLE_ENDIAN ('l')  /* LSB first */
  37 #define DBUS_BIG_ENDIAN    ('B')  /* MSB first */
  38
  39 /* Protocol version */
  40 #define DBUS_MAJOR_PROTOCOL_VERSION 0
  41
  42 /* Data types */
  43 #define DBUS_TYPE_INVALID       ((int) '\0')
  44 #define DBUS_TYPE_NIL           ((int) 'v')
  45 #define DBUS_TYPE_BYTE          ((int) 'y')
  46 #define DBUS_TYPE_BOOLEAN       ((int) 'b')
  47 #define DBUS_TYPE_INT32         ((int) 'i')
  48 #define DBUS_TYPE_UINT32        ((int) 'u')
  49 #define DBUS_TYPE_INT64         ((int) 'x')
  50 #define DBUS_TYPE_UINT64        ((int) 't')
  51 #define DBUS_TYPE_DOUBLE        ((int) 'd')
  52 #define DBUS_TYPE_STRING        ((int) 's')
  53 #define DBUS_TYPE_CUSTOM        ((int) 'c')
  54 #define DBUS_TYPE_ARRAY         ((int) 'a')
  55 #define DBUS_TYPE_DICT          ((int) 'm')
  56 #define DBUS_TYPE_OBJECT_PATH   ((int) 'o')
  57
  58 #define DBUS_NUMBER_OF_TYPES    (13)
  59
  60 /* Max length in bytes of a service or interface or member name */
  61 #define DBUS_MAXIMUM_NAME_LENGTH 256
  62
  63 /* Max length of a match rule string */
  64 #define DBUS_MAXIMUM_MATCH_RULE_LENGTH 1024
  65
  66 /* Types of message */
  67 #define DBUS_MESSAGE_TYPE_INVALID       0
  68 #define DBUS_MESSAGE_TYPE_METHOD_CALL   1
  69 #define DBUS_MESSAGE_TYPE_METHOD_RETURN 2
  70 #define DBUS_MESSAGE_TYPE_ERROR         3
  71 #define DBUS_MESSAGE_TYPE_SIGNAL        4
  72
  73 /* Header flags */
  74 #define DBUS_HEADER_FLAG_NO_REPLY_EXPECTED 0x1
  75 #define DBUS_HEADER_FLAG_AUTO_ACTIVATION   0x2
  76
  77 /* Header fields */
  78 #define DBUS_HEADER_FIELD_INVALID        0
  79 #define DBUS_HEADER_FIELD_PATH           1
  80 #define DBUS_HEADER_FIELD_INTERFACE      2
  81 #define DBUS_HEADER_FIELD_MEMBER         3
  82 #define DBUS_HEADER_FIELD_ERROR_NAME     4
  83 #define DBUS_HEADER_FIELD_REPLY_SERIAL   5
  84 #define DBUS_HEADER_FIELD_DESTINATION    6
  85 #define DBUS_HEADER_FIELD_SENDER         7
  86 #define DBUS_HEADER_FIELD_SIGNATURE      8
  87
  88 #define DBUS_HEADER_FIELD_LAST DBUS_HEADER_FIELD_SIGNATURE
  89
  90 /* Services */
  91 #define DBUS_SERVICE_ORG_FREEDESKTOP_DBUS      "org.freedesktop.DBus"
  92
  93 /* Paths */
  94 #define DBUS_PATH_ORG_FREEDESKTOP_DBUS  "/org/freedesktop/DBus"
  95 #define DBUS_PATH_ORG_FREEDESKTOP_LOCAL "/org/freedesktop/Local"
  96
  97 /* Interfaces, these #define don't do much other than
  98  * catch typos at compile time
  99  */
 100 #define DBUS_INTERFACE_ORG_FREEDESKTOP_DBUS  "org.freedesktop.DBus"
 101 #define DBUS_INTERFACE_ORG_FREEDESKTOP_INTROSPECTABLE "org.freedesktop.Introspectable"
 102
 103 /* This is a special interface whose methods can only be invoked
 104  * by the local implementation (messages from remote apps aren't
 105  * allowed to specify this interface).
 106  */
 107 #define DBUS_INTERFACE_ORG_FREEDESKTOP_LOCAL "org.freedesktop.Local"
 108
 109 /* Service owner flags */
 110 #define DBUS_SERVICE_FLAG_PROHIBIT_REPLACEMENT 0x1
 111 #define DBUS_SERVICE_FLAG_REPLACE_EXISTING     0x2
 112
 113 /* Service replies */
 114 #define DBUS_SERVICE_REPLY_PRIMARY_OWNER  0x1
 115 #define DBUS_SERVICE_REPLY_IN_QUEUE       0x2
 116 #define DBUS_SERVICE_REPLY_SERVICE_EXISTS 0x4
 117 #define DBUS_SERVICE_REPLY_ALREADY_OWNER  0x8
 118
 119 /* Activation replies */
 120 #define DBUS_ACTIVATION_REPLY_ACTIVATED      0x0
 121 #define DBUS_ACTIVATION_REPLY_ALREADY_ACTIVE 0x1
 122
 123 /* Errors */
 124 /* WARNING these get autoconverted to an enum in dbus-glib.h. Thus,
 125  * if you change the order it breaks the ABI. Keep them in order.
 126  * Also, don't change the formatting since that will break the sed
 127  * script.
 128  */
 129 #define DBUS_ERROR_FAILED                     "org.freedesktop.DBus.Error.Failed"
 130 #define DBUS_ERROR_NO_MEMORY                  "org.freedesktop.DBus.Error.NoMemory"
 131 #define DBUS_ERROR_ACTIVATE_SERVICE_NOT_FOUND "org.freedesktop.DBus.Error.ServiceNotFound"
 132 #define DBUS_ERROR_SERVICE_DOES_NOT_EXIST     "org.freedesktop.DBus.Error.ServiceDoesNotExist"
 133 #define DBUS_ERROR_SERVICE_HAS_NO_OWNER       "org.freedesktop.DBus.Error.ServiceHasNoOwner"
 134 #define DBUS_ERROR_NO_REPLY                   "org.freedesktop.DBus.Error.NoReply"
 135 #define DBUS_ERROR_IO_ERROR                   "org.freedesktop.DBus.Error.IOError"
 136 #define DBUS_ERROR_BAD_ADDRESS                "org.freedesktop.DBus.Error.BadAddress"
 137 #define DBUS_ERROR_NOT_SUPPORTED              "org.freedesktop.DBus.Error.NotSupported"
 138 #define DBUS_ERROR_LIMITS_EXCEEDED            "org.freedesktop.DBus.Error.LimitsExceeded"
 139 #define DBUS_ERROR_ACCESS_DENIED              "org.freedesktop.DBus.Error.AccessDenied"
 140 #define DBUS_ERROR_AUTH_FAILED                "org.freedesktop.DBus.Error.AuthFailed"
 141 #define DBUS_ERROR_NO_SERVER                  "org.freedesktop.DBus.Error.NoServer"
 142 #define DBUS_ERROR_TIMEOUT                    "org.freedesktop.DBus.Error.Timeout"
 143 #define DBUS_ERROR_NO_NETWORK                 "org.freedesktop.DBus.Error.NoNetwork"
 144 #define DBUS_ERROR_ADDRESS_IN_USE             "org.freedesktop.DBus.Error.AddressInUse"
 145 #define DBUS_ERROR_DISCONNECTED               "org.freedesktop.DBus.Error.Disconnected"
 146 #define DBUS_ERROR_INVALID_ARGS               "org.freedesktop.DBus.Error.InvalidArgs"
 147 #define DBUS_ERROR_FILE_NOT_FOUND             "org.freedesktop.DBus.Error.FileNotFound"
 148 #define DBUS_ERROR_UNKNOWN_METHOD             "org.freedesktop.DBus.Error.UnknownMethod"
 149 #define DBUS_ERROR_TIMED_OUT                  "org.freedesktop.DBus.Error.TimedOut"
 150 #define DBUS_ERROR_MATCH_RULE_NOT_FOUND       "org.freedesktop.DBus.Error.MatchRuleNotFound"
 151 #define DBUS_ERROR_MATCH_RULE_INVALID         "org.freedesktop.DBus.Error.MatchRuleInvalid"
 152 #define DBUS_ERROR_SPAWN_EXEC_FAILED          "org.freedesktop.DBus.Error.Spawn.ExecFailed"
 153 #define DBUS_ERROR_SPAWN_FORK_FAILED          "org.freedesktop.DBus.Error.Spawn.ForkFailed"
 154 #define DBUS_ERROR_SPAWN_CHILD_EXITED         "org.freedesktop.DBus.Error.Spawn.ChildExited"
 155 #define DBUS_ERROR_SPAWN_CHILD_SIGNALED       "org.freedesktop.DBus.Error.Spawn.ChildSignaled"
 156 #define DBUS_ERROR_SPAWN_FAILED               "org.freedesktop.DBus.Error.Spawn.Failed"
 157 #define DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN    "org.freedesktop.DBus.Error.UnixProcessIdUnknown"
 158
 159 #ifdef __cplusplus
 160 }
 161 #endif
 162
 163 #endif /* DBUS_PROTOCOL_H */