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 <stdarg.h>
  33
  34 DBUS_BEGIN_DECLS;
  35
  36 typedef struct DBusMessage DBusMessage;
  37 typedef struct DBusMessageIter DBusMessageIter;
  38
  39 struct DBusMessageIter
  40 {
  41   void *dummy1;
  42   void *dummy2;
  43   dbus_uint32_t dummy3;
  44   int dummy4;
  45   int dummy5;
  46   int dummy6;
  47   int dummy7;
  48   int dummy8;
  49   int dummy9;
  50   int dummy10;
  51   int dummy11;
  52   int pad1;
  53   int pad2;
  54   void *pad3;
  55 };
  56
  57
  58 DBusMessage* dbus_message_new              (const char        *service,
  59                                             const char        *name);
  60 DBusMessage* dbus_message_new_reply        (DBusMessage       *original_message);
  61 DBusMessage* dbus_message_new_error_reply  (DBusMessage       *original_message,
  62                                             const char        *error_name,
  63                                             const char        *error_message);
  64 DBusMessage *dbus_message_copy             (const DBusMessage *message);
  65
  66 void         dbus_message_ref   (DBusMessage *message);
  67 void         dbus_message_unref (DBusMessage *message);
  68
  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_int32_t dbus_message_get_serial       (DBusMessage  *message);
  84 dbus_bool_t  dbus_message_set_reply_serial (DBusMessage  *message,
  85                                             dbus_int32_t  reply_serial);
  86 dbus_int32_t dbus_message_get_reply_serial (DBusMessage  *message);
  87
  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 double        dbus_message_iter_get_double     (DBusMessageIter  *iter);
 125 char *        dbus_message_iter_get_string     (DBusMessageIter  *iter);
 126 char *        dbus_message_iter_get_dict_key   (DBusMessageIter  *iter);
 127 dbus_bool_t   dbus_message_iter_get_named      (DBusMessageIter  *iter,
 128                                                 char            **name,
 129                                                 unsigned char   **value,
 130                                                 int              *len);
 131
 132 dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter   *iter,
 133                                                    DBusMessageIter   *array_iter,
 134                                                    int               *array_type);
 135 dbus_bool_t dbus_message_iter_init_dict_iterator  (DBusMessageIter   *iter,
 136                                                    DBusMessageIter   *dict_iter);
 137 dbus_bool_t dbus_message_iter_get_byte_array      (DBusMessageIter   *iter,
 138                                                    unsigned char    **value,
 139                                                    int               *len);
 140 dbus_bool_t dbus_message_iter_get_boolean_array   (DBusMessageIter   *iter,
 141                                                    unsigned char    **value,
 142                                                    int               *len);
 143 dbus_bool_t dbus_message_iter_get_int32_array     (DBusMessageIter   *iter,
 144                                                    dbus_int32_t     **value,
 145                                                    int               *len);
 146 dbus_bool_t dbus_message_iter_get_uint32_array    (DBusMessageIter   *iter,
 147                                                    dbus_uint32_t    **value,
 148                                                    int               *len);
 149 dbus_bool_t dbus_message_iter_get_double_array    (DBusMessageIter   *iter,
 150                                                    double           **value,
 151                                                    int               *len);
 152 dbus_bool_t dbus_message_iter_get_string_array    (DBusMessageIter   *iter,
 153                                                    char            ***value,
 154                                                    int               *len);
 155
 156
 157 void        dbus_message_append_iter_init          (DBusMessage          *message,
 158                                                     DBusMessageIter      *iter);
 159 dbus_bool_t dbus_message_iter_append_nil           (DBusMessageIter      *iter);
 160 dbus_bool_t dbus_message_iter_append_boolean       (DBusMessageIter      *iter,
 161                                                     dbus_bool_t           value);
 162 dbus_bool_t dbus_message_iter_append_byte          (DBusMessageIter      *iter,
 163                                                     unsigned char         value);
 164 dbus_bool_t dbus_message_iter_append_int32         (DBusMessageIter      *iter,
 165                                                     dbus_int32_t          value);
 166 dbus_bool_t dbus_message_iter_append_uint32        (DBusMessageIter      *iter,
 167                                                     dbus_uint32_t         value);
 168 dbus_bool_t dbus_message_iter_append_double        (DBusMessageIter      *iter,
 169                                                     double                value);
 170 dbus_bool_t dbus_message_iter_append_string        (DBusMessageIter      *iter,
 171                                                     const char           *value);
 172 dbus_bool_t dbus_message_iter_append_named         (DBusMessageIter      *iter,
 173                                                     const char           *name,
 174                                                     const unsigned char  *data,
 175                                                     int                   len);
 176 dbus_bool_t dbus_message_iter_append_dict_key      (DBusMessageIter      *iter,
 177                                                     const char           *value);
 178 dbus_bool_t dbus_message_iter_append_array         (DBusMessageIter      *iter,
 179                                                     DBusMessageIter      *array_iter,
 180                                                     int                   element_type);
 181 dbus_bool_t dbus_message_iter_append_dict          (DBusMessageIter      *iter,
 182                                                     DBusMessageIter      *dict_iter);
 183
 184 /* Helpers for normal types: */
 185 dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter      *iter,
 186                                                     unsigned const char  *value,
 187                                                     int                   len);
 188 dbus_bool_t dbus_message_iter_append_int32_array   (DBusMessageIter      *iter,
 189                                                     const dbus_int32_t   *value,
 190                                                     int                   len);
 191 dbus_bool_t dbus_message_iter_append_uint32_array  (DBusMessageIter      *iter,
 192                                                     const dbus_uint32_t  *value,
 193                                                     int                   len);
 194 dbus_bool_t dbus_message_iter_append_double_array  (DBusMessageIter      *iter,
 195                                                     const double         *value,
 196                                                     int                   len);
 197 dbus_bool_t dbus_message_iter_append_byte_array    (DBusMessageIter      *iter,
 198                                                     unsigned const char  *value,
 199                                                     int                   len);
 200 dbus_bool_t dbus_message_iter_append_string_array  (DBusMessageIter      *iter,
 201                                                     const char          **value,
 202                                                     int                   len);
 203
 204
 205
 206 dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
 207                                            DBusMessage  *message);
 208
 209 DBUS_END_DECLS;
 210
 211 #endif /* DBUS_MESSAGE_H */