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