summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-message.h
blob: 526cf97169c74fc8ec80ed8e668f4eb4227d4a5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-message.h DBusMessage object
 *
 * Copyright (C) 2002  Red Hat Inc.
 *
 * Licensed under the Academic Free License version 1.2
 * 
 * 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>
#include <dbus/dbus-types.h>
#include <dbus/dbus-arch-deps.h>
#include <dbus/dbus-memory.h>
#include <dbus/dbus-errors.h>
#include <stdarg.h>

DBUS_BEGIN_DECLS;

typedef struct DBusMessage DBusMessage;
typedef struct DBusMessageIter DBusMessageIter;

struct DBusMessageIter
{
  void *dummy1;
  void *dummy2;
  dbus_uint32_t dummy3;
  int dummy4;
  int dummy5;
  int dummy6;
  int dummy7;
  int dummy8;
  int dummy9;
  int dummy10;
  int dummy11;
  int pad1;
  int pad2;
  void *pad3;
};

DBusMessage* dbus_message_new               (int          message_type);
DBusMessage* dbus_message_new_method_call   (const char  *interface,
                                             const char  *method,
                                             const char  *destination_service);
DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
DBusMessage* dbus_message_new_signal        (const char  *interface,
                                             const char  *name);
DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
                                             const char  *error_name,
                                             const char  *error_message);

DBusMessage *dbus_message_copy              (const DBusMessage *message);

void          dbus_message_ref              (DBusMessage   *message);
void          dbus_message_unref            (DBusMessage   *message);
int           dbus_message_get_type         (DBusMessage   *message);
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,
                                             const char    *name);
const char*   dbus_message_get_error_name   (DBusMessage   *message);
dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
                                             const char    *destination);
const char*   dbus_message_get_destination  (DBusMessage   *message);
dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
                                             const char    *sender);
const char*   dbus_message_get_sender       (DBusMessage   *message);
void          dbus_message_set_no_reply     (DBusMessage   *message,
                                             dbus_bool_t    no_reply);
dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
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);
dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
                                             const char    *service);
dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
                                             const char    *service);
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);

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



void          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);
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);
#ifdef DBUS_HAVE_INT64
dbus_int64_t  dbus_message_iter_get_int64      (DBusMessageIter  *iter);
dbus_uint64_t dbus_message_iter_get_uint64     (DBusMessageIter  *iter);
#endif /* DBUS_HAVE_INT64 */
double        dbus_message_iter_get_double     (DBusMessageIter  *iter);
char *        dbus_message_iter_get_string     (DBusMessageIter  *iter);
char *        dbus_message_iter_get_dict_key   (DBusMessageIter  *iter);
dbus_bool_t   dbus_message_iter_get_named      (DBusMessageIter  *iter,
						char            **name,
						unsigned char   **value,
						int              *len);

dbus_bool_t dbus_message_iter_init_array_iterator (DBusMessageIter   *iter,
						   DBusMessageIter   *array_iter,
						   int               *array_type);
dbus_bool_t dbus_message_iter_init_dict_iterator  (DBusMessageIter   *iter,
						   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,
						   unsigned char    **value,
						   int               *len);
dbus_bool_t dbus_message_iter_get_int32_array     (DBusMessageIter   *iter,
						   dbus_int32_t     **value,
						   int               *len);
dbus_bool_t dbus_message_iter_get_uint32_array    (DBusMessageIter   *iter,
						   dbus_uint32_t    **value,
						   int               *len);
#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 */
dbus_bool_t dbus_message_iter_get_double_array    (DBusMessageIter   *iter,
						   double           **value,
						   int               *len);
dbus_bool_t dbus_message_iter_get_string_array    (DBusMessageIter   *iter,
						   char            ***value,
						   int               *len);


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);
#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 */
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);
dbus_bool_t dbus_message_iter_append_named         (DBusMessageIter      *iter,
						    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);
#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 */
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);



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


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

DBUS_END_DECLS;

#endif /* DBUS_MESSAGE_H */