D-Bus 1.13.18

dbus-message.h
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 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
44 typedef struct DBusMessage DBusMessage;
56 typedef struct DBusMessageIter DBusMessageIter;
57
61 struct DBusMessageIter
62 {
63 void *dummy1;
64 void *dummy2;
65 dbus_uint32_t dummy3;
66 int dummy4;
67 int dummy5;
68 int dummy6;
69 int dummy7;
70 int dummy8;
71 int dummy9;
72 int dummy10;
73 int dummy11;
74 int pad1;
75 void *pad2;
76 void *pad3;
77 };
78
83 #define DBUS_MESSAGE_ITER_INIT_CLOSED \
84 { \
85 NULL, /* dummy1 */ \
86 NULL, /* dummy2 */ \
87 0, /* dummy3 */ \
88 0, /* dummy4 */ \
89 0, /* dummy5 */ \
90 0, /* dummy6 */ \
91 0, /* dummy7 */ \
92 0, /* dummy8 */ \
93 0, /* dummy9 */ \
94 0, /* dummy10 */ \
95 0, /* dummy11 */ \
96 0, /* pad1 */ \
97 NULL, /* pad2 */ \
98 NULL /* pad3 */ \
99 }
100
101 DBUS_EXPORT
102 DBusMessage* dbus_message_new (int message_type);
103 DBUS_EXPORT
104 DBusMessage* dbus_message_new_method_call (const char *bus_name,
105 const char *path,
106 const char *iface,
107 const char *method);
108 DBUS_EXPORT
109 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
110 DBUS_EXPORT
111 DBusMessage* dbus_message_new_signal (const char *path,
112 const char *iface,
113 const char *name);
114 DBUS_EXPORT
115 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
116 const char *error_name,
117 const char *error_message);
118 DBUS_EXPORT
119 DBusMessage* dbus_message_new_error_printf (DBusMessage *reply_to,
120 const char *error_name,
121 const char *error_format,
122 ...) _DBUS_GNUC_PRINTF (3, 4);
123
124 DBUS_EXPORT
125 DBusMessage* dbus_message_copy (const DBusMessage *message);
126
127 DBUS_EXPORT
128 DBusMessage* dbus_message_ref (DBusMessage *message);
129 DBUS_EXPORT
130 void dbus_message_unref (DBusMessage *message);
131 DBUS_EXPORT
132 int dbus_message_get_type (DBusMessage *message);
133 DBUS_EXPORT
134 dbus_bool_t dbus_message_set_path (DBusMessage *message,
135 const char *object_path);
136 DBUS_EXPORT
137 const char* dbus_message_get_path (DBusMessage *message);
138 DBUS_EXPORT
139 dbus_bool_t dbus_message_has_path (DBusMessage *message,
140 const char *object_path);
141 DBUS_EXPORT
142 dbus_bool_t dbus_message_set_interface (DBusMessage *message,
143 const char *iface);
144 DBUS_EXPORT
145 const char* dbus_message_get_interface (DBusMessage *message);
146 DBUS_EXPORT
147 dbus_bool_t dbus_message_has_interface (DBusMessage *message,
148 const char *iface);
149 DBUS_EXPORT
150 dbus_bool_t dbus_message_set_member (DBusMessage *message,
151 const char *member);
152 DBUS_EXPORT
153 const char* dbus_message_get_member (DBusMessage *message);
154 DBUS_EXPORT
155 dbus_bool_t dbus_message_has_member (DBusMessage *message,
156 const char *member);
157 DBUS_EXPORT
158 dbus_bool_t dbus_message_set_error_name (DBusMessage *message,
159 const char *name);
160 DBUS_EXPORT
161 const char* dbus_message_get_error_name (DBusMessage *message);
162 DBUS_EXPORT
163 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
164 const char *destination);
165 DBUS_EXPORT
166 const char* dbus_message_get_destination (DBusMessage *message);
167 DBUS_EXPORT
168 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
169 const char *sender);
170 DBUS_EXPORT
171 const char* dbus_message_get_sender (DBusMessage *message);
172 DBUS_EXPORT
173 const char* dbus_message_get_signature (DBusMessage *message);
174 DBUS_EXPORT
175 void dbus_message_set_no_reply (DBusMessage *message,
176 dbus_bool_t no_reply);
177 DBUS_EXPORT
178 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
179 DBUS_EXPORT
180 dbus_bool_t dbus_message_is_method_call (DBusMessage *message,
181 const char *iface,
182 const char *method);
183 DBUS_EXPORT
184 dbus_bool_t dbus_message_is_signal (DBusMessage *message,
185 const char *iface,
186 const char *signal_name);
187 DBUS_EXPORT
188 dbus_bool_t dbus_message_is_error (DBusMessage *message,
189 const char *error_name);
190 DBUS_EXPORT
191 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
192 const char *bus_name);
193 DBUS_EXPORT
194 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
195 const char *unique_bus_name);
196 DBUS_EXPORT
197 dbus_bool_t dbus_message_has_signature (DBusMessage *message,
198 const char *signature);
199 DBUS_EXPORT
200 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
201 DBUS_EXPORT
202 void dbus_message_set_serial (DBusMessage *message,
203 dbus_uint32_t serial);
204 DBUS_EXPORT
205 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
206 dbus_uint32_t reply_serial);
207 DBUS_EXPORT
208 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
209
210 DBUS_EXPORT
211 void dbus_message_set_auto_start (DBusMessage *message,
212 dbus_bool_t auto_start);
213 DBUS_EXPORT
214 dbus_bool_t dbus_message_get_auto_start (DBusMessage *message);
215
216 DBUS_EXPORT
217 dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message,
218 char ***path);
219
220 DBUS_EXPORT
221 const char *dbus_message_get_container_instance (DBusMessage *message);
222 DBUS_EXPORT
223 dbus_bool_t dbus_message_set_container_instance (DBusMessage *message,
224 const char *object_path);
225
226 DBUS_EXPORT
227 dbus_bool_t dbus_message_append_args (DBusMessage *message,
228 int first_arg_type,
229 ...);
230 DBUS_EXPORT
231 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
232 int first_arg_type,
233 va_list var_args);
234 DBUS_EXPORT
235 dbus_bool_t dbus_message_get_args (DBusMessage *message,
236 DBusError *error,
237 int first_arg_type,
238 ...);
239 DBUS_EXPORT
240 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
241 DBusError *error,
242 int first_arg_type,
243 va_list var_args);
244
245 DBUS_EXPORT
246 dbus_bool_t dbus_message_contains_unix_fds (DBusMessage *message);
247
248 DBUS_EXPORT
249 void dbus_message_iter_init_closed (DBusMessageIter *iter);
250 DBUS_EXPORT
251 dbus_bool_t dbus_message_iter_init (DBusMessage *message,
252 DBusMessageIter *iter);
253 DBUS_EXPORT
254 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
255 DBUS_EXPORT
256 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
257 DBUS_EXPORT
258 char* dbus_message_iter_get_signature (DBusMessageIter *iter);
259 DBUS_EXPORT
260 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
261 DBUS_EXPORT
262 int dbus_message_iter_get_element_type (DBusMessageIter *iter);
263 DBUS_EXPORT
264 void dbus_message_iter_recurse (DBusMessageIter *iter,
265 DBusMessageIter *sub);
266 DBUS_EXPORT
267 void dbus_message_iter_get_basic (DBusMessageIter *iter,
268 void *value);
269 DBUS_EXPORT
270 int dbus_message_iter_get_element_count(DBusMessageIter *iter);
271
272 #ifndef DBUS_DISABLE_DEPRECATED
273 /* This function returns the wire protocol size of the array in bytes,
274 * you do not want to know that probably
275 */
276 DBUS_EXPORT
277 DBUS_DEPRECATED int dbus_message_iter_get_array_len (DBusMessageIter *iter);
278 #endif
279 DBUS_EXPORT
280 void dbus_message_iter_get_fixed_array (DBusMessageIter *iter,
281 void *value,
282 int *n_elements);
283
284
285 DBUS_EXPORT
286 void dbus_message_iter_init_append (DBusMessage *message,
287 DBusMessageIter *iter);
288 DBUS_EXPORT
289 dbus_bool_t dbus_message_iter_append_basic (DBusMessageIter *iter,
290 int type,
291 const void *value);
292 DBUS_EXPORT
293 dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
294 int element_type,
295 const void *value,
296 int n_elements);
297 DBUS_EXPORT
298 dbus_bool_t dbus_message_iter_open_container (DBusMessageIter *iter,
299 int type,
300 const char *contained_signature,
301 DBusMessageIter *sub);
302 DBUS_EXPORT
303 dbus_bool_t dbus_message_iter_close_container (DBusMessageIter *iter,
304 DBusMessageIter *sub);
305 DBUS_EXPORT
306 void dbus_message_iter_abandon_container (DBusMessageIter *iter,
307 DBusMessageIter *sub);
308
309 DBUS_EXPORT
310 void dbus_message_iter_abandon_container_if_open (DBusMessageIter *iter,
311 DBusMessageIter *sub);
312
313 DBUS_EXPORT
314 void dbus_message_lock (DBusMessage *message);
315
316 DBUS_EXPORT
317 dbus_bool_t dbus_set_error_from_message (DBusError *error,
318 DBusMessage *message);
319
320
321 DBUS_EXPORT
322 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
323 DBUS_EXPORT
324 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
325 DBUS_EXPORT
326 dbus_bool_t dbus_message_set_data (DBusMessage *message,
327 dbus_int32_t slot,
328 void *data,
329 DBusFreeFunction free_data_func);
330 DBUS_EXPORT
331 void* dbus_message_get_data (DBusMessage *message,
332 dbus_int32_t slot);
333
334 DBUS_EXPORT
335 int dbus_message_type_from_string (const char *type_str);
336 DBUS_EXPORT
337 const char* dbus_message_type_to_string (int type);
338
339 DBUS_EXPORT
340 dbus_bool_t dbus_message_marshal (DBusMessage *msg,
341 char **marshalled_data_p,
342 int *len_p);
343 DBUS_EXPORT
344 DBusMessage* dbus_message_demarshal (const char *str,
345 int len,
346 DBusError *error);
347
348 DBUS_EXPORT
349 int dbus_message_demarshal_bytes_needed (const char *str,
350 int len);
351
352 DBUS_EXPORT
353 void dbus_message_set_allow_interactive_authorization (DBusMessage *message,
354 dbus_bool_t allow);
355
356 DBUS_EXPORT
357 dbus_bool_t dbus_message_get_allow_interactive_authorization (
358 DBusMessage *message);
359
372 static inline void
373 dbus_clear_message (DBusMessage **pointer_to_message)
374 {
375 _dbus_clear_pointer_impl (DBusMessage, pointer_to_message,
376 dbus_message_unref);
377 }
378
381 DBUS_END_DECLS
382
383 #endif /* DBUS_MESSAGE_H */
dbus_message_set_no_reply
void dbus_message_set_no_reply(DBusMessage *message, dbus_bool_t no_reply)
Sets a flag indicating that the message does not want a reply; if this flag is set,...
Definition: dbus-message.c:3225
dbus_message_set_interface
dbus_bool_t dbus_message_set_interface(DBusMessage *message, const char *iface)
Sets the interface this message is being sent to (for DBUS_MESSAGE_TYPE_METHOD_CALL) or the interface...
Definition: dbus-message.c:3439
DBusMessageIter::dummy3
dbus_uint32_t dummy3
Don't use this.
Definition: dbus-message.h:65
dbus_message_iter_close_container
dbus_bool_t dbus_message_iter_close_container(DBusMessageIter *iter, DBusMessageIter *sub)
Closes a container-typed value appended to the message; may write out more information to the message...
Definition: dbus-message.c:3067
dbus_message_demarshal
DBUS_EXPORT DBusMessage * dbus_message_demarshal(const char *str, int len, DBusError *error)
Demarshal a D-Bus message from the format described in the D-Bus specification.
Definition: dbus-message.c:5151
dbus_message_ref
DBusMessage * dbus_message_ref(DBusMessage *message)
Increments the reference count of a DBusMessage.
Definition: dbus-message.c:1700
dbus_message_get_sender
const char * dbus_message_get_sender(DBusMessage *message)
Gets the unique name of the connection which originated this message, or NULL if unknown or inapplica...
Definition: dbus-message.c:3751
DBusMessageIter::dummy2
void * dummy2
Don't use this.
Definition: dbus-message.h:64
dbus_message_get_allow_interactive_authorization
DBUS_EXPORT dbus_bool_t dbus_message_get_allow_interactive_authorization(DBusMessage *message)
Returns whether the flag controlled by dbus_message_set_allow_interactive_authorization() has been se...
Definition: dbus-message.c:5293
dbus_message_is_method_call
dbus_bool_t dbus_message_is_method_call(DBusMessage *message, const char *iface, const char *method)
Checks whether the message is a method call with the given interface and member fields.
Definition: dbus-message.c:3843
DBUS_DEPRECATED
#define DBUS_DEPRECATED
dbus_message_iter_append_fixed_array
dbus_bool_t dbus_message_iter_append_fixed_array(DBusMessageIter *iter, int element_type, const void *value, int n_elements)
Appends a block of fixed-length values to an array.
Definition: dbus-message.c:2900
dbus_message_allocate_data_slot
DBUS_EXPORT dbus_bool_t dbus_message_allocate_data_slot(dbus_int32_t *slot_p)
Allocates an integer ID to be used for storing application-specific data on any DBusMessage.
Definition: dbus-message.c:4928
dbus_message_iter_open_container
dbus_bool_t dbus_message_iter_open_container(DBusMessageIter *iter, int type, const char *contained_signature, DBusMessageIter *sub)
Appends a container-typed value to the message.
Definition: dbus-message.c:2964
DBusMessageIter::dummy7
int dummy7
Don't use this.
Definition: dbus-message.h:69
dbus_message_lock
DBUS_EXPORT void dbus_message_lock(DBusMessage *message)
Locks a message.
Definition: dbus-message.c:419
dbus_message_unref
void dbus_message_unref(DBusMessage *message)
Decrements the reference count of a DBusMessage, freeing the message if the count reaches 0.
Definition: dbus-message.c:1723
dbus_message_new_method_return
DBusMessage * dbus_message_new_method_return(DBusMessage *method_call)
Constructs a message that is a reply to a method call.
Definition: dbus-message.c:1406
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
Definition: dbus-memory.h:63
DBusMessageIter::dummy9
int dummy9
Don't use this.
Definition: dbus-message.h:71
dbus_message_get_args_valist
dbus_bool_t dbus_message_get_args_valist(DBusMessage *message, DBusError *error, int first_arg_type, va_list var_args)
Like dbus_message_get_args but takes a va_list for use by language bindings.
Definition: dbus-message.c:2049
dbus_message_type_from_string
DBUS_EXPORT int dbus_message_type_from_string(const char *type_str)
Utility function to convert a machine-readable (not translated) string into a D-Bus message type.
Definition: dbus-message.c:5031
dbus_message_contains_unix_fds
dbus_bool_t dbus_message_contains_unix_fds(DBusMessage *message)
Checks whether a message contains unix fds.
Definition: dbus-message.c:4066
DBusMessageIter::pad1
int pad1
Don't use this.
Definition: dbus-message.h:74
DBUS_END_DECLS
#define DBUS_END_DECLS
dbus_message_new
DBusMessage * dbus_message_new(int message_type)
Constructs a new message of the given message type.
Definition: dbus-message.c:1322
dbus_message_iter_init
dbus_bool_t dbus_message_iter_init(DBusMessage *message, DBusMessageIter *iter)
Initializes a DBusMessageIter for reading the arguments of the message passed in.
Definition: dbus-message.c:2118
dbus_message_has_interface
dbus_bool_t dbus_message_has_interface(DBusMessage *message, const char *iface)
Checks if the message has an interface.
Definition: dbus-message.c:3490
dbus_message_set_error_name
dbus_bool_t dbus_message_set_error_name(DBusMessage *message, const char *error_name)
Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR).
Definition: dbus-message.c:3612
dbus_message_free_data_slot
DBUS_EXPORT void dbus_message_free_data_slot(dbus_int32_t *slot_p)
Deallocates a global ID for message data slots.
Definition: dbus-message.c:4946
dbus_message_iter_init_closed
DBUS_EXPORT void dbus_message_iter_init_closed(DBusMessageIter *iter)
Initialize iter as if with DBUS_MESSAGE_ITER_INIT_CLOSED.
Definition: dbus-message.c:743
dbus_int32_t
int dbus_int32_t
Definition: dbus-arch-deps.h:42
dbus_message_iter_has_next
dbus_bool_t dbus_message_iter_has_next(DBusMessageIter *iter)
Checks if an iterator has any more fields.
Definition: dbus-message.c:2149
dbus_message_iter_get_element_type
int dbus_message_iter_get_element_type(DBusMessageIter *iter)
Returns the element type of the array that the message iterator points to.
Definition: dbus-message.c:2212
dbus_message_get_path
const char * dbus_message_get_path(DBusMessage *message)
Gets the object path this message is being sent to (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitt...
Definition: dbus-message.c:3337
dbus_message_iter_abandon_container
void dbus_message_iter_abandon_container(DBusMessageIter *iter, DBusMessageIter *sub)
Abandons creation of a contained-typed value and frees resources created by dbus_message_iter_open_co...
Definition: dbus-message.c:3101
dbus_message_get_error_name
const char * dbus_message_get_error_name(DBusMessage *message)
Gets the error name (DBUS_MESSAGE_TYPE_ERROR only) or NULL if none.
Definition: dbus-message.c:3638
dbus_message_set_reply_serial
dbus_bool_t dbus_message_set_reply_serial(DBusMessage *message, dbus_uint32_t reply_serial)
Sets the reply serial of a message (the serial of the message this is a reply to).
Definition: dbus-message.c:1172
dbus_message_is_error
dbus_bool_t dbus_message_is_error(DBusMessage *message, const char *error_name)
Checks whether the message is an error reply with the given error name.
Definition: dbus-message.c:3898
dbus_message_get_args
dbus_bool_t dbus_message_get_args(DBusMessage *message, DBusError *error, int first_arg_type,...)
Gets arguments from a message given a variable argument list.
Definition: dbus-message.c:2020
dbus_message_get_destination
const char * dbus_message_get_destination(DBusMessage *message)
Gets the destination of a message or NULL if there is none set.
Definition: dbus-message.c:3691
dbus_message_has_path
dbus_bool_t dbus_message_has_path(DBusMessage *message, const char *path)
Checks if the message has a particular object path.
Definition: dbus-message.c:3361
dbus_message_has_sender
dbus_bool_t dbus_message_has_sender(DBusMessage *message, const char *name)
Checks whether the message has the given unique name as its sender.
Definition: dbus-message.c:3966
dbus_message_set_allow_interactive_authorization
DBUS_EXPORT void dbus_message_set_allow_interactive_authorization(DBusMessage *message, dbus_bool_t allow)
Sets a flag indicating that the caller of the method is prepared to wait for interactive authorizatio...
Definition: dbus-message.c:5275
dbus_message_iter_get_basic
void dbus_message_iter_get_basic(DBusMessageIter *iter, void *value)
Reads a basic-typed value from the message iterator.
Definition: dbus-message.c:2347
dbus_message_iter_append_basic
dbus_bool_t dbus_message_iter_append_basic(DBusMessageIter *iter, int type, const void *value)
Appends a basic-typed value to the message.
Definition: dbus-message.c:2749
dbus_message_iter_get_arg_type
int dbus_message_iter_get_arg_type(DBusMessageIter *iter)
Returns the argument type of the argument that the message iterator points to.
Definition: dbus-message.c:2193
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
dbus_message_get_member
const char * dbus_message_get_member(DBusMessage *message)
Gets the interface member being invoked (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted (DBUS_MESSAGE_TYPE...
Definition: dbus-message.c:3554
dbus_message_set_destination
dbus_bool_t dbus_message_set_destination(DBusMessage *message, const char *destination)
Sets the message's destination.
Definition: dbus-message.c:3666
DBusMessageIter::dummy10
int dummy10
Don't use this.
Definition: dbus-message.h:72
dbus_message_set_sender
dbus_bool_t dbus_message_set_sender(DBusMessage *message, const char *sender)
Sets the message sender.
Definition: dbus-message.c:3720
DBusMessageIter::dummy8
int dummy8
Don't use this.
Definition: dbus-message.h:70
dbus_message_get_container_instance
const char * dbus_message_get_container_instance(DBusMessage *message)
Gets the container instance this message was sent from, or NULL if none.
Definition: dbus-message.c:4114
dbus_uint32_t
unsigned int dbus_uint32_t
Definition: dbus-arch-deps.h:43
dbus_message_get_signature
const char * dbus_message_get_signature(DBusMessage *message)
Gets the type signature of the message, i.e.
Definition: dbus-message.c:3784
dbus_message_iter_init_append
void dbus_message_iter_init_append(DBusMessage *message, DBusMessageIter *iter)
Initializes a DBusMessageIter for appending arguments to the end of a message.
Definition: dbus-message.c:2511
dbus_message_set_path
dbus_bool_t dbus_message_set_path(DBusMessage *message, const char *object_path)
Sets the object path this message is being sent to (for DBUS_MESSAGE_TYPE_METHOD_CALL) or the one a s...
Definition: dbus-message.c:3308
dbus_message_has_signature
dbus_bool_t dbus_message_has_signature(DBusMessage *message, const char *signature)
Checks whether the message has the given signature; see dbus_message_get_signature() for more details...
Definition: dbus-message.c:3995
dbus_message_has_destination
dbus_bool_t dbus_message_has_destination(DBusMessage *message, const char *name)
Checks whether the message was sent to the given name.
Definition: dbus-message.c:3931
DBusMessageIter::dummy5
int dummy5
Don't use this.
Definition: dbus-message.h:67
DBusMessage
Internals of DBusMessage.
Definition: dbus-message-private.h:100
dbus_message_iter_abandon_container_if_open
void dbus_message_iter_abandon_container_if_open(DBusMessageIter *iter, DBusMessageIter *sub)
Abandons creation of a contained-typed value and frees resources created by dbus_message_iter_open_co...
Definition: dbus-message.c:3160
dbus_message_new_error_printf
DBusMessage * dbus_message_new_error_printf(DBusMessage *reply_to, const char *error_name, const char *error_format,...)
Creates a new message that is an error reply to another message, allowing you to use printf formattin...
Definition: dbus-message.c:1575
dbus_message_has_member
dbus_bool_t dbus_message_has_member(DBusMessage *message, const char *member)
Checks if the message has an interface member.
Definition: dbus-message.c:3576
DBusMessageIter::pad3
void * pad3
Don't use this.
Definition: dbus-message.h:76
dbus_message_get_reply_serial
dbus_uint32_t dbus_message_get_reply_serial(DBusMessage *message)
Returns the serial that the message is a reply to or 0 if none.
Definition: dbus-message.c:1196
dbus_message_get_serial
dbus_uint32_t dbus_message_get_serial(DBusMessage *message)
Returns the serial of a message or 0 if none has been specified.
Definition: dbus-message.c:1156
dbus_message_get_interface
const char * dbus_message_get_interface(DBusMessage *message)
Gets the interface this message is being sent to (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted...
Definition: dbus-message.c:3468
dbus_message_demarshal_bytes_needed
DBUS_EXPORT int dbus_message_demarshal_bytes_needed(const char *str, int len)
Returns the number of bytes required to be in the buffer to demarshal a D-Bus message.
Definition: dbus-message.c:5215
dbus_message_type_to_string
DBUS_EXPORT const char * dbus_message_type_to_string(int type)
Utility function to convert a D-Bus message type into a machine-readable string (not translated).
Definition: dbus-message.c:5059
dbus_message_get_auto_start
dbus_bool_t dbus_message_get_auto_start(DBusMessage *message)
Returns TRUE if the message will cause an owner for destination name to be auto-started.
Definition: dbus-message.c:3286
dbus_message_marshal
DBUS_EXPORT dbus_bool_t dbus_message_marshal(DBusMessage *msg, char **marshalled_data_p, int *len_p)
Turn a DBusMessage into the marshalled form as described in the D-Bus specification.
Definition: dbus-message.c:5089
dbus_message_set_serial
DBUS_EXPORT void dbus_message_set_serial(DBusMessage *message, dbus_uint32_t serial)
Sets the serial number of a message.
Definition: dbus-message.c:289
DBusMessageIter::pad2
void * pad2
Don't use this.
Definition: dbus-message.h:75
dbus_message_set_data
DBUS_EXPORT dbus_bool_t dbus_message_set_data(DBusMessage *message, dbus_int32_t slot, void *data, DBusFreeFunction free_data_func)
Stores a pointer on a DBusMessage, along with an optional function to be used for freeing the data wh...
Definition: dbus-message.c:4967
dbus_message_iter_get_fixed_array
void dbus_message_iter_get_fixed_array(DBusMessageIter *iter, void *value, int *n_elements)
Reads a block of fixed-length values from the message iterator.
Definition: dbus-message.c:2481
dbus_message_set_container_instance
dbus_bool_t dbus_message_set_container_instance(DBusMessage *message, const char *object_path)
Sets the container instance this message was sent from.
Definition: dbus-message.c:4088
dbus_message_is_signal
dbus_bool_t dbus_message_is_signal(DBusMessage *message, const char *iface, const char *signal_name)
Checks whether the message is a signal with the given interface and member fields.
Definition: dbus-message.c:3871
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusMessageIter
DBusMessageIter struct; contains no public fields.
Definition: dbus-message.h:62
dbus_message_append_args
dbus_bool_t dbus_message_append_args(DBusMessage *message, int first_arg_type,...)
Appends fields to a message given a variable argument list.
Definition: dbus-message.c:1831
dbus_message_iter_next
dbus_bool_t dbus_message_iter_next(DBusMessageIter *iter)
Moves the iterator to the next field, if any.
Definition: dbus-message.c:2168
dbus_message_iter_recurse
void dbus_message_iter_recurse(DBusMessageIter *iter, DBusMessageIter *sub)
Recurses into a container value when reading values from a message, initializing a sub-iterator to us...
Definition: dbus-message.c:2249
dbus_message_iter_get_signature
char * dbus_message_iter_get_signature(DBusMessageIter *iter)
Returns the current signature of a message iterator.
Definition: dbus-message.c:2274
dbus_message_copy
DBusMessage * dbus_message_copy(const DBusMessage *message)
Creates a new message that is an exact replica of the message specified, except that its refcount is ...
Definition: dbus-message.c:1620
DBusMessageIter::dummy11
int dummy11
Don't use this.
Definition: dbus-message.h:73
dbus_message_get_no_reply
dbus_bool_t dbus_message_get_no_reply(DBusMessage *message)
Returns TRUE if the message does not expect a reply.
Definition: dbus-message.c:3244
dbus_message_get_data
DBUS_EXPORT void * dbus_message_get_data(DBusMessage *message, dbus_int32_t slot)
Retrieves data previously set with dbus_message_set_data().
Definition: dbus-message.c:5003
dbus_message_set_auto_start
void dbus_message_set_auto_start(DBusMessage *message, dbus_bool_t auto_start)
Sets a flag indicating that an owner for the destination name will be automatically started before th...
Definition: dbus-message.c:3267
dbus_message_iter_get_element_count
int dbus_message_iter_get_element_count(DBusMessageIter *iter)
Returns the number of elements in the array-typed value pointed to by the iterator.
Definition: dbus-message.c:2392
DBusMessageIter::dummy4
int dummy4
Don't use this.
Definition: dbus-message.h:66
dbus_message_get_type
int dbus_message_get_type(DBusMessage *message)
Gets the type of a message.
Definition: dbus-message.c:1755
dbus_message_new_signal
DBusMessage * dbus_message_new_signal(const char *path, const char *iface, const char *name)
Constructs a new message representing a signal emission.
Definition: dbus-message.c:1457
dbus_message_new_error
DBusMessage * dbus_message_new_error(DBusMessage *reply_to, const char *error_name, const char *error_message)
Creates a new message that is an error reply to another message.
Definition: dbus-message.c:1503
dbus_message_new_method_call
DBusMessage * dbus_message_new_method_call(const char *destination, const char *path, const char *iface, const char *method)
Constructs a new message to invoke a method on a remote object.
Definition: dbus-message.c:1366
dbus_message_append_args_valist
dbus_bool_t dbus_message_append_args_valist(DBusMessage *message, int first_arg_type, va_list var_args)
Like dbus_message_append_args() but takes a va_list for use by language bindings.
Definition: dbus-message.c:1863
DBusMessageIter::dummy6
int dummy6
Don't use this.
Definition: dbus-message.h:68
DBusMessageIter::dummy1
void * dummy1
Don't use this.
Definition: dbus-message.h:63
dbus_set_error_from_message
dbus_bool_t dbus_set_error_from_message(DBusError *error, DBusMessage *message)
Sets a DBusError based on the contents of the given message.
Definition: dbus-message.c:4037
dbus_message_iter_get_array_len
int dbus_message_iter_get_array_len(DBusMessageIter *iter)
Returns the number of bytes in the array as marshaled in the wire protocol.
Definition: dbus-message.c:2436
dbus_bool_t
dbus_uint32_t dbus_bool_t
Definition: dbus-types.h:35
dbus_message_get_path_decomposed
dbus_bool_t dbus_message_get_path_decomposed(DBusMessage *message, char ***path)
Gets the object path this message is being sent to (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitt...
Definition: dbus-message.c:3405
dbus_message_set_member
dbus_bool_t dbus_message_set_member(DBusMessage *message, const char *member)
Sets the interface member being invoked (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted (DBUS_MESSAGE_TYPE...
Definition: dbus-message.c:3527