src/libsystemd-bus/sd-bus-protocol.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosdbusprotocolhfoo
   4 #define foosdbusprotocolhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2013 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <endian.h>
  26
  27 /* Types of message */
  28
  29 #define SD_BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
  30
  31 enum {
  32         _SD_BUS_MESSAGE_TYPE_INVALID = 0,
  33         SD_BUS_MESSAGE_TYPE_METHOD_CALL,
  34         SD_BUS_MESSAGE_TYPE_METHOD_RETURN,
  35         SD_BUS_MESSAGE_TYPE_METHOD_ERROR,
  36         SD_BUS_MESSAGE_TYPE_SIGNAL,
  37         _SD_BUS_MESSAGE_TYPE_MAX
  38 };
  39
  40 /* Primitive types */
  41
  42 enum {
  43         _SD_BUS_TYPE_INVALID         = 0,
  44         SD_BUS_TYPE_BYTE             = 'y',
  45         SD_BUS_TYPE_BOOLEAN          = 'b',
  46         SD_BUS_TYPE_INT16            = 'n',
  47         SD_BUS_TYPE_UINT16           = 'q',
  48         SD_BUS_TYPE_INT32            = 'i',
  49         SD_BUS_TYPE_UINT32           = 'u',
  50         SD_BUS_TYPE_INT64            = 'x',
  51         SD_BUS_TYPE_UINT64           = 't',
  52         SD_BUS_TYPE_DOUBLE           = 'd',
  53         SD_BUS_TYPE_STRING           = 's',
  54         SD_BUS_TYPE_OBJECT_PATH      = 'o',
  55         SD_BUS_TYPE_SIGNATURE        = 'g',
  56         SD_BUS_TYPE_UNIX_FD          = 'h',
  57         SD_BUS_TYPE_ARRAY            = 'a',
  58         SD_BUS_TYPE_VARIANT          = 'v',
  59         SD_BUS_TYPE_STRUCT           = 'r', /* not actually used in signatures */
  60         SD_BUS_TYPE_STRUCT_BEGIN     = '(',
  61         SD_BUS_TYPE_STRUCT_END       = ')',
  62         SD_BUS_TYPE_DICT_ENTRY       = 'e', /* not actually used in signatures */
  63         SD_BUS_TYPE_DICT_ENTRY_BEGIN = '{',
  64         SD_BUS_TYPE_DICT_ENTRY_END   = '}',
  65 };
  66
  67 /* Endianess */
  68
  69 enum {
  70         _SD_BUS_INVALID_ENDIAN = 0,
  71         SD_BUS_LITTLE_ENDIAN   = 'l',
  72         SD_BUS_BIG_ENDIAN      = 'B',
  73 #if __BYTE_ORDER == __BIG_ENDIAN
  74         SD_BUS_NATIVE_ENDIAN   = SD_BUS_BIG_ENDIAN,
  75         SD_BUS_REVERSE_ENDIAN  = SD_BUS_LITTLE_ENDIAN
  76 #else
  77         SD_BUS_NATIVE_ENDIAN   = SD_BUS_LITTLE_ENDIAN,
  78         SD_BUS_REVERSE_ENDIAN  = SD_BUS_BIG_ENDIAN
  79 #endif
  80 };
  81
  82 /* Flags */
  83
  84 enum {
  85         SD_BUS_MESSAGE_NO_REPLY_EXPECTED = 1,
  86         SD_BUS_MESSAGE_NO_AUTO_START = 2
  87 };
  88
  89 /* Header fields */
  90
  91 enum {
  92         _SD_BUS_MESSAGE_HEADER_INVALID = 0,
  93         SD_BUS_MESSAGE_HEADER_PATH,
  94         SD_BUS_MESSAGE_HEADER_INTERFACE,
  95         SD_BUS_MESSAGE_HEADER_MEMBER,
  96         SD_BUS_MESSAGE_HEADER_ERROR_NAME,
  97         SD_BUS_MESSAGE_HEADER_REPLY_SERIAL,
  98         SD_BUS_MESSAGE_HEADER_DESTINATION,
  99         SD_BUS_MESSAGE_HEADER_SENDER,
 100         SD_BUS_MESSAGE_HEADER_SIGNATURE,
 101         SD_BUS_MESSAGE_HEADER_UNIX_FDS,
 102         _SD_BUS_MESSAGE_HEADER_MAX
 103 };
 104
 105 #endif