dbus-message.h 15 KB
Newer Older
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.1
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
#endif

#ifndef DBUS_MESSAGE_H
#define DBUS_MESSAGE_H

#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 44
/**
 * DBusMessageIter struct; contains no public fields 
 */
45
struct DBusMessageIter
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
{ 
  void *dummy1;         /**< Don't use this */
  void *dummy2;         /**< Don't use this */
  dbus_uint32_t dummy3; /**< Don't use this */
  int dummy4;           /**< Don't use this */
  int dummy5;           /**< Don't use this */
  int dummy6;           /**< Don't use this */
  int dummy7;           /**< Don't use this */
  int dummy8;           /**< Don't use this */
  int dummy9;           /**< Don't use this */
  int dummy10;          /**< Don't use this */
  int dummy11;          /**< Don't use this */
  int pad1;             /**< Don't use this */
  int pad2;             /**< Don't use this */
  void *pad3;           /**< Don't use this */
61 62
};

63
DBusMessage* dbus_message_new               (int          message_type);
64 65 66 67
DBusMessage* dbus_message_new_method_call   (const char  *service,
                                             const char  *path,
                                             const char  *interface,
                                             const char  *method);
68
DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
69 70
DBusMessage* dbus_message_new_signal        (const char  *path,
                                             const char  *interface,
71
                                             const char  *name);
72 73 74
DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
                                             const char  *error_name,
                                             const char  *error_message);
75 76 77 78
DBusMessage* dbus_message_new_error_printf  (DBusMessage *reply_to,
                                             const char  *error_name,
                                             const char  *error_format,
					     ...);
79

80
DBusMessage* dbus_message_copy              (const DBusMessage *message);
81

82
DBusMessage*  dbus_message_ref              (DBusMessage   *message);
83
void          dbus_message_unref            (DBusMessage   *message);
84
int           dbus_message_get_type         (DBusMessage   *message);
85 86 87
dbus_bool_t   dbus_message_set_path         (DBusMessage   *message,
                                             const char    *object_path);
const char*   dbus_message_get_path         (DBusMessage   *message);
88 89 90 91 92 93 94
dbus_bool_t   dbus_message_set_interface    (DBusMessage   *message,
                                             const char    *interface);
const char*   dbus_message_get_interface    (DBusMessage   *message);
dbus_bool_t   dbus_message_set_member       (DBusMessage   *message,
                                             const char    *member);
const char*   dbus_message_get_member       (DBusMessage   *message);
dbus_bool_t   dbus_message_set_error_name   (DBusMessage   *message,
95
                                             const char    *name);
96
const char*   dbus_message_get_error_name   (DBusMessage   *message);
97 98
dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
                                             const char    *destination);
99
const char*   dbus_message_get_destination  (DBusMessage   *message);
100 101 102
dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
                                             const char    *sender);
const char*   dbus_message_get_sender       (DBusMessage   *message);
103
const char*   dbus_message_get_signature    (DBusMessage   *message);
104 105 106
void          dbus_message_set_no_reply     (DBusMessage   *message,
                                             dbus_bool_t    no_reply);
dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
107 108 109 110 111 112 113 114
dbus_bool_t   dbus_message_is_method_call   (DBusMessage   *message,
                                             const char    *interface,
                                             const char    *method);
dbus_bool_t   dbus_message_is_signal        (DBusMessage   *message,
                                             const char    *interface,
                                             const char    *signal_name);
dbus_bool_t   dbus_message_is_error         (DBusMessage   *message,
                                             const char    *error_name);
115
dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
116
                                             const char    *service);
117
dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
118
                                             const char    *service);
119 120
dbus_bool_t   dbus_message_has_signature    (DBusMessage   *message,
                                             const char    *signature);
121 122 123 124
dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
dbus_bool_t   dbus_message_set_reply_serial (DBusMessage   *message,
                                             dbus_uint32_t  reply_serial);
dbus_uint32_t dbus_message_get_reply_serial (DBusMessage   *message);
125

126 127 128 129
void          dbus_message_set_auto_activation (DBusMessage   *message,
						dbus_bool_t    auto_activation);
dbus_bool_t   dbus_message_get_auto_activation (DBusMessage   *message);

130 131 132
dbus_bool_t   dbus_message_get_path_decomposed (DBusMessage   *message,
                                                char        ***path);

133 134 135 136 137 138 139 140 141
dbus_bool_t dbus_message_append_args          (DBusMessage     *message,
					       int              first_arg_type,
					       ...);
dbus_bool_t dbus_message_append_args_valist   (DBusMessage     *message,
					       int              first_arg_type,
					       va_list          var_args);
dbus_bool_t dbus_message_get_args             (DBusMessage     *message,
					       DBusError       *error,
					       int              first_arg_type,
142
					       ...);
143 144 145 146 147 148 149 150 151 152 153 154 155 156
dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
					       DBusError       *error,
					       int              first_arg_type,
					       va_list          var_args);
dbus_bool_t dbus_message_iter_get_args        (DBusMessageIter *iter,
					       DBusError       *error,
					       int              first_arg_type,
					       ...);
dbus_bool_t dbus_message_iter_get_args_valist (DBusMessageIter *iter,
					       DBusError       *error,
					       int              first_arg_type,
					       va_list          var_args);


157
dbus_bool_t            dbus_message_iter_init            (DBusMessage      *message,
158 159 160 161 162 163 164 165 166
                                                          DBusMessageIter  *iter);
dbus_bool_t            dbus_message_iter_has_next        (DBusMessageIter  *iter);
dbus_bool_t            dbus_message_iter_next            (DBusMessageIter  *iter);
int                    dbus_message_iter_get_arg_type    (DBusMessageIter  *iter);
int                    dbus_message_iter_get_array_type  (DBusMessageIter  *iter);
unsigned char          dbus_message_iter_get_byte        (DBusMessageIter  *iter);
dbus_bool_t            dbus_message_iter_get_boolean     (DBusMessageIter  *iter);
dbus_int32_t           dbus_message_iter_get_int32       (DBusMessageIter  *iter);
dbus_uint32_t          dbus_message_iter_get_uint32      (DBusMessageIter  *iter);
167
#ifdef DBUS_HAVE_INT64
168 169
dbus_int64_t           dbus_message_iter_get_int64       (DBusMessageIter  *iter);
dbus_uint64_t          dbus_message_iter_get_uint64      (DBusMessageIter  *iter);
170
#endif /* DBUS_HAVE_INT64 */
171 172 173 174
double                 dbus_message_iter_get_double      (DBusMessageIter  *iter);
char *                 dbus_message_iter_get_string      (DBusMessageIter  *iter);
char *                 dbus_message_iter_get_object_path (DBusMessageIter  *iter);
char *                 dbus_message_iter_get_dict_key    (DBusMessageIter  *iter);
175
dbus_bool_t            dbus_message_iter_get_custom      (DBusMessageIter  *iter,
176 177 178
                                                          char            **name,
                                                          unsigned char   **value,
                                                          int              *len);
179

180
dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter   *iter,
181 182
						   DBusMessageIter   *array_iter,
						   int               *array_type);
183
dbus_bool_t dbus_message_iter_init_dict_iterator  (DBusMessageIter   *iter,
184 185 186 187 188
						   DBusMessageIter   *dict_iter);
dbus_bool_t dbus_message_iter_get_byte_array      (DBusMessageIter   *iter,
						   unsigned char    **value,
						   int               *len);
dbus_bool_t dbus_message_iter_get_boolean_array   (DBusMessageIter   *iter,
189 190
						   unsigned char    **value,
						   int               *len);
191
dbus_bool_t dbus_message_iter_get_int32_array     (DBusMessageIter   *iter,
192 193
						   dbus_int32_t     **value,
						   int               *len);
194
dbus_bool_t dbus_message_iter_get_uint32_array    (DBusMessageIter   *iter,
195 196
						   dbus_uint32_t    **value,
						   int               *len);
197 198 199 200 201 202 203 204
#ifdef DBUS_HAVE_INT64
dbus_bool_t dbus_message_iter_get_int64_array     (DBusMessageIter   *iter,
						   dbus_int64_t     **value,
						   int               *len);
dbus_bool_t dbus_message_iter_get_uint64_array    (DBusMessageIter   *iter,
						   dbus_uint64_t    **value,
						   int               *len);
#endif /* DBUS_HAVE_INT64 */
205
dbus_bool_t dbus_message_iter_get_double_array    (DBusMessageIter   *iter,
206 207
						   double           **value,
						   int               *len);
208
dbus_bool_t dbus_message_iter_get_string_array    (DBusMessageIter   *iter,
209 210
						   char            ***value,
						   int               *len);
211 212 213
dbus_bool_t dbus_message_iter_get_object_path_array (DBusMessageIter   *iter,
                                                     char            ***value,
                                                     int               *len);
214 215 216 217 218 219 220 221 222 223 224 225 226


void        dbus_message_append_iter_init          (DBusMessage          *message,
						    DBusMessageIter      *iter);
dbus_bool_t dbus_message_iter_append_nil           (DBusMessageIter      *iter);
dbus_bool_t dbus_message_iter_append_boolean       (DBusMessageIter      *iter,
						    dbus_bool_t           value);
dbus_bool_t dbus_message_iter_append_byte          (DBusMessageIter      *iter,
						    unsigned char         value);
dbus_bool_t dbus_message_iter_append_int32         (DBusMessageIter      *iter,
						    dbus_int32_t          value);
dbus_bool_t dbus_message_iter_append_uint32        (DBusMessageIter      *iter,
						    dbus_uint32_t         value);
227 228 229 230 231 232
#ifdef DBUS_HAVE_INT64
dbus_bool_t dbus_message_iter_append_int64         (DBusMessageIter      *iter,
						    dbus_int64_t          value);
dbus_bool_t dbus_message_iter_append_uint64        (DBusMessageIter      *iter,
						    dbus_uint64_t         value);
#endif /* DBUS_HAVE_INT64 */
233 234 235 236
dbus_bool_t dbus_message_iter_append_double        (DBusMessageIter      *iter,
						    double                value);
dbus_bool_t dbus_message_iter_append_string        (DBusMessageIter      *iter,
						    const char           *value);
237 238
dbus_bool_t dbus_message_iter_append_object_path   (DBusMessageIter      *iter,
						    const char           *value);
239
dbus_bool_t dbus_message_iter_append_custom        (DBusMessageIter      *iter,
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
						    const char           *name,
						    const unsigned char  *data,
						    int                   len);
dbus_bool_t dbus_message_iter_append_dict_key      (DBusMessageIter      *iter,
						    const char           *value);
dbus_bool_t dbus_message_iter_append_array         (DBusMessageIter      *iter,
						    DBusMessageIter      *array_iter,
						    int                   element_type);
dbus_bool_t dbus_message_iter_append_dict          (DBusMessageIter      *iter,
						    DBusMessageIter      *dict_iter);

/* Helpers for normal types: */
dbus_bool_t dbus_message_iter_append_boolean_array (DBusMessageIter      *iter,
						    unsigned const char  *value,
						    int                   len);
dbus_bool_t dbus_message_iter_append_int32_array   (DBusMessageIter      *iter,
						    const dbus_int32_t   *value,
						    int                   len);
dbus_bool_t dbus_message_iter_append_uint32_array  (DBusMessageIter      *iter,
						    const dbus_uint32_t  *value,
						    int                   len);
261 262 263 264 265 266 267 268
#ifdef DBUS_HAVE_INT64
dbus_bool_t dbus_message_iter_append_int64_array   (DBusMessageIter      *iter,
						    const dbus_int64_t   *value,
						    int                   len);
dbus_bool_t dbus_message_iter_append_uint64_array  (DBusMessageIter      *iter,
						    const dbus_uint64_t  *value,
						    int                   len);
#endif /* DBUS_HAVE_INT64 */
269 270 271 272 273 274 275 276 277
dbus_bool_t dbus_message_iter_append_double_array  (DBusMessageIter      *iter,
						    const double         *value,
						    int                   len);
dbus_bool_t dbus_message_iter_append_byte_array    (DBusMessageIter      *iter,
						    unsigned const char  *value,
						    int                   len);
dbus_bool_t dbus_message_iter_append_string_array  (DBusMessageIter      *iter,
						    const char          **value,
						    int                   len);
278 279 280
dbus_bool_t dbus_message_iter_append_object_path_array (DBusMessageIter      *iter,
							const char          **value,
							int                   len);
281

282 283 284 285 286


dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
                                           DBusMessage  *message);

287 288 289 290 291 292 293 294 295 296

dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t     *slot_p);
void        dbus_message_free_data_slot     (dbus_int32_t     *slot_p);
dbus_bool_t dbus_message_set_data           (DBusMessage      *message,
                                             dbus_int32_t      slot,
                                             void             *data,
                                             DBusFreeFunction  free_data_func);
void*       dbus_message_get_data           (DBusMessage      *message,
                                             dbus_int32_t      slot);

297
int dbus_message_type_from_string (const char *type_str);
298
const char * dbus_message_type_to_string (int type);
299

300
DBUS_END_DECLS
301 302

#endif /* DBUS_MESSAGE_H */