epoc32/include/stdapis/dbus-1.0/dbus/dbus-message.h
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/stdapis/dbus-1.0/dbus/dbus-message.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,445 @@
     1.4 +/* -*- mode: C; c-file-style: "gnu" -*- */
     1.5 +/* dbus-message.h DBusMessage object
     1.6 + *
     1.7 + * Copyright (C) 2002, 2003, 2005 Red Hat Inc.
     1.8 + * Portion Copyright © 2008 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
     1.9 + * Licensed under the Academic Free License version 2.1
    1.10 + * 
    1.11 + * This program is free software; you can redistribute it and/or modify
    1.12 + * it under the terms of the GNU General Public License as published by
    1.13 + * the Free Software Foundation; either version 2 of the License, or
    1.14 + * (at your option) any later version.
    1.15 + *
    1.16 + * This program is distributed in the hope that it will be useful,
    1.17 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.18 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.19 + * GNU General Public License for more details.
    1.20 + * 
    1.21 + * You should have received a copy of the GNU General Public License
    1.22 + * along with this program; if not, write to the Free Software
    1.23 + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    1.24 + *
    1.25 + */
    1.26 +#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
    1.27 +#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
    1.28 +#endif
    1.29 +
    1.30 +#ifndef DBUS_MESSAGE_H
    1.31 +#define DBUS_MESSAGE_H
    1.32 +
    1.33 +#include <dbus/dbus-macros.h>
    1.34 +#include <dbus/dbus-types.h>
    1.35 +#include "dbus/dbus-arch-deps.h"
    1.36 +#include <dbus/dbus-memory.h>
    1.37 +#include <dbus/dbus-errors.h>
    1.38 +#include <stdarg.h>
    1.39 +
    1.40 +DBUS_BEGIN_DECLS
    1.41 +
    1.42 +/**
    1.43 + * @addtogroup DBusMessage
    1.44 + * @{
    1.45 + */
    1.46 +
    1.47 +typedef struct DBusMessage DBusMessage;
    1.48 +/** Opaque type representing a message iterator. Can be copied by value, and contains no allocated memory so never needs to be freed and can be allocated on the stack. */
    1.49 +typedef struct DBusMessageIter DBusMessageIter;
    1.50 +
    1.51 +/**
    1.52 + * DBusMessageIter struct; contains no public fields. 
    1.53 + */
    1.54 +struct DBusMessageIter
    1.55 +{ 
    1.56 +  void *dummy1;         /**< Don't use this */
    1.57 +  void *dummy2;         /**< Don't use this */
    1.58 +  dbus_uint32_t dummy3; /**< Don't use this */
    1.59 +  int dummy4;           /**< Don't use this */
    1.60 +  int dummy5;           /**< Don't use this */
    1.61 +  int dummy6;           /**< Don't use this */
    1.62 +  int dummy7;           /**< Don't use this */
    1.63 +  int dummy8;           /**< Don't use this */
    1.64 +  int dummy9;           /**< Don't use this */
    1.65 +  int dummy10;          /**< Don't use this */
    1.66 +  int dummy11;          /**< Don't use this */
    1.67 +  int pad1;             /**< Don't use this */
    1.68 +  int pad2;             /**< Don't use this */
    1.69 +  void *pad3;           /**< Don't use this */
    1.70 +};
    1.71 +
    1.72 +#ifdef __SYMBIAN32__
    1.73 +IMPORT_C
    1.74 +#endif
    1.75 +DBusMessage* dbus_message_new               (int          message_type);
    1.76 +
    1.77 +#ifdef __SYMBIAN32__
    1.78 +IMPORT_C
    1.79 +#endif
    1.80 +DBusMessage* dbus_message_new_method_call   (const char  *bus_name,
    1.81 +                                             const char  *path,
    1.82 +                                             const char  *interface,
    1.83 +                                             const char  *method);
    1.84 +
    1.85 +#ifdef __SYMBIAN32__
    1.86 +IMPORT_C
    1.87 +#endif
    1.88 +DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
    1.89 +
    1.90 +#ifdef __SYMBIAN32__
    1.91 +IMPORT_C
    1.92 +#endif
    1.93 +DBusMessage* dbus_message_new_signal        (const char  *path,
    1.94 +                                             const char  *interface,
    1.95 +                                             const char  *name);
    1.96 +#ifdef __SYMBIAN32__
    1.97 +IMPORT_C
    1.98 +#endif
    1.99 +DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
   1.100 +                                             const char  *error_name,
   1.101 +                                             const char  *error_message);
   1.102 +                                             
   1.103 +#ifdef __SYMBIAN32__
   1.104 +IMPORT_C
   1.105 +#endif
   1.106 +DBusMessage* dbus_message_new_error_printf  (DBusMessage *reply_to,
   1.107 +                                             const char  *error_name,
   1.108 +                                             const char  *error_format,
   1.109 +					     ...);
   1.110 +
   1.111 +#ifdef __SYMBIAN32__
   1.112 +IMPORT_C
   1.113 +#endif
   1.114 +DBusMessage* dbus_message_copy              (const DBusMessage *message);
   1.115 +
   1.116 +#ifdef __SYMBIAN32__
   1.117 +IMPORT_C
   1.118 +#endif
   1.119 +DBusMessage*  dbus_message_ref              (DBusMessage   *message);
   1.120 +
   1.121 +#ifdef __SYMBIAN32__
   1.122 +IMPORT_C
   1.123 +#endif
   1.124 +void          dbus_message_unref            (DBusMessage   *message);
   1.125 +
   1.126 +#ifdef __SYMBIAN32__
   1.127 +IMPORT_C
   1.128 +#endif
   1.129 +int           dbus_message_get_type         (DBusMessage   *message);
   1.130 +
   1.131 +#ifdef __SYMBIAN32__
   1.132 +IMPORT_C
   1.133 +#endif
   1.134 +dbus_bool_t   dbus_message_set_path         (DBusMessage   *message,
   1.135 +                                             const char    *object_path);
   1.136 +#ifdef __SYMBIAN32__
   1.137 +IMPORT_C
   1.138 +#endif
   1.139 +const char*   dbus_message_get_path         (DBusMessage   *message);
   1.140 +
   1.141 +#ifdef __SYMBIAN32__
   1.142 +IMPORT_C
   1.143 +#endif
   1.144 +dbus_bool_t   dbus_message_has_path         (DBusMessage   *message, 
   1.145 +                                             const char    *object_path);  
   1.146 +#ifdef __SYMBIAN32__
   1.147 +IMPORT_C
   1.148 +#endif
   1.149 +dbus_bool_t   dbus_message_set_interface    (DBusMessage   *message,
   1.150 +                                             const char    *interface);       
   1.151 +
   1.152 +#ifdef __SYMBIAN32__
   1.153 +IMPORT_C
   1.154 +#endif
   1.155 +const char*   dbus_message_get_interface    (DBusMessage   *message);
   1.156 +
   1.157 +#ifdef __SYMBIAN32__
   1.158 +IMPORT_C
   1.159 +#endif
   1.160 +dbus_bool_t   dbus_message_has_interface    (DBusMessage   *message, 
   1.161 +                                             const char    *interface);
   1.162 +#ifdef __SYMBIAN32__
   1.163 +IMPORT_C
   1.164 +#endif
   1.165 +dbus_bool_t   dbus_message_set_member       (DBusMessage   *message,
   1.166 +                                             const char    *member);
   1.167 +
   1.168 +#ifdef __SYMBIAN32__
   1.169 +IMPORT_C
   1.170 +#endif
   1.171 +const char*   dbus_message_get_member       (DBusMessage   *message);
   1.172 +
   1.173 +#ifdef __SYMBIAN32__
   1.174 +IMPORT_C
   1.175 +#endif
   1.176 +dbus_bool_t   dbus_message_has_member       (DBusMessage   *message, 
   1.177 +                                             const char    *member);
   1.178 +#ifdef __SYMBIAN32__
   1.179 +IMPORT_C
   1.180 +#endif
   1.181 +dbus_bool_t   dbus_message_set_error_name   (DBusMessage   *message,
   1.182 +                                             const char    *name);
   1.183 +#ifdef __SYMBIAN32__
   1.184 +IMPORT_C
   1.185 +#endif
   1.186 +const char*   dbus_message_get_error_name   (DBusMessage   *message);
   1.187 +#ifdef __SYMBIAN32__
   1.188 +IMPORT_C
   1.189 +#endif
   1.190 +dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
   1.191 +                                             const char    *destination);
   1.192 +#ifdef __SYMBIAN32__
   1.193 +IMPORT_C
   1.194 +#endif
   1.195 +const char*   dbus_message_get_destination  (DBusMessage   *message);
   1.196 +
   1.197 +#ifdef __SYMBIAN32__
   1.198 +IMPORT_C
   1.199 +#endif
   1.200 +dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
   1.201 +                                             const char    *sender);
   1.202 +#ifdef __SYMBIAN32__
   1.203 +IMPORT_C
   1.204 +#endif
   1.205 +const char*   dbus_message_get_sender       (DBusMessage   *message);
   1.206 +
   1.207 +#ifdef __SYMBIAN32__
   1.208 +IMPORT_C
   1.209 +#endif
   1.210 +const char*   dbus_message_get_signature    (DBusMessage   *message);
   1.211 +
   1.212 +#ifdef __SYMBIAN32__
   1.213 +IMPORT_C
   1.214 +#endif
   1.215 +void          dbus_message_set_no_reply     (DBusMessage   *message,
   1.216 +                                             dbus_bool_t    no_reply);
   1.217 +#ifdef __SYMBIAN32__
   1.218 +IMPORT_C
   1.219 +#endif
   1.220 +dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
   1.221 +
   1.222 +#ifdef __SYMBIAN32__
   1.223 +IMPORT_C
   1.224 +#endif
   1.225 +dbus_bool_t   dbus_message_is_method_call   (DBusMessage   *message,
   1.226 +                                             const char    *interface,
   1.227 +                                             const char    *method);
   1.228 +#ifdef __SYMBIAN32__
   1.229 +IMPORT_C
   1.230 +#endif
   1.231 +dbus_bool_t   dbus_message_is_signal        (DBusMessage   *message,
   1.232 +                                             const char    *interface,
   1.233 +                                             const char    *signal_name);
   1.234 +                                             
   1.235 +#ifdef __SYMBIAN32__
   1.236 +IMPORT_C
   1.237 +#endif
   1.238 +dbus_bool_t   dbus_message_is_error         (DBusMessage   *message,
   1.239 +                                             const char    *error_name);
   1.240 +#ifdef __SYMBIAN32__
   1.241 +IMPORT_C
   1.242 +#endif
   1.243 +dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
   1.244 +                                             const char    *bus_name);
   1.245 +#ifdef __SYMBIAN32__
   1.246 +IMPORT_C
   1.247 +#endif
   1.248 +dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
   1.249 +                                             const char    *unique_bus_name);
   1.250 +#ifdef __SYMBIAN32__
   1.251 +IMPORT_C
   1.252 +#endif
   1.253 +dbus_bool_t   dbus_message_has_signature    (DBusMessage   *message,
   1.254 +                                             const char    *signature);
   1.255 +#ifdef __SYMBIAN32__
   1.256 +IMPORT_C 
   1.257 +#endif
   1.258 +dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
   1.259 +#ifdef __SYMBIAN32__
   1.260 +IMPORT_C
   1.261 +#endif
   1.262 +dbus_bool_t   dbus_message_set_reply_serial (DBusMessage   *message,
   1.263 +                                             dbus_uint32_t  reply_serial);
   1.264 +
   1.265 +#ifdef __SYMBIAN32__
   1.266 +IMPORT_C
   1.267 +#endif
   1.268 +dbus_uint32_t dbus_message_get_reply_serial (DBusMessage   *message);
   1.269 +
   1.270 +#ifdef __SYMBIAN32__
   1.271 +IMPORT_C
   1.272 +#endif
   1.273 +void          dbus_message_set_auto_start   (DBusMessage   *message,
   1.274 +                                             dbus_bool_t    auto_start);
   1.275 +#ifdef __SYMBIAN32__
   1.276 +IMPORT_C
   1.277 +#endif
   1.278 +dbus_bool_t   dbus_message_get_auto_start   (DBusMessage   *message);
   1.279 +
   1.280 +#ifdef __SYMBIAN32__
   1.281 +IMPORT_C
   1.282 +#endif
   1.283 +dbus_bool_t   dbus_message_get_path_decomposed (DBusMessage   *message,
   1.284 +                                                char        ***path);
   1.285 +
   1.286 +#ifdef __SYMBIAN32__
   1.287 +IMPORT_C
   1.288 +#endif
   1.289 +dbus_bool_t dbus_message_append_args          (DBusMessage     *message,
   1.290 +					       int              first_arg_type,
   1.291 +					       ...);
   1.292 +#ifdef __SYMBIAN32__
   1.293 +IMPORT_C
   1.294 +#endif
   1.295 +dbus_bool_t dbus_message_append_args_valist   (DBusMessage     *message,
   1.296 +					       int              first_arg_type,
   1.297 +					       va_list          var_args);
   1.298 +
   1.299 +#ifdef __SYMBIAN32__
   1.300 +IMPORT_C
   1.301 +#endif
   1.302 +dbus_bool_t dbus_message_get_args             (DBusMessage     *message,
   1.303 +					       DBusError       *error,
   1.304 +					       int              first_arg_type,
   1.305 +					       ...);
   1.306 +#ifdef __SYMBIAN32__
   1.307 +IMPORT_C
   1.308 +#endif
   1.309 +dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
   1.310 +					       DBusError       *error,
   1.311 +					       int              first_arg_type,
   1.312 +					       va_list          var_args);
   1.313 +
   1.314 +
   1.315 +#ifdef __SYMBIAN32__
   1.316 +IMPORT_C
   1.317 +#endif
   1.318 +dbus_bool_t dbus_message_iter_init             (DBusMessage     *message,
   1.319 +                                                DBusMessageIter *iter);
   1.320 +                                                
   1.321 +#ifdef __SYMBIAN32__
   1.322 +IMPORT_C
   1.323 +#endif
   1.324 +dbus_bool_t dbus_message_iter_has_next         (DBusMessageIter *iter);
   1.325 +
   1.326 +#ifdef __SYMBIAN32__
   1.327 +IMPORT_C
   1.328 +#endif
   1.329 +dbus_bool_t dbus_message_iter_next             (DBusMessageIter *iter);
   1.330 +
   1.331 +#ifdef __SYMBIAN32__
   1.332 +IMPORT_C
   1.333 +#endif
   1.334 +char*       dbus_message_iter_get_signature    (DBusMessageIter *iter);
   1.335 +
   1.336 +#ifdef __SYMBIAN32__
   1.337 +IMPORT_C
   1.338 +#endif
   1.339 +int         dbus_message_iter_get_arg_type     (DBusMessageIter *iter);
   1.340 +
   1.341 +#ifdef __SYMBIAN32__
   1.342 +IMPORT_C
   1.343 +#endif
   1.344 +int         dbus_message_iter_get_element_type (DBusMessageIter *iter);
   1.345 +
   1.346 +#ifdef __SYMBIAN32__
   1.347 +IMPORT_C
   1.348 +#endif
   1.349 +void        dbus_message_iter_recurse          (DBusMessageIter *iter,
   1.350 +                                                DBusMessageIter *sub);
   1.351 +#ifdef __SYMBIAN32__
   1.352 +IMPORT_C
   1.353 +#endif
   1.354 +void        dbus_message_iter_get_basic        (DBusMessageIter *iter,
   1.355 +                                                void            *value);
   1.356 +                                                
   1.357 +#ifndef DBUS_DISABLE_DEPRECATED
   1.358 +/* This function returns the wire protocol size of the array in bytes,
   1.359 + * you do not want to know that probably
   1.360 + */
   1.361 +
   1.362 +#ifdef __SYMBIAN32__
   1.363 +IMPORT_C
   1.364 +#endif
   1.365 +int         dbus_message_iter_get_array_len    (DBusMessageIter *iter) DBUS_GNUC_DEPRECATED;
   1.366 +#endif
   1.367 +
   1.368 +#ifdef __SYMBIAN32__
   1.369 +IMPORT_C
   1.370 +#endif
   1.371 +void        dbus_message_iter_get_fixed_array  (DBusMessageIter *iter,
   1.372 +                                                void            *value,
   1.373 +                                                int             *n_elements);
   1.374 +
   1.375 +#ifdef __SYMBIAN32__
   1.376 +IMPORT_C
   1.377 +#endif
   1.378 +void        dbus_message_iter_init_append        (DBusMessage     *message,
   1.379 +                                                  DBusMessageIter *iter);
   1.380 +#ifdef __SYMBIAN32__
   1.381 +IMPORT_C
   1.382 +#endif
   1.383 +dbus_bool_t dbus_message_iter_append_basic       (DBusMessageIter *iter,
   1.384 +                                                  int              type,
   1.385 +                                                  const void      *value);
   1.386 +#ifdef __SYMBIAN32__
   1.387 +IMPORT_C
   1.388 +#endif
   1.389 +dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
   1.390 +                                                  int              element_type,
   1.391 +                                                  const void      *value,
   1.392 +                                                  int              n_elements);
   1.393 +#ifdef __SYMBIAN32__
   1.394 +IMPORT_C
   1.395 +#endif
   1.396 +dbus_bool_t dbus_message_iter_open_container     (DBusMessageIter *iter,
   1.397 +                                                  int              type,
   1.398 +                                                  const char      *contained_signature,
   1.399 +                                                  DBusMessageIter *sub);
   1.400 +#ifdef __SYMBIAN32__
   1.401 +IMPORT_C
   1.402 +#endif
   1.403 +dbus_bool_t dbus_message_iter_close_container    (DBusMessageIter *iter,
   1.404 +                                                  DBusMessageIter *sub);
   1.405 +
   1.406 +
   1.407 +#ifdef __SYMBIAN32__
   1.408 +IMPORT_C
   1.409 +#endif
   1.410 +dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
   1.411 +                                           DBusMessage  *message);
   1.412 +
   1.413 +
   1.414 +#ifdef __SYMBIAN32__
   1.415 +IMPORT_C
   1.416 +#endif
   1.417 +dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t     *slot_p);
   1.418 +#ifdef __SYMBIAN32__
   1.419 +IMPORT_C
   1.420 +#endif
   1.421 +void        dbus_message_free_data_slot     (dbus_int32_t     *slot_p);
   1.422 +#ifdef __SYMBIAN32__
   1.423 +IMPORT_C
   1.424 +#endif
   1.425 +dbus_bool_t dbus_message_set_data           (DBusMessage      *message,
   1.426 +                                             dbus_int32_t      slot,
   1.427 +                                             void             *data,
   1.428 +                                             DBusFreeFunction  free_data_func);
   1.429 +#ifdef __SYMBIAN32__
   1.430 +IMPORT_C
   1.431 +#endif
   1.432 +void*       dbus_message_get_data           (DBusMessage      *message,
   1.433 +                                             dbus_int32_t      slot);
   1.434 +
   1.435 +#ifdef __SYMBIAN32__
   1.436 +IMPORT_C
   1.437 +#endif
   1.438 +int dbus_message_type_from_string (const char *type_str);
   1.439 +#ifdef __SYMBIAN32__
   1.440 +IMPORT_C
   1.441 +#endif
   1.442 +const char * dbus_message_type_to_string (int type);
   1.443 +
   1.444 +/** @} */
   1.445 +
   1.446 +DBUS_END_DECLS
   1.447 +
   1.448 +#endif /* DBUS_MESSAGE_H */