dbus/dbus-message.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-message.h DBusMessage object
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
  24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
  25 #endif
  26
  27 #ifndef DBUS_MESSAGE_H
  28 #define DBUS_MESSAGE_H
  29
  30 #include <dbus/dbus-macros.h>
  31 #include <dbus/dbus-types.h>
  32 #include <dbus/dbus-arch-deps.h>
  33 #include <stdarg.h>
  34
  35 DBUS_BEGIN_DECLS;
  36
  37 typedef struct DBusMessage DBusMessage;
  38 typedef struct DBusMessageIter DBusMessageIter;
  39
  40 struct DBusMessageIter
  41 {
  42   void *dummy1;
  43   void *dummy2;
  44   dbus_uint32_t dummy3;
  45   int dummy4;
  46   int dummy5;
  47   int dummy6;
  48   int dummy7;
  49   int dummy8;
  50   int dummy9;
  51   int dummy10;
  52   int dummy11;
  53   int pad1;
  54   int pad2;
  55   void *pad3;
  56 };
  57
  58
  59 DBusMessage* dbus_message_new              (const char        *service,
  60                                             const char        *name);
  61 DBusMessage* dbus_message_new_reply        (DBusMessage       *original_message);
  62 DBusMessage* dbus_message_new_error_reply  (DBusMessage       *original_message,
  63                                             const char        *error_name,
  64                                             const char        *error_message);
  65 DBusMessage *dbus_message_copy             (const DBusMessage *message);
  66
  67 void          dbus_message_ref              (DBusMessage   *message);
  68 void          dbus_message_unref            (DBusMessage   *message);
  69 const char*   dbus_message_get_name         (DBusMessage   *message);
  70 const char*   dbus_message_get_service      (DBusMessage   *message);
  71 dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
  72                                              const char    *sender);
  73 const char*   dbus_message_get_sender       (DBusMessage   *message);
  74 void          dbus_message_set_is_error     (DBusMessage   *message,
  75                                              dbus_bool_t    is_error_reply);
  76 dbus_bool_t   dbus_message_get_is_error     (DBusMessage   *message);
  77 dbus_bool_t   dbus_message_name_is          (DBusMessage   *message,
  78                                              const char    *name);
  79 dbus_bool_t   dbus_message_service_is       (DBusMessage   *message,
  80                                              const char    *service);
  81 dbus_bool_t   dbus_message_sender_is        (DBusMessage   *message,
  82                                              const char    *service);
  83 dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
  84 dbus_bool_t   dbus_message_set_reply_serial (DBusMessage   *message,
  85                                              dbus_uint32_t  reply_serial);
  86 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage   *message);
  87
  88 dbus_bool_t dbus_message_append_args          (DBusMessage     *message,
  89                                                int              first_arg_type,
  90                                                ...);
  91 dbus_bool_t dbus_message_append_args_valist   (DBusMessage     *message,
  92                                                int              first_arg_type,
  93                                                va_list          var_args);
  94 dbus_bool_t dbus_message_get_args             (DBusMessage     *message,
  95                                                DBusError       *error,
  96                                                int              first_arg_type,
  97                                                ...);
  98 dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
  99                                                DBusError       *error,
 100                                                int              first_arg_type,
 101                                                va_list          var_args);
 102 dbus_bool_t dbus_message_iter_get_args        (DBusMessageIter *iter,
 103                                                DBusError       *error,
 104                                                int              first_arg_type,
 105                                                ...);
 106 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
 107                                                DBusError       *error,
 108                                                int              first_arg_type,
 109                                                va_list          var_args);
 110
 111
 112
 113 void          dbus_message_iter_init           (DBusMessage      *message,
 114                                                 DBusMessageIter  *iter);
 115 dbus_bool_t   dbus_message_iter_has_next       (DBusMessageIter  *iter);
 116 dbus_bool_t   dbus_message_iter_next           (DBusMessageIter  *iter);
 117 int           dbus_message_iter_get_arg_type   (DBusMessageIter  *iter);
 118 int           dbus_message_iter_get_array_type (DBusMessageIter  *iter);
 119 unsigned char dbus_message_iter_get_byte       (DBusMessageIter  *iter);
 120 dbus_bool_t   dbus_message_iter_get_boolean    (DBusMessageIter  *iter);
 121 dbus_int32_t  dbus_message_iter_get_int32      (DBusMessageIter  *iter);
 122 dbus_uint32_t dbus_message_iter_get_uint32     (DBusMessageIter  *iter);
 123 #ifdef DBUS_HAVE_INT64
 124 dbus_int64_t  dbus_message_iter_get_int64      (DBusMessageIter  *iter);
 125 dbus_uint64_t dbus_message_iter_get_uint64     (DBusMessageIter  *iter);
 126 #endif /* DBUS_HAVE_INT64 */
 127 double        dbus_message_iter_get_double     (DBusMessageIter  *iter);
 128 char *        dbus_message_iter_get_string     (DBusMessageIter  *iter);
 129 char *        dbus_message_iter_get_dict_key   (DBusMessageIter  *iter);
 130 dbus_bool_t   dbus_message_iter_get_named      (DBusMessageIter  *iter,
 131                                                 char            **name,
 132                                                 unsigned char   **value,
 133                                                 int              *len);
 134
 135 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter   *iter,
 136                                                    DBusMessageIter   *array_iter,
 137                                                    int               *array_type);
 138 dbus_bool_t dbus_message_iter_init_dict_iterator  (DBusMessageIter   *iter,
 139                                                    DBusMessageIter   *dict_iter);
 140 dbus_bool_t dbus_message_iter_get_byte_array      (DBusMessageIter   *iter,
 141                                                    unsigned char    **value,
 142                                                    int               *len);
 143 dbus_bool_t dbus_message_iter_get_boolean_array   (DBusMessageIter   *iter,
 144                                                    unsigned char    **value,
 145                                                    int               *len);
 146 dbus_bool_t dbus_message_iter_get_int32_array     (DBusMessageIter   *iter,
 147                                                    dbus_int32_t     **value,
 148                                                    int               *len);
 149 dbus_bool_t dbus_message_iter_get_uint32_array    (DBusMessageIter   *iter,
 150                                                    dbus_uint32_t    **value,
 151                                                    int               *len);
 152 #ifdef DBUS_HAVE_INT64
 153 dbus_bool_t dbus_message_iter_get_int64_array     (DBusMessageIter   *iter,
 154                                                    dbus_int64_t     **value,
 155                                                    int               *len);
 156 dbus_bool_t dbus_message_iter_get_uint64_array    (DBusMessageIter   *iter,
 157                                                    dbus_uint64_t    **value,
 158                                                    int               *len);
 159 #endif /* DBUS_HAVE_INT64 */
 160 dbus_bool_t dbus_message_iter_get_double_array    (DBusMessageIter   *iter,
 161                                                    double           **value,
 162                                                    int               *len);
 163 dbus_bool_t dbus_message_iter_get_string_array    (DBusMessageIter   *iter,
 164                                                    char            ***value,
 165                                                    int               *len);
 166
 167
 168 void        dbus_message_append_iter_init          (DBusMessage          *message,
 169                                                     DBusMessageIter      *iter);
 170 dbus_bool_t dbus_message_iter_append_nil           (DBusMessageIter      *iter);
 171 dbus_bool_t dbus_message_iter_append_boolean       (DBusMessageIter      *iter,
 172                                                     dbus_bool_t           value);
 173 dbus_bool_t dbus_message_iter_append_byte          (DBusMessageIter      *iter,
 174                                                     unsigned char         value);
 175 dbus_bool_t dbus_message_iter_append_int32         (DBusMessageIter      *iter,
 176                                                     dbus_int32_t          value);
 177 dbus_bool_t dbus_message_iter_append_uint32        (DBusMessageIter      *iter,
 178                                                     dbus_uint32_t         value);
 179 #ifdef DBUS_HAVE_INT64
 180 dbus_bool_t dbus_message_iter_append_int64         (DBusMessageIter      *iter,
 181                                                     dbus_int64_t          value);
 182 dbus_bool_t dbus_message_iter_append_uint64        (DBusMessageIter      *iter,
 183                                                     dbus_uint64_t         value);
 184 #endif /* DBUS_HAVE_INT64 */
 185 dbus_bool_t dbus_message_iter_append_double        (DBusMessageIter      *iter,
 186                                                     double                value);
 187 dbus_bool_t dbus_message_iter_append_string        (DBusMessageIter      *iter,
 188                                                     const char           *value);
 189 dbus_bool_t dbus_message_iter_append_named         (DBusMessageIter      *iter,
 190                                                     const char           *name,
 191                                                     const unsigned char  *data,
 192                                                     int                   len);
 193 dbus_bool_t dbus_message_iter_append_dict_key      (DBusMessageIter      *iter,
 194                                                     const char           *value);
 195 dbus_bool_t dbus_message_iter_append_array         (DBusMessageIter      *iter,
 196                                                     DBusMessageIter      *array_iter,
 197                                                     int                   element_type);
 198 dbus_bool_t dbus_message_iter_append_dict          (DBusMessageIter      *iter,
 199                                                     DBusMessageIter      *dict_iter);
 200
 201 /* Helpers for normal types: */
 202 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter      *iter,
 203                                                     unsigned const char  *value,
 204                                                     int                   len);
 205 dbus_bool_t dbus_message_iter_append_int32_array   (DBusMessageIter      *iter,
 206                                                     const dbus_int32_t   *value,
 207                                                     int                   len);
 208 dbus_bool_t dbus_message_iter_append_uint32_array  (DBusMessageIter      *iter,
 209                                                     const dbus_uint32_t  *value,
 210                                                     int                   len);
 211 #ifdef DBUS_HAVE_INT64
 212 dbus_bool_t dbus_message_iter_append_int64_array   (DBusMessageIter      *iter,
 213                                                     const dbus_int64_t   *value,
 214                                                     int                   len);
 215 dbus_bool_t dbus_message_iter_append_uint64_array  (DBusMessageIter      *iter,
 216                                                     const dbus_uint64_t  *value,
 217                                                     int                   len);
 218 #endif /* DBUS_HAVE_INT64 */
 219 dbus_bool_t dbus_message_iter_append_double_array  (DBusMessageIter      *iter,
 220                                                     const double         *value,
 221                                                     int                   len);
 222 dbus_bool_t dbus_message_iter_append_byte_array    (DBusMessageIter      *iter,
 223                                                     unsigned const char  *value,
 224                                                     int                   len);
 225 dbus_bool_t dbus_message_iter_append_string_array  (DBusMessageIter      *iter,
 226                                                     const char          **value,
 227                                                     int                   len);
 228
 229
 230
 231 dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
 232                                            DBusMessage  *message);
 233
 234 DBUS_END_DECLS;
 235
 236 #endif /* DBUS_MESSAGE_H */