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