dbus/dbus-message.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-message.h DBusMessage object
   3  *
   4  * Copyright (C) 2002, 2003 Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.0
   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 <dbus/dbus-memory.h>
  34 #include <dbus/dbus-errors.h>
  35 #include <stdarg.h>
  36
  37 DBUS_BEGIN_DECLS;
  38
  39 typedef struct DBusMessage DBusMessage;
  40 typedef struct DBusMessageIter DBusMessageIter;
  41
  42 /**
  43  * DBusMessageIter struct; contains no public fields
  44  */
  45 struct DBusMessageIter
  46 {
  47   void *dummy1;         /**< Don't use this */
  48   void *dummy2;         /**< Don't use this */
  49   dbus_uint32_t dummy3; /**< Don't use this */
  50   int dummy4;           /**< Don't use this */
  51   int dummy5;           /**< Don't use this */
  52   int dummy6;           /**< Don't use this */
  53   int dummy7;           /**< Don't use this */
  54   int dummy8;           /**< Don't use this */
  55   int dummy9;           /**< Don't use this */
  56   int dummy10;          /**< Don't use this */
  57   int dummy11;          /**< Don't use this */
  58   int pad1;             /**< Don't use this */
  59   int pad2;             /**< Don't use this */
  60   void *pad3;           /**< Don't use this */
  61 };
  62
  63 DBusMessage* dbus_message_new               (int          message_type);
  64 DBusMessage* dbus_message_new_method_call   (const char  *service,
  65                                              const char  *path,
  66                                              const char  *interface,
  67                                              const char  *method);
  68 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
  69 DBusMessage* dbus_message_new_signal        (const char  *path,
  70                                              const char  *interface,
  71                                              const char  *name);
  72 DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
  73                                              const char  *error_name,
  74                                              const char  *error_message);
  75
  76 DBusMessage* dbus_message_copy              (const DBusMessage *message);
  77
  78 DBusMessage*  dbus_message_ref              (DBusMessage   *message);
  79 void          dbus_message_unref            (DBusMessage   *message);
  80 int           dbus_message_get_type         (DBusMessage   *message);
  81 dbus_bool_t   dbus_message_set_path         (DBusMessage   *message,
  82                                              const char    *object_path);
  83 const char*   dbus_message_get_path         (DBusMessage   *message);
  84 dbus_bool_t   dbus_message_set_interface    (DBusMessage   *message,
  85                                              const char    *interface);
  86 const char*   dbus_message_get_interface    (DBusMessage   *message);
  87 dbus_bool_t   dbus_message_set_member       (DBusMessage   *message,
  88                                              const char    *member);
  89 const char*   dbus_message_get_member       (DBusMessage   *message);
  90 dbus_bool_t   dbus_message_set_error_name   (DBusMessage   *message,
  91                                              const char    *name);
  92 const char*   dbus_message_get_error_name   (DBusMessage   *message);
  93 dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
  94                                              const char    *destination);
  95 const char*   dbus_message_get_destination  (DBusMessage   *message);
  96 dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
  97                                              const char    *sender);
  98 const char*   dbus_message_get_sender       (DBusMessage   *message);
  99 const char*   dbus_message_get_signature    (DBusMessage   *message);
 100 void          dbus_message_set_no_reply     (DBusMessage   *message,
 101                                              dbus_bool_t    no_reply);
 102 dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
 103 dbus_bool_t   dbus_message_is_method_call   (DBusMessage   *message,
 104                                              const char    *interface,
 105                                              const char    *method);
 106 dbus_bool_t   dbus_message_is_signal        (DBusMessage   *message,
 107                                              const char    *interface,
 108                                              const char    *signal_name);
 109 dbus_bool_t   dbus_message_is_error         (DBusMessage   *message,
 110                                              const char    *error_name);
 111 dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
 112                                              const char    *service);
 113 dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
 114                                              const char    *service);
 115 dbus_bool_t   dbus_message_has_signature    (DBusMessage   *message,
 116                                              const char    *signature);
 117 dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
 118 dbus_bool_t   dbus_message_set_reply_serial (DBusMessage   *message,
 119                                              dbus_uint32_t  reply_serial);
 120 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage   *message);
 121
 122 dbus_bool_t   dbus_message_get_path_decomposed (DBusMessage   *message,
 123                                                 char        ***path);
 124
 125 dbus_bool_t dbus_message_append_args          (DBusMessage     *message,
 126                                                int              first_arg_type,
 127                                                ...);
 128 dbus_bool_t dbus_message_append_args_valist   (DBusMessage     *message,
 129                                                int              first_arg_type,
 130                                                va_list          var_args);
 131 dbus_bool_t dbus_message_get_args             (DBusMessage     *message,
 132                                                DBusError       *error,
 133                                                int              first_arg_type,
 134                                                ...);
 135 dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
 136                                                DBusError       *error,
 137                                                int              first_arg_type,
 138                                                va_list          var_args);
 139 dbus_bool_t dbus_message_iter_get_args        (DBusMessageIter *iter,
 140                                                DBusError       *error,
 141                                                int              first_arg_type,
 142                                                ...);
 143 dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
 144                                                DBusError       *error,
 145                                                int              first_arg_type,
 146                                                va_list          var_args);
 147
 148
 149 void                   dbus_message_iter_init            (DBusMessage      *message,
 150                                                           DBusMessageIter  *iter);
 151 dbus_bool_t            dbus_message_iter_has_next        (DBusMessageIter  *iter);
 152 dbus_bool_t            dbus_message_iter_next            (DBusMessageIter  *iter);
 153 int                    dbus_message_iter_get_arg_type    (DBusMessageIter  *iter);
 154 int                    dbus_message_iter_get_array_type  (DBusMessageIter  *iter);
 155 unsigned char          dbus_message_iter_get_byte        (DBusMessageIter  *iter);
 156 dbus_bool_t            dbus_message_iter_get_boolean     (DBusMessageIter  *iter);
 157 dbus_int32_t           dbus_message_iter_get_int32       (DBusMessageIter  *iter);
 158 dbus_uint32_t          dbus_message_iter_get_uint32      (DBusMessageIter  *iter);
 159 #ifdef DBUS_HAVE_INT64
 160 dbus_int64_t           dbus_message_iter_get_int64       (DBusMessageIter  *iter);
 161 dbus_uint64_t          dbus_message_iter_get_uint64      (DBusMessageIter  *iter);
 162 #endif /* DBUS_HAVE_INT64 */
 163 double                 dbus_message_iter_get_double      (DBusMessageIter  *iter);
 164 char *                 dbus_message_iter_get_string      (DBusMessageIter  *iter);
 165 char *                 dbus_message_iter_get_object_path (DBusMessageIter  *iter);
 166 char *                 dbus_message_iter_get_dict_key    (DBusMessageIter  *iter);
 167 dbus_bool_t            dbus_message_iter_get_custom      (DBusMessageIter  *iter,
 168                                                           char            **name,
 169                                                           unsigned char   **value,
 170                                                           int              *len);
 171
 172 void        dbus_message_iter_init_array_iterator (DBusMessageIter   *iter,
 173                                                    DBusMessageIter   *array_iter,
 174                                                    int               *array_type);
 175 void        dbus_message_iter_init_dict_iterator  (DBusMessageIter   *iter,
 176                                                    DBusMessageIter   *dict_iter);
 177 dbus_bool_t dbus_message_iter_get_byte_array      (DBusMessageIter   *iter,
 178                                                    unsigned char    **value,
 179                                                    int               *len);
 180 dbus_bool_t dbus_message_iter_get_boolean_array   (DBusMessageIter   *iter,
 181                                                    unsigned char    **value,
 182                                                    int               *len);
 183 dbus_bool_t dbus_message_iter_get_int32_array     (DBusMessageIter   *iter,
 184                                                    dbus_int32_t     **value,
 185                                                    int               *len);
 186 dbus_bool_t dbus_message_iter_get_uint32_array    (DBusMessageIter   *iter,
 187                                                    dbus_uint32_t    **value,
 188                                                    int               *len);
 189 #ifdef DBUS_HAVE_INT64
 190 dbus_bool_t dbus_message_iter_get_int64_array     (DBusMessageIter   *iter,
 191                                                    dbus_int64_t     **value,
 192                                                    int               *len);
 193 dbus_bool_t dbus_message_iter_get_uint64_array    (DBusMessageIter   *iter,
 194                                                    dbus_uint64_t    **value,
 195                                                    int               *len);
 196 #endif /* DBUS_HAVE_INT64 */
 197 dbus_bool_t dbus_message_iter_get_double_array    (DBusMessageIter   *iter,
 198                                                    double           **value,
 199                                                    int               *len);
 200 dbus_bool_t dbus_message_iter_get_string_array    (DBusMessageIter   *iter,
 201                                                    char            ***value,
 202                                                    int               *len);
 203 dbus_bool_t dbus_message_iter_get_object_path_array (DBusMessageIter   *iter,
 204                                                      char            ***value,
 205                                                      int               *len);
 206
 207
 208 void        dbus_message_append_iter_init          (DBusMessage          *message,
 209                                                     DBusMessageIter      *iter);
 210 dbus_bool_t dbus_message_iter_append_nil           (DBusMessageIter      *iter);
 211 dbus_bool_t dbus_message_iter_append_boolean       (DBusMessageIter      *iter,
 212                                                     dbus_bool_t           value);
 213 dbus_bool_t dbus_message_iter_append_byte          (DBusMessageIter      *iter,
 214                                                     unsigned char         value);
 215 dbus_bool_t dbus_message_iter_append_int32         (DBusMessageIter      *iter,
 216                                                     dbus_int32_t          value);
 217 dbus_bool_t dbus_message_iter_append_uint32        (DBusMessageIter      *iter,
 218                                                     dbus_uint32_t         value);
 219 #ifdef DBUS_HAVE_INT64
 220 dbus_bool_t dbus_message_iter_append_int64         (DBusMessageIter      *iter,
 221                                                     dbus_int64_t          value);
 222 dbus_bool_t dbus_message_iter_append_uint64        (DBusMessageIter      *iter,
 223                                                     dbus_uint64_t         value);
 224 #endif /* DBUS_HAVE_INT64 */
 225 dbus_bool_t dbus_message_iter_append_double        (DBusMessageIter      *iter,
 226                                                     double                value);
 227 dbus_bool_t dbus_message_iter_append_string        (DBusMessageIter      *iter,
 228                                                     const char           *value);
 229 dbus_bool_t dbus_message_iter_append_custom        (DBusMessageIter      *iter,
 230                                                     const char           *name,
 231                                                     const unsigned char  *data,
 232                                                     int                   len);
 233 dbus_bool_t dbus_message_iter_append_dict_key      (DBusMessageIter      *iter,
 234                                                     const char           *value);
 235 dbus_bool_t dbus_message_iter_append_array         (DBusMessageIter      *iter,
 236                                                     DBusMessageIter      *array_iter,
 237                                                     int                   element_type);
 238 dbus_bool_t dbus_message_iter_append_dict          (DBusMessageIter      *iter,
 239                                                     DBusMessageIter      *dict_iter);
 240
 241 /* Helpers for normal types: */
 242 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter      *iter,
 243                                                     unsigned const char  *value,
 244                                                     int                   len);
 245 dbus_bool_t dbus_message_iter_append_int32_array   (DBusMessageIter      *iter,
 246                                                     const dbus_int32_t   *value,
 247                                                     int                   len);
 248 dbus_bool_t dbus_message_iter_append_uint32_array  (DBusMessageIter      *iter,
 249                                                     const dbus_uint32_t  *value,
 250                                                     int                   len);
 251 #ifdef DBUS_HAVE_INT64
 252 dbus_bool_t dbus_message_iter_append_int64_array   (DBusMessageIter      *iter,
 253                                                     const dbus_int64_t   *value,
 254                                                     int                   len);
 255 dbus_bool_t dbus_message_iter_append_uint64_array  (DBusMessageIter      *iter,
 256                                                     const dbus_uint64_t  *value,
 257                                                     int                   len);
 258 #endif /* DBUS_HAVE_INT64 */
 259 dbus_bool_t dbus_message_iter_append_double_array  (DBusMessageIter      *iter,
 260                                                     const double         *value,
 261                                                     int                   len);
 262 dbus_bool_t dbus_message_iter_append_byte_array    (DBusMessageIter      *iter,
 263                                                     unsigned const char  *value,
 264                                                     int                   len);
 265 dbus_bool_t dbus_message_iter_append_string_array  (DBusMessageIter      *iter,
 266                                                     const char          **value,
 267                                                     int                   len);
 268
 269
 270
 271 dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
 272                                            DBusMessage  *message);
 273
 274
 275 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t     *slot_p);
 276 void        dbus_message_free_data_slot     (dbus_int32_t     *slot_p);
 277 dbus_bool_t dbus_message_set_data           (DBusMessage      *message,
 278                                              dbus_int32_t      slot,
 279                                              void             *data,
 280                                              DBusFreeFunction  free_data_func);
 281 void*       dbus_message_get_data           (DBusMessage      *message,
 282                                              dbus_int32_t      slot);
 283
 284 int dbus_message_type_from_string (const char *type_str);
 285
 286 DBUS_END_DECLS;
 287
 288 #endif /* DBUS_MESSAGE_H */