williamr@2: /* -*- mode: C; c-file-style: "gnu" -*- */
williamr@2: /* dbus-message.h DBusMessage object
williamr@2:  *
williamr@2:  * Copyright (C) 2002, 2003, 2005 Red Hat Inc.
williamr@2:  * Portion Copyright © 2008 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
williamr@2:  * Licensed under the Academic Free License version 2.1
williamr@2:  * 
williamr@2:  * This program is free software; you can redistribute it and/or modify
williamr@2:  * it under the terms of the GNU General Public License as published by
williamr@2:  * the Free Software Foundation; either version 2 of the License, or
williamr@2:  * (at your option) any later version.
williamr@2:  *
williamr@2:  * This program is distributed in the hope that it will be useful,
williamr@2:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
williamr@2:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
williamr@2:  * GNU General Public License for more details.
williamr@2:  * 
williamr@2:  * You should have received a copy of the GNU General Public License
williamr@2:  * along with this program; if not, write to the Free Software
williamr@2:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
williamr@2:  *
williamr@2:  */
williamr@2: #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
williamr@2: #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
williamr@2: #endif
williamr@2: 
williamr@2: #ifndef DBUS_MESSAGE_H
williamr@2: #define DBUS_MESSAGE_H
williamr@2: 
williamr@2: #include <dbus/dbus-macros.h>
williamr@2: #include <dbus/dbus-types.h>
williamr@2: #include "dbus/dbus-arch-deps.h"
williamr@2: #include <dbus/dbus-memory.h>
williamr@2: #include <dbus/dbus-errors.h>
williamr@2: #include <stdarg.h>
williamr@2: 
williamr@2: DBUS_BEGIN_DECLS
williamr@2: 
williamr@2: /**
williamr@2:  * @addtogroup DBusMessage
williamr@2:  * @{
williamr@2:  */
williamr@2: 
williamr@2: typedef struct DBusMessage DBusMessage;
williamr@2: /** 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. */
williamr@2: typedef struct DBusMessageIter DBusMessageIter;
williamr@2: 
williamr@2: /**
williamr@2:  * DBusMessageIter struct; contains no public fields. 
williamr@2:  */
williamr@2: struct DBusMessageIter
williamr@2: { 
williamr@2:   void *dummy1;         /**< Don't use this */
williamr@2:   void *dummy2;         /**< Don't use this */
williamr@2:   dbus_uint32_t dummy3; /**< Don't use this */
williamr@2:   int dummy4;           /**< Don't use this */
williamr@2:   int dummy5;           /**< Don't use this */
williamr@2:   int dummy6;           /**< Don't use this */
williamr@2:   int dummy7;           /**< Don't use this */
williamr@2:   int dummy8;           /**< Don't use this */
williamr@2:   int dummy9;           /**< Don't use this */
williamr@2:   int dummy10;          /**< Don't use this */
williamr@2:   int dummy11;          /**< Don't use this */
williamr@2:   int pad1;             /**< Don't use this */
williamr@2:   int pad2;             /**< Don't use this */
williamr@2:   void *pad3;           /**< Don't use this */
williamr@2: };
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: DBusMessage* dbus_message_new               (int          message_type);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: DBusMessage* dbus_message_new_method_call   (const char  *bus_name,
williamr@2:                                              const char  *path,
williamr@2:                                              const char  *interface,
williamr@2:                                              const char  *method);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: DBusMessage* dbus_message_new_signal        (const char  *path,
williamr@2:                                              const char  *interface,
williamr@2:                                              const char  *name);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
williamr@2:                                              const char  *error_name,
williamr@2:                                              const char  *error_message);
williamr@2:                                              
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: DBusMessage* dbus_message_new_error_printf  (DBusMessage *reply_to,
williamr@2:                                              const char  *error_name,
williamr@2:                                              const char  *error_format,
williamr@2: 					     ...);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: DBusMessage* dbus_message_copy              (const DBusMessage *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: DBusMessage*  dbus_message_ref              (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void          dbus_message_unref            (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: int           dbus_message_get_type         (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_set_path         (DBusMessage   *message,
williamr@2:                                              const char    *object_path);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: const char*   dbus_message_get_path         (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_has_path         (DBusMessage   *message, 
williamr@2:                                              const char    *object_path);  
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_set_interface    (DBusMessage   *message,
williamr@2:                                              const char    *interface);       
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: const char*   dbus_message_get_interface    (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_has_interface    (DBusMessage   *message, 
williamr@2:                                              const char    *interface);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_set_member       (DBusMessage   *message,
williamr@2:                                              const char    *member);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: const char*   dbus_message_get_member       (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_has_member       (DBusMessage   *message, 
williamr@2:                                              const char    *member);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_set_error_name   (DBusMessage   *message,
williamr@2:                                              const char    *name);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: const char*   dbus_message_get_error_name   (DBusMessage   *message);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
williamr@2:                                              const char    *destination);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: const char*   dbus_message_get_destination  (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
williamr@2:                                              const char    *sender);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: const char*   dbus_message_get_sender       (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: const char*   dbus_message_get_signature    (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void          dbus_message_set_no_reply     (DBusMessage   *message,
williamr@2:                                              dbus_bool_t    no_reply);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_is_method_call   (DBusMessage   *message,
williamr@2:                                              const char    *interface,
williamr@2:                                              const char    *method);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_is_signal        (DBusMessage   *message,
williamr@2:                                              const char    *interface,
williamr@2:                                              const char    *signal_name);
williamr@2:                                              
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_is_error         (DBusMessage   *message,
williamr@2:                                              const char    *error_name);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
williamr@2:                                              const char    *bus_name);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
williamr@2:                                              const char    *unique_bus_name);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_has_signature    (DBusMessage   *message,
williamr@2:                                              const char    *signature);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C 
williamr@2: #endif
williamr@2: dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_set_reply_serial (DBusMessage   *message,
williamr@2:                                              dbus_uint32_t  reply_serial);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_uint32_t dbus_message_get_reply_serial (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void          dbus_message_set_auto_start   (DBusMessage   *message,
williamr@2:                                              dbus_bool_t    auto_start);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_get_auto_start   (DBusMessage   *message);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t   dbus_message_get_path_decomposed (DBusMessage   *message,
williamr@2:                                                 char        ***path);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_append_args          (DBusMessage     *message,
williamr@2: 					       int              first_arg_type,
williamr@2: 					       ...);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_append_args_valist   (DBusMessage     *message,
williamr@2: 					       int              first_arg_type,
williamr@2: 					       va_list          var_args);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_get_args             (DBusMessage     *message,
williamr@2: 					       DBusError       *error,
williamr@2: 					       int              first_arg_type,
williamr@2: 					       ...);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
williamr@2: 					       DBusError       *error,
williamr@2: 					       int              first_arg_type,
williamr@2: 					       va_list          var_args);
williamr@2: 
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_iter_init             (DBusMessage     *message,
williamr@2:                                                 DBusMessageIter *iter);
williamr@2:                                                 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_iter_has_next         (DBusMessageIter *iter);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_iter_next             (DBusMessageIter *iter);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: char*       dbus_message_iter_get_signature    (DBusMessageIter *iter);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: int         dbus_message_iter_get_arg_type     (DBusMessageIter *iter);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: int         dbus_message_iter_get_element_type (DBusMessageIter *iter);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void        dbus_message_iter_recurse          (DBusMessageIter *iter,
williamr@2:                                                 DBusMessageIter *sub);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void        dbus_message_iter_get_basic        (DBusMessageIter *iter,
williamr@2:                                                 void            *value);
williamr@2:                                                 
williamr@2: #ifndef DBUS_DISABLE_DEPRECATED
williamr@2: /* This function returns the wire protocol size of the array in bytes,
williamr@2:  * you do not want to know that probably
williamr@2:  */
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: int         dbus_message_iter_get_array_len    (DBusMessageIter *iter) DBUS_GNUC_DEPRECATED;
williamr@2: #endif
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void        dbus_message_iter_get_fixed_array  (DBusMessageIter *iter,
williamr@2:                                                 void            *value,
williamr@2:                                                 int             *n_elements);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void        dbus_message_iter_init_append        (DBusMessage     *message,
williamr@2:                                                   DBusMessageIter *iter);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_iter_append_basic       (DBusMessageIter *iter,
williamr@2:                                                   int              type,
williamr@2:                                                   const void      *value);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
williamr@2:                                                   int              element_type,
williamr@2:                                                   const void      *value,
williamr@2:                                                   int              n_elements);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_iter_open_container     (DBusMessageIter *iter,
williamr@2:                                                   int              type,
williamr@2:                                                   const char      *contained_signature,
williamr@2:                                                   DBusMessageIter *sub);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_iter_close_container    (DBusMessageIter *iter,
williamr@2:                                                   DBusMessageIter *sub);
williamr@2: 
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
williamr@2:                                            DBusMessage  *message);
williamr@2: 
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t     *slot_p);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void        dbus_message_free_data_slot     (dbus_int32_t     *slot_p);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: dbus_bool_t dbus_message_set_data           (DBusMessage      *message,
williamr@2:                                              dbus_int32_t      slot,
williamr@2:                                              void             *data,
williamr@2:                                              DBusFreeFunction  free_data_func);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: void*       dbus_message_get_data           (DBusMessage      *message,
williamr@2:                                              dbus_int32_t      slot);
williamr@2: 
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: int dbus_message_type_from_string (const char *type_str);
williamr@2: #ifdef __SYMBIAN32__
williamr@2: IMPORT_C
williamr@2: #endif
williamr@2: const char * dbus_message_type_to_string (int type);
williamr@2: 
williamr@2: /** @} */
williamr@2: 
williamr@2: DBUS_END_DECLS
williamr@2: 
williamr@2: #endif /* DBUS_MESSAGE_H */