dbus/dbus-message.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-message.h DBusMessage object
   3  *
   4  * Copyright (C) 2002, 2003, 2005 Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   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 /**
  43  * DBusMessageIter struct; contains no public fields
  44  */
  45 struct DBusMessageIter
  46 {
  47   void *dummy1;         /**< Don't use this */
  48   void *dummy2;         /**< Don't use this */
  49   dbus_uint32_t dummy3; /**< Don't use this */
  50   int dummy4;           /**< Don't use this */
  51   int dummy5;           /**< Don't use this */
  52   int dummy6;           /**< Don't use this */
  53   int dummy7;           /**< Don't use this */
  54   int dummy8;           /**< Don't use this */
  55   int dummy9;           /**< Don't use this */
  56   int dummy10;          /**< Don't use this */
  57   int dummy11;          /**< Don't use this */
  58   int pad1;             /**< Don't use this */
  59   int pad2;             /**< Don't use this */
  60   void *pad3;           /**< Don't use this */
  61 };
  62
  63 DBusMessage* dbus_message_new               (int          message_type);
  64 DBusMessage* dbus_message_new_method_call   (const char  *bus_name,
  65                                              const char  *path,
  66                                              const char  *interface,
  67                                              const char  *method);
  68 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
  69 DBusMessage* dbus_message_new_signal        (const char  *path,
  70                                              const char  *interface,
  71                                              const char  *name);
  72 DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
  73                                              const char  *error_name,
  74                                              const char  *error_message);
  75 DBusMessage* dbus_message_new_error_printf  (DBusMessage *reply_to,
  76                                              const char  *error_name,
  77                                              const char  *error_format,
  78                                              ...);
  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 dbus_bool_t   dbus_message_set_path         (DBusMessage   *message,
  86                                              const char    *object_path);
  87 const char*   dbus_message_get_path         (DBusMessage   *message);
  88 dbus_bool_t   dbus_message_has_path         (DBusMessage   *message,
  89                                              const char    *object_path);
  90 dbus_bool_t   dbus_message_set_interface    (DBusMessage   *message,
  91                                              const char    *interface);
  92 const char*   dbus_message_get_interface    (DBusMessage   *message);
  93 dbus_bool_t   dbus_message_has_interface    (DBusMessage   *message,
  94                                              const char    *interface);
  95 dbus_bool_t   dbus_message_set_member       (DBusMessage   *message,
  96                                              const char    *member);
  97 const char*   dbus_message_get_member       (DBusMessage   *message);
  98 dbus_bool_t   dbus_message_has_member       (DBusMessage   *message,
  99                                              const char    *member);
 100 dbus_bool_t   dbus_message_set_error_name   (DBusMessage   *message,
 101                                              const char    *name);
 102 const char*   dbus_message_get_error_name   (DBusMessage   *message);
 103 dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
 104                                              const char    *destination);
 105 const char*   dbus_message_get_destination  (DBusMessage   *message);
 106 dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
 107                                              const char    *sender);
 108 const char*   dbus_message_get_sender       (DBusMessage   *message);
 109 const char*   dbus_message_get_signature    (DBusMessage   *message);
 110 void          dbus_message_set_no_reply     (DBusMessage   *message,
 111                                              dbus_bool_t    no_reply);
 112 dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
 113 dbus_bool_t   dbus_message_is_method_call   (DBusMessage   *message,
 114                                              const char    *interface,
 115                                              const char    *method);
 116 dbus_bool_t   dbus_message_is_signal        (DBusMessage   *message,
 117                                              const char    *interface,
 118                                              const char    *signal_name);
 119 dbus_bool_t   dbus_message_is_error         (DBusMessage   *message,
 120                                              const char    *error_name);
 121 dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
 122                                              const char    *bus_name);
 123 dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
 124                                              const char    *unique_bus_name);
 125 dbus_bool_t   dbus_message_has_signature    (DBusMessage   *message,
 126                                              const char    *signature);
 127 dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
 128 dbus_bool_t   dbus_message_set_reply_serial (DBusMessage   *message,
 129                                              dbus_uint32_t  reply_serial);
 130 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage   *message);
 131
 132 void          dbus_message_set_auto_start   (DBusMessage   *message,
 133                                              dbus_bool_t    auto_start);
 134 dbus_bool_t   dbus_message_get_auto_start   (DBusMessage   *message);
 135
 136 dbus_bool_t   dbus_message_get_path_decomposed (DBusMessage   *message,
 137                                                 char        ***path);
 138
 139 dbus_bool_t dbus_message_append_args          (DBusMessage     *message,
 140                                                int              first_arg_type,
 141                                                ...);
 142 dbus_bool_t dbus_message_append_args_valist   (DBusMessage     *message,
 143                                                int              first_arg_type,
 144                                                va_list          var_args);
 145 dbus_bool_t dbus_message_get_args             (DBusMessage     *message,
 146                                                DBusError       *error,
 147                                                int              first_arg_type,
 148                                                ...);
 149 dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
 150                                                DBusError       *error,
 151                                                int              first_arg_type,
 152                                                va_list          var_args);
 153
 154
 155 dbus_bool_t dbus_message_iter_init             (DBusMessage     *message,
 156                                                 DBusMessageIter *iter);
 157 dbus_bool_t dbus_message_iter_has_next         (DBusMessageIter *iter);
 158 dbus_bool_t dbus_message_iter_next             (DBusMessageIter *iter);
 159 char*       dbus_message_iter_get_signature    (DBusMessageIter *iter);
 160 int         dbus_message_iter_get_arg_type     (DBusMessageIter *iter);
 161 int         dbus_message_iter_get_element_type (DBusMessageIter *iter);
 162 void        dbus_message_iter_recurse          (DBusMessageIter *iter,
 163                                                 DBusMessageIter *sub);
 164 void        dbus_message_iter_get_basic        (DBusMessageIter *iter,
 165                                                 void            *value);
 166 #ifndef DBUS_DISABLE_DEPRECATED
 167 /* This function returns the wire protocol size of the array in bytes,
 168  * you do not want to know that probably
 169  */
 170 int         dbus_message_iter_get_array_len    (DBusMessageIter *iter) DBUS_GNUC_DEPRECATED;
 171 #endif
 172 void        dbus_message_iter_get_fixed_array  (DBusMessageIter *iter,
 173                                                 void            *value,
 174                                                 int             *n_elements);
 175
 176
 177 void        dbus_message_iter_init_append        (DBusMessage     *message,
 178                                                   DBusMessageIter *iter);
 179 dbus_bool_t dbus_message_iter_append_basic       (DBusMessageIter *iter,
 180                                                   int              type,
 181                                                   const void      *value);
 182 dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
 183                                                   int              element_type,
 184                                                   const void      *value,
 185                                                   int              n_elements);
 186 dbus_bool_t dbus_message_iter_open_container     (DBusMessageIter *iter,
 187                                                   int              type,
 188                                                   const char      *contained_signature,
 189                                                   DBusMessageIter *sub);
 190 dbus_bool_t dbus_message_iter_close_container    (DBusMessageIter *iter,
 191                                                   DBusMessageIter *sub);
 192
 193
 194 dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
 195                                            DBusMessage  *message);
 196
 197
 198 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t     *slot_p);
 199 void        dbus_message_free_data_slot     (dbus_int32_t     *slot_p);
 200 dbus_bool_t dbus_message_set_data           (DBusMessage      *message,
 201                                              dbus_int32_t      slot,
 202                                              void             *data,
 203                                              DBusFreeFunction  free_data_func);
 204 void*       dbus_message_get_data           (DBusMessage      *message,
 205                                              dbus_int32_t      slot);
 206
 207 int dbus_message_type_from_string (const char *type_str);
 208 const char * dbus_message_type_to_string (int type);
 209
 210 DBUS_END_DECLS
 211
 212 #endif /* DBUS_MESSAGE_H */