/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ /* dbus-protocol.h D-Bus protocol constants * * Copyright (C) 2002, 2003 CodeFactory AB * Copyright (C) 2004, 2005 Red Hat, Inc. * * Licensed under the Academic Free License version 2.1 * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * */ #ifndef DBUS_PROTOCOL_H #define DBUS_PROTOCOL_H /* Don't include anything in here from anywhere else. It's * intended for use by any random library. */ #ifdef __cplusplus extern "C" { #if 0 } /* avoids confusing emacs indentation */ #endif #endif /* Normally docs are in .c files, but there isn't a .c file for this. */ /** * @defgroup DBusProtocol Protocol constants * @ingroup DBus * * @brief Defines constants which are part of the D-Bus protocol * * This header is intended for use by any library, not only libdbus. * * @{ */ /* Message byte order */ #define DBUS_LITTLE_ENDIAN … #define DBUS_BIG_ENDIAN … /** Protocol version. */ #define DBUS_MAJOR_PROTOCOL_VERSION … /** Type code that is never equal to a legitimate type code */ #define DBUS_TYPE_INVALID … /** #DBUS_TYPE_INVALID as a string literal instead of a int literal */ #define DBUS_TYPE_INVALID_AS_STRING … /* Primitive types */ /** Type code marking an 8-bit unsigned integer */ #define DBUS_TYPE_BYTE … /** #DBUS_TYPE_BYTE as a string literal instead of a int literal */ #define DBUS_TYPE_BYTE_AS_STRING … /** Type code marking a boolean */ #define DBUS_TYPE_BOOLEAN … /** #DBUS_TYPE_BOOLEAN as a string literal instead of a int literal */ #define DBUS_TYPE_BOOLEAN_AS_STRING … /** Type code marking a 16-bit signed integer */ #define DBUS_TYPE_INT16 … /** #DBUS_TYPE_INT16 as a string literal instead of a int literal */ #define DBUS_TYPE_INT16_AS_STRING … /** Type code marking a 16-bit unsigned integer */ #define DBUS_TYPE_UINT16 … /** #DBUS_TYPE_UINT16 as a string literal instead of a int literal */ #define DBUS_TYPE_UINT16_AS_STRING … /** Type code marking a 32-bit signed integer */ #define DBUS_TYPE_INT32 … /** #DBUS_TYPE_INT32 as a string literal instead of a int literal */ #define DBUS_TYPE_INT32_AS_STRING … /** Type code marking a 32-bit unsigned integer */ #define DBUS_TYPE_UINT32 … /** #DBUS_TYPE_UINT32 as a string literal instead of a int literal */ #define DBUS_TYPE_UINT32_AS_STRING … /** Type code marking a 64-bit signed integer */ #define DBUS_TYPE_INT64 … /** #DBUS_TYPE_INT64 as a string literal instead of a int literal */ #define DBUS_TYPE_INT64_AS_STRING … /** Type code marking a 64-bit unsigned integer */ #define DBUS_TYPE_UINT64 … /** #DBUS_TYPE_UINT64 as a string literal instead of a int literal */ #define DBUS_TYPE_UINT64_AS_STRING … /** Type code marking an 8-byte double in IEEE 754 format */ #define DBUS_TYPE_DOUBLE … /** #DBUS_TYPE_DOUBLE as a string literal instead of a int literal */ #define DBUS_TYPE_DOUBLE_AS_STRING … /** Type code marking a UTF-8 encoded, nul-terminated Unicode string */ #define DBUS_TYPE_STRING … /** #DBUS_TYPE_STRING as a string literal instead of a int literal */ #define DBUS_TYPE_STRING_AS_STRING … /** Type code marking a D-Bus object path */ #define DBUS_TYPE_OBJECT_PATH … /** #DBUS_TYPE_OBJECT_PATH as a string literal instead of a int literal */ #define DBUS_TYPE_OBJECT_PATH_AS_STRING … /** Type code marking a D-Bus type signature */ #define DBUS_TYPE_SIGNATURE … /** #DBUS_TYPE_SIGNATURE as a string literal instead of a int literal */ #define DBUS_TYPE_SIGNATURE_AS_STRING … /** Type code marking a unix file descriptor */ #define DBUS_TYPE_UNIX_FD … /** #DBUS_TYPE_UNIX_FD as a string literal instead of a int literal */ #define DBUS_TYPE_UNIX_FD_AS_STRING … /* Compound types */ /** Type code marking a D-Bus array type */ #define DBUS_TYPE_ARRAY … /** #DBUS_TYPE_ARRAY as a string literal instead of a int literal */ #define DBUS_TYPE_ARRAY_AS_STRING … /** Type code marking a D-Bus variant type */ #define DBUS_TYPE_VARIANT … /** #DBUS_TYPE_VARIANT as a string literal instead of a int literal */ #define DBUS_TYPE_VARIANT_AS_STRING … /** STRUCT and DICT_ENTRY are sort of special since their codes can't * appear in a type string, instead * DBUS_STRUCT_BEGIN_CHAR/DBUS_DICT_ENTRY_BEGIN_CHAR have to appear */ /** Type code used to represent a struct; however, this type code does not appear * in type signatures, instead #DBUS_STRUCT_BEGIN_CHAR and #DBUS_STRUCT_END_CHAR will * appear in a signature. */ #define DBUS_TYPE_STRUCT … /** #DBUS_TYPE_STRUCT as a string literal instead of a int literal */ #define DBUS_TYPE_STRUCT_AS_STRING … /** Type code used to represent a dict entry; however, this type code does not appear * in type signatures, instead #DBUS_DICT_ENTRY_BEGIN_CHAR and #DBUS_DICT_ENTRY_END_CHAR will * appear in a signature. */ #define DBUS_TYPE_DICT_ENTRY … /** #DBUS_TYPE_DICT_ENTRY as a string literal instead of a int literal */ #define DBUS_TYPE_DICT_ENTRY_AS_STRING … /** Does not include #DBUS_TYPE_INVALID, #DBUS_STRUCT_BEGIN_CHAR, #DBUS_STRUCT_END_CHAR, * #DBUS_DICT_ENTRY_BEGIN_CHAR, or #DBUS_DICT_ENTRY_END_CHAR - i.e. it is the number of * valid types, not the number of distinct characters that may appear in a type signature. */ #define DBUS_NUMBER_OF_TYPES … /* characters other than typecodes that appear in type signatures */ /** Code marking the start of a struct type in a type signature */ #define DBUS_STRUCT_BEGIN_CHAR … /** #DBUS_STRUCT_BEGIN_CHAR as a string literal instead of a int literal */ #define DBUS_STRUCT_BEGIN_CHAR_AS_STRING … /** Code marking the end of a struct type in a type signature */ #define DBUS_STRUCT_END_CHAR … /** #DBUS_STRUCT_END_CHAR a string literal instead of a int literal */ #define DBUS_STRUCT_END_CHAR_AS_STRING … /** Code marking the start of a dict entry type in a type signature */ #define DBUS_DICT_ENTRY_BEGIN_CHAR … /** #DBUS_DICT_ENTRY_BEGIN_CHAR as a string literal instead of a int literal */ #define DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING … /** Code marking the end of a dict entry type in a type signature */ #define DBUS_DICT_ENTRY_END_CHAR … /** #DBUS_DICT_ENTRY_END_CHAR as a string literal instead of a int literal */ #define DBUS_DICT_ENTRY_END_CHAR_AS_STRING … /** Max length in bytes of a bus name, interface, or member (not object * path, paths are unlimited). This is limited because lots of stuff * is O(n) in this number, plus it would be obnoxious to type in a * paragraph-long method name so most likely something like that would * be an exploit. */ #define DBUS_MAXIMUM_NAME_LENGTH … /** This one is 255 so it fits in a byte */ #define DBUS_MAXIMUM_SIGNATURE_LENGTH … /** Max length of a match rule string; to keep people from hosing the * daemon with some huge rule */ #define DBUS_MAXIMUM_MATCH_RULE_LENGTH … /** Max arg number you can match on in a match rule, e.g. * arg0='hello' is OK, arg3489720987='hello' is not */ #define DBUS_MAXIMUM_MATCH_RULE_ARG_NUMBER … /** Max length of a marshaled array in bytes (64M, 2^26) We use signed * int for lengths so must be INT_MAX or less. We need something a * bit smaller than INT_MAX because the array is inside a message with * header info, etc. so an INT_MAX array wouldn't allow the message * overhead. The 64M number is an attempt at a larger number than * we'd reasonably ever use, but small enough that your bus would chew * through it fairly quickly without locking up forever. If you have * data that's likely to be larger than this, you should probably be * sending it in multiple incremental messages anyhow. */ #define DBUS_MAXIMUM_ARRAY_LENGTH … /** Number of bits you need in an unsigned to store the max array size */ #define DBUS_MAXIMUM_ARRAY_LENGTH_BITS … /** The maximum total message size including header and body; similar * rationale to max array size. */ #define DBUS_MAXIMUM_MESSAGE_LENGTH … /** Number of bits you need in an unsigned to store the max message size */ #define DBUS_MAXIMUM_MESSAGE_LENGTH_BITS … /** The maximum total number of unix fds in a message. Similar * rationale as DBUS_MAXIMUM_MESSAGE_LENGTH. However we divide by four * given that one fd is an int and hence at least 32 bits. */ #define DBUS_MAXIMUM_MESSAGE_UNIX_FDS … /** Number of bits you need in an unsigned to store the max message unix fds */ #define DBUS_MAXIMUM_MESSAGE_UNIX_FDS_BITS … /** Depth of recursion in the type tree. This is automatically limited * to DBUS_MAXIMUM_SIGNATURE_LENGTH since you could only have an array * of array of array of ... that fit in the max signature. But that's * probably a bit too large. */ #define DBUS_MAXIMUM_TYPE_RECURSION_DEPTH … /* Types of message */ /** This value is never a valid message type, see dbus_message_get_type() */ #define DBUS_MESSAGE_TYPE_INVALID … /** Message type of a method call message, see dbus_message_get_type() */ #define DBUS_MESSAGE_TYPE_METHOD_CALL … /** Message type of a method return message, see dbus_message_get_type() */ #define DBUS_MESSAGE_TYPE_METHOD_RETURN … /** Message type of an error reply message, see dbus_message_get_type() */ #define DBUS_MESSAGE_TYPE_ERROR … /** Message type of a signal message, see dbus_message_get_type() */ #define DBUS_MESSAGE_TYPE_SIGNAL … #define DBUS_NUM_MESSAGE_TYPES … /* Header flags */ /** If set, this flag means that the sender of a message does not care about getting * a reply, so the recipient need not send one. See dbus_message_set_no_reply(). */ #define DBUS_HEADER_FLAG_NO_REPLY_EXPECTED … /** * If set, this flag means that even if the message bus knows how to start an owner for * the destination bus name (see dbus_message_set_destination()), it should not * do so. If this flag is not set, the bus may launch a program to process the * message. */ #define DBUS_HEADER_FLAG_NO_AUTO_START … /** * If set on a method call, this flag means that the caller is prepared to * wait for interactive authorization. */ #define DBUS_HEADER_FLAG_ALLOW_INTERACTIVE_AUTHORIZATION … /* Header fields */ /** Not equal to any valid header field code */ #define DBUS_HEADER_FIELD_INVALID … /** Header field code for the path - the path is the object emitting a signal or the object receiving a method call. * See dbus_message_set_path(). */ #define DBUS_HEADER_FIELD_PATH … /** Header field code for the interface containing a member (method or signal). * See dbus_message_set_interface(). */ #define DBUS_HEADER_FIELD_INTERFACE … /** Header field code for a member (method or signal). See dbus_message_set_member(). */ #define DBUS_HEADER_FIELD_MEMBER … /** Header field code for an error name (found in #DBUS_MESSAGE_TYPE_ERROR messages). * See dbus_message_set_error_name(). */ #define DBUS_HEADER_FIELD_ERROR_NAME … /** Header field code for a reply serial, used to match a #DBUS_MESSAGE_TYPE_METHOD_RETURN message with the * message that it's a reply to. See dbus_message_set_reply_serial(). */ #define DBUS_HEADER_FIELD_REPLY_SERIAL … /** * Header field code for the destination bus name of a message. See dbus_message_set_destination(). */ #define DBUS_HEADER_FIELD_DESTINATION … /** * Header field code for the sender of a message; usually initialized by the message bus. * See dbus_message_set_sender(). */ #define DBUS_HEADER_FIELD_SENDER … /** * Header field code for the type signature of a message. */ #define DBUS_HEADER_FIELD_SIGNATURE … /** * Header field code for the number of unix file descriptors associated * with this message. */ #define DBUS_HEADER_FIELD_UNIX_FDS … /** * Value of the highest-numbered header field code, can be used to determine * the size of an array indexed by header field code. Remember though * that unknown codes must be ignored, so check for that before * indexing the array. */ #define DBUS_HEADER_FIELD_LAST … /** Header format is defined as a signature: * byte byte order * byte message type ID * byte flags * byte protocol version * uint32 body length * uint32 serial * array of struct (byte,variant) (field name, value) * * The length of the header can be computed as the * fixed size of the initial data, plus the length of * the array at the end, plus padding to an 8-boundary. */ #define DBUS_HEADER_SIGNATURE … /** * The smallest header size that can occur. (It won't be valid due to * missing required header fields.) This is 4 bytes, two uint32, an * array length. This isn't any kind of resource limit, just the * necessary/logical outcome of the header signature. */ #define DBUS_MINIMUM_HEADER_SIZE … /* Errors */ /* WARNING these get autoconverted to an enum in dbus-glib.h. Thus, * if you change the order it breaks the ABI. Keep them in order. * Also, don't change the formatting since that will break the sed * script. */ /** A generic error; "something went wrong" - see the error message for more. */ #define DBUS_ERROR_FAILED … /** There was not enough memory to complete an operation. */ #define DBUS_ERROR_NO_MEMORY … /** The bus doesn't know how to launch a service to supply the bus name you wanted. */ #define DBUS_ERROR_SERVICE_UNKNOWN … /** The bus name you referenced doesn't exist (i.e. no application owns it). */ #define DBUS_ERROR_NAME_HAS_NO_OWNER … /** No reply to a message expecting one, usually means a timeout occurred. */ #define DBUS_ERROR_NO_REPLY … /** Something went wrong reading or writing to a socket, for example. */ #define DBUS_ERROR_IO_ERROR … /** A D-Bus bus address was malformed. */ #define DBUS_ERROR_BAD_ADDRESS … /** Requested operation isn't supported (like ENOSYS on UNIX). */ #define DBUS_ERROR_NOT_SUPPORTED … /** Some limited resource is exhausted. */ #define DBUS_ERROR_LIMITS_EXCEEDED … /** Security restrictions don't allow doing what you're trying to do. */ #define DBUS_ERROR_ACCESS_DENIED … /** Authentication didn't work. */ #define DBUS_ERROR_AUTH_FAILED … /** Unable to connect to server (probably caused by ECONNREFUSED on a socket). */ #define DBUS_ERROR_NO_SERVER … /** Certain timeout errors, possibly ETIMEDOUT on a socket. * Note that #DBUS_ERROR_NO_REPLY is used for message reply timeouts. * @warning this is confusingly-named given that #DBUS_ERROR_TIMED_OUT also exists. We can't fix * it for compatibility reasons so just be careful. */ #define DBUS_ERROR_TIMEOUT … /** No network access (probably ENETUNREACH on a socket). */ #define DBUS_ERROR_NO_NETWORK … /** Can't bind a socket since its address is in use (i.e. EADDRINUSE). */ #define DBUS_ERROR_ADDRESS_IN_USE … /** The connection is disconnected and you're trying to use it. */ #define DBUS_ERROR_DISCONNECTED … /** Invalid arguments passed to a method call. */ #define DBUS_ERROR_INVALID_ARGS … /** Missing file. */ #define DBUS_ERROR_FILE_NOT_FOUND … /** Existing file and the operation you're using does not silently overwrite. */ #define DBUS_ERROR_FILE_EXISTS … /** Method name you invoked isn't known by the object you invoked it on. */ #define DBUS_ERROR_UNKNOWN_METHOD … /** Object you invoked a method on isn't known. */ #define DBUS_ERROR_UNKNOWN_OBJECT … /** Interface you invoked a method on isn't known by the object. */ #define DBUS_ERROR_UNKNOWN_INTERFACE … /** Property you tried to access isn't known by the object. */ #define DBUS_ERROR_UNKNOWN_PROPERTY … /** Property you tried to set is read-only. */ #define DBUS_ERROR_PROPERTY_READ_ONLY … /** Certain timeout errors, e.g. while starting a service. * @warning this is confusingly-named given that #DBUS_ERROR_TIMEOUT also exists. We can't fix * it for compatibility reasons so just be careful. */ #define DBUS_ERROR_TIMED_OUT … /** Tried to remove or modify a match rule that didn't exist. */ #define DBUS_ERROR_MATCH_RULE_NOT_FOUND … /** The match rule isn't syntactically valid. */ #define DBUS_ERROR_MATCH_RULE_INVALID … /** While starting a new process, the exec() call failed. */ #define DBUS_ERROR_SPAWN_EXEC_FAILED … /** While starting a new process, the fork() call failed. */ #define DBUS_ERROR_SPAWN_FORK_FAILED … /** While starting a new process, the child exited with a status code. */ #define DBUS_ERROR_SPAWN_CHILD_EXITED … /** While starting a new process, the child exited on a signal. */ #define DBUS_ERROR_SPAWN_CHILD_SIGNALED … /** While starting a new process, something went wrong. */ #define DBUS_ERROR_SPAWN_FAILED … /** We failed to setup the environment correctly. */ #define DBUS_ERROR_SPAWN_SETUP_FAILED … /** We failed to setup the config parser correctly. */ #define DBUS_ERROR_SPAWN_CONFIG_INVALID … /** Bus name was not valid. */ #define DBUS_ERROR_SPAWN_SERVICE_INVALID … /** Service file not found in system-services directory. */ #define DBUS_ERROR_SPAWN_SERVICE_NOT_FOUND … /** Permissions are incorrect on the setuid helper. */ #define DBUS_ERROR_SPAWN_PERMISSIONS_INVALID … /** Service file invalid (Name, User or Exec missing). */ #define DBUS_ERROR_SPAWN_FILE_INVALID … /** Tried to get a UNIX process ID and it wasn't available. */ #define DBUS_ERROR_SPAWN_NO_MEMORY … /** Tried to get a UNIX process ID and it wasn't available. */ #define DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN … /** A type signature is not valid. */ #define DBUS_ERROR_INVALID_SIGNATURE … /** A file contains invalid syntax or is otherwise broken. */ #define DBUS_ERROR_INVALID_FILE_CONTENT … /** Asked for SELinux security context and it wasn't available. */ #define DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN … /** Asked for AppArmor security context and it wasn't available. */ #define DBUS_ERROR_APPARMOR_SECURITY_CONTEXT_UNKNOWN … /** Asked for ADT audit data and it wasn't available. */ #define DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN … /** There's already an object with the requested object path. */ #define DBUS_ERROR_OBJECT_PATH_IN_USE … /** The message meta data does not match the payload. e.g. expected number of file descriptors were not sent over the socket this message was received on. */ #define DBUS_ERROR_INCONSISTENT_MESSAGE … /** The message is not allowed without performing interactive authorization, * but could have succeeded if an interactive authorization step was * allowed. */ #define DBUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED … /* XML introspection format */ /** XML namespace of the introspection format version 1.0 */ #define DBUS_INTROSPECT_1_0_XML_NAMESPACE … /** XML public identifier of the introspection format version 1.0 */ #define DBUS_INTROSPECT_1_0_XML_PUBLIC_IDENTIFIER … /** XML system identifier of the introspection format version 1.0 */ #define DBUS_INTROSPECT_1_0_XML_SYSTEM_IDENTIFIER … /** XML document type declaration of the introspection format version 1.0 */ #define DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE … /** @} */ #ifdef __cplusplus #if 0 { /* avoids confusing emacs indentation */ #endif } #endif #endif /* DBUS_PROTOCOL_H */
Codebase Browser
godot