1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-protocol.h D-Bus protocol constants
4 * Copyright (C) 2002, 2003 CodeFactory AB
6 * Licensed under the Academic Free License version 1.2
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.
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.
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
24 #ifndef DBUS_PROTOCOL_H
25 #define DBUS_PROTOCOL_H
27 /* Don't include anything in here from anywhere else. It's
28 * intended for use by any random library.
35 /* Message byte order */
36 #define DBUS_LITTLE_ENDIAN ('l') /* LSB first */
37 #define DBUS_BIG_ENDIAN ('B') /* MSB first */
39 /* Protocol version */
40 #define DBUS_MAJOR_PROTOCOL_VERSION 0
43 #define DBUS_TYPE_INVALID 0
44 #define DBUS_TYPE_NIL 1
45 #define DBUS_TYPE_BYTE 2
46 #define DBUS_TYPE_BOOLEAN 3
47 #define DBUS_TYPE_INT32 4
48 #define DBUS_TYPE_UINT32 5
49 #define DBUS_TYPE_INT64 6
50 #define DBUS_TYPE_UINT64 7
51 #define DBUS_TYPE_DOUBLE 8
52 #define DBUS_TYPE_STRING 9
53 #define DBUS_TYPE_NAMED 10
54 #define DBUS_TYPE_ARRAY 11
55 #define DBUS_TYPE_DICT 12
56 #define DBUS_TYPE_OBJECT_ID 13
58 #define DBUS_TYPE_LAST DBUS_TYPE_OBJECT_ID
60 /* Max length in bytes of a service or interface or member name */
61 #define DBUS_MAXIMUM_NAME_LENGTH 256
63 /* Types of message */
64 #define DBUS_MESSAGE_TYPE_INVALID 0
65 #define DBUS_MESSAGE_TYPE_METHOD_CALL 1
66 #define DBUS_MESSAGE_TYPE_METHOD_RETURN 2
67 #define DBUS_MESSAGE_TYPE_ERROR 3
68 #define DBUS_MESSAGE_TYPE_SIGNAL 4
71 #define DBUS_HEADER_FLAG_NO_REPLY_EXPECTED 0x1
74 #define DBUS_HEADER_FIELD_INTERFACE "ifce"
75 #define DBUS_HEADER_FIELD_MEMBER "mebr"
76 #define DBUS_HEADER_FIELD_ERROR_NAME "ernm"
77 #define DBUS_HEADER_FIELD_SERVICE "srvc"
78 #define DBUS_HEADER_FIELD_REPLY "rply"
79 #define DBUS_HEADER_FIELD_SENDER "sndr"
82 #define DBUS_SERVICE_ORG_FREEDESKTOP_DBUS "org.freedesktop.DBus"
83 #define DBUS_SERVICE_ORG_FREEDESKTOP_BROADCAST "org.freedesktop.Broadcast"
85 /* Service owner flags */
86 #define DBUS_SERVICE_FLAG_PROHIBIT_REPLACEMENT 0x1
87 #define DBUS_SERVICE_FLAG_REPLACE_EXISTING 0x2
90 #define DBUS_SERVICE_REPLY_PRIMARY_OWNER 0x1
91 #define DBUS_SERVICE_REPLY_IN_QUEUE 0x2
92 #define DBUS_SERVICE_REPLY_SERVICE_EXISTS 0x4
93 #define DBUS_SERVICE_REPLY_ALREADY_OWNER 0x8
95 /* Activation replies */
96 #define DBUS_ACTIVATION_REPLY_ACTIVATED 0x0
97 #define DBUS_ACTIVATION_REPLY_ALREADY_ACTIVE 0x1
99 /* Interfaces, these #define don't do much other than
100 * catch typos at compile time
102 #define DBUS_INTERFACE_ORG_FREEDESKTOP_DBUS "org.freedesktop.DBus"
104 /* This is a special interface whose methods can only be invoked
105 * by the local implementation (messages from remote apps aren't
106 * allowed to specify this interface).
108 #define DBUS_INTERFACE_ORG_FREEDESKTOP_LOCAL "org.freedesktop.Local"
111 /* these are a bad idea, FIXME */
112 #define DBUS_METHOD_ORG_FREEDESKTOP_DBUS_ACTIVATE_SERVICE "ActivateService"
113 #define DBUS_METHOD_ORG_FREEDESKTOP_DBUS_SERVICE_EXISTS "ServiceExists"
114 #define DBUS_METHOD_ORG_FREEDESKTOP_DBUS_HELLO "Hello"
115 #define DBUS_METHOD_ORG_FREEDESKTOP_DBUS_LIST_SERVICES "ListServices"
116 #define DBUS_METHOD_ORG_FREEDESKTOP_DBUS_ACQUIRE_SERVICE "AcquireService"
118 #define DBUS_SIGNAL_ORG_FREEDESKTOP_DBUS_SERVICE_ACQUIRED "ServiceAcquired"
119 #define DBUS_SIGNAL_ORG_FREEDESKTOP_DBUS_SERVICE_CREATED "ServiceCreated"
120 #define DBUS_SIGNAL_ORG_FREEDESKTOP_DBUS_SERVICE_DELETED "ServiceDeleted"
121 #define DBUS_SIGNAL_ORG_FREEDESKTOP_DBUS_SERVICE_LOST "ServiceLost"
128 #endif /* DBUS_PROTOCOL_H */