dbus-message.h 11.8 KB
Newer Older
1
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
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 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 40 41 42 43
/**
 * @addtogroup DBusMessage
 * @{
 */

44
typedef struct DBusMessage DBusMessage;
45
/** 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. */
46
typedef struct DBusMessageIter DBusMessageIter;
47

48
/**
49
 * DBusMessageIter struct; contains no public fields. 
50
 */
51
struct DBusMessageIter
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
{ 
  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 */
67 68
};

69
DBusMessage* dbus_message_new               (int          message_type);
70
DBusMessage* dbus_message_new_method_call   (const char  *bus_name,
71 72 73
                                             const char  *path,
                                             const char  *interface,
                                             const char  *method);
74
DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
75 76
DBusMessage* dbus_message_new_signal        (const char  *path,
                                             const char  *interface,
77
                                             const char  *name);
78 79 80
DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
                                             const char  *error_name,
                                             const char  *error_message);
81 82 83 84
DBusMessage* dbus_message_new_error_printf  (DBusMessage *reply_to,
                                             const char  *error_name,
                                             const char  *error_format,
					     ...);
85

86
DBusMessage* dbus_message_copy              (const DBusMessage *message);
87

88
DBusMessage*  dbus_message_ref              (DBusMessage   *message);
89
void          dbus_message_unref            (DBusMessage   *message);
90
int           dbus_message_get_type         (DBusMessage   *message);
91 92 93
dbus_bool_t   dbus_message_set_path         (DBusMessage   *message,
                                             const char    *object_path);
const char*   dbus_message_get_path         (DBusMessage   *message);
John Palmieri's avatar
John Palmieri committed
94 95
dbus_bool_t   dbus_message_has_path         (DBusMessage   *message, 
                                             const char    *object_path);  
96
dbus_bool_t   dbus_message_set_interface    (DBusMessage   *message,
John Palmieri's avatar
John Palmieri committed
97
                                             const char    *interface);       
98
const char*   dbus_message_get_interface    (DBusMessage   *message);
John Palmieri's avatar
John Palmieri committed
99 100
dbus_bool_t   dbus_message_has_interface    (DBusMessage   *message, 
                                             const char    *interface);
101 102 103
dbus_bool_t   dbus_message_set_member       (DBusMessage   *message,
                                             const char    *member);
const char*   dbus_message_get_member       (DBusMessage   *message);
John Palmieri's avatar
John Palmieri committed
104 105
dbus_bool_t   dbus_message_has_member       (DBusMessage   *message, 
                                             const char    *member);
106
dbus_bool_t   dbus_message_set_error_name   (DBusMessage   *message,
107
                                             const char    *name);
108
const char*   dbus_message_get_error_name   (DBusMessage   *message);
109 110
dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
                                             const char    *destination);
111
const char*   dbus_message_get_destination  (DBusMessage   *message);
112 113 114
dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
                                             const char    *sender);
const char*   dbus_message_get_sender       (DBusMessage   *message);
115
const char*   dbus_message_get_signature    (DBusMessage   *message);
116 117 118
void          dbus_message_set_no_reply     (DBusMessage   *message,
                                             dbus_bool_t    no_reply);
dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
119 120 121 122 123 124 125 126
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);
127
dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
128
                                             const char    *bus_name);
129
dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
130
                                             const char    *unique_bus_name);
131 132
dbus_bool_t   dbus_message_has_signature    (DBusMessage   *message,
                                             const char    *signature);
133
dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
134 135
void          dbus_message_set_serial       (DBusMessage   *message, 
                                             dbus_uint32_t  serial);
136 137 138
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);
139

140 141 142
void          dbus_message_set_auto_start   (DBusMessage   *message,
                                             dbus_bool_t    auto_start);
dbus_bool_t   dbus_message_get_auto_start   (DBusMessage   *message);
143

144 145 146
dbus_bool_t   dbus_message_get_path_decomposed (DBusMessage   *message,
                                                char        ***path);

147 148 149 150 151 152 153 154 155
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,
156
					       ...);
157 158 159 160 161 162
dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
					       DBusError       *error,
					       int              first_arg_type,
					       va_list          var_args);


163 164 165 166
dbus_bool_t dbus_message_iter_init             (DBusMessage     *message,
                                                DBusMessageIter *iter);
dbus_bool_t dbus_message_iter_has_next         (DBusMessageIter *iter);
dbus_bool_t dbus_message_iter_next             (DBusMessageIter *iter);
167
char*       dbus_message_iter_get_signature    (DBusMessageIter *iter);
168 169 170 171 172 173
int         dbus_message_iter_get_arg_type     (DBusMessageIter *iter);
int         dbus_message_iter_get_element_type (DBusMessageIter *iter);
void        dbus_message_iter_recurse          (DBusMessageIter *iter,
                                                DBusMessageIter *sub);
void        dbus_message_iter_get_basic        (DBusMessageIter *iter,
                                                void            *value);
174 175 176 177
#ifndef DBUS_DISABLE_DEPRECATED
/* This function returns the wire protocol size of the array in bytes,
 * you do not want to know that probably
 */
178
DBUS_DEPRECATED int         dbus_message_iter_get_array_len    (DBusMessageIter *iter);
179
#endif
180 181 182
void        dbus_message_iter_get_fixed_array  (DBusMessageIter *iter,
                                                void            *value,
                                                int             *n_elements);
183

184 185

void        dbus_message_iter_init_append        (DBusMessage     *message,
186 187 188 189 190 191 192 193 194 195 196 197 198 199
                                                  DBusMessageIter *iter);
dbus_bool_t dbus_message_iter_append_basic       (DBusMessageIter *iter,
                                                  int              type,
                                                  const void      *value);
dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
                                                  int              element_type,
                                                  const void      *value,
                                                  int              n_elements);
dbus_bool_t dbus_message_iter_open_container     (DBusMessageIter *iter,
                                                  int              type,
                                                  const char      *contained_signature,
                                                  DBusMessageIter *sub);
dbus_bool_t dbus_message_iter_close_container    (DBusMessageIter *iter,
                                                  DBusMessageIter *sub);
200 201
void        dbus_message_iter_abandon_container  (DBusMessageIter *iter,
                                                  DBusMessageIter *sub);
202

203
void dbus_message_lock    (DBusMessage  *message);
204 205 206 207

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

208 209 210 211 212 213 214 215 216 217

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);

218 219 220 221 222 223 224 225 226
int         dbus_message_type_from_string (const char *type_str);
const char* dbus_message_type_to_string   (int type);

dbus_bool_t  dbus_message_marshal   (DBusMessage  *msg,
                                     char        **marshalled_data_p,
                                     int          *len_p);
DBusMessage* dbus_message_demarshal (const char *str,
                                     int         len,
                                     DBusError  *error);
227

228 229 230
int          dbus_message_demarshal_bytes_needed (const char *str, 
                                                  int len);

231 232
/** @} */

233
DBUS_END_DECLS
234 235

#endif /* DBUS_MESSAGE_H */