D-Bus 1.15.2
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
38
44typedef struct DBusMessage DBusMessage;
57
62{
63#if DBUS_SIZEOF_VOID_P > 8
64 void *dummy[16];
65#else
66 void *dummy1;
67 void *dummy2;
69 int dummy4;
70 int dummy5;
71 int dummy6;
72 int dummy7;
73 int dummy8;
74 int dummy9;
75 int dummy10;
76 int dummy11;
77 int pad1;
78 void *pad2;
79 void *pad3;
80#endif
81};
82
87#if DBUS_SIZEOF_VOID_P > 8
88#define DBUS_MESSAGE_ITER_INIT_CLOSED \
89{ \
90 { \
91 NULL, NULL, NULL, NULL, \
92 NULL, NULL, NULL, NULL, \
93 NULL, NULL, NULL, NULL, \
94 NULL, NULL, NULL, NULL \
95 } \
96}
97#else
98#define DBUS_MESSAGE_ITER_INIT_CLOSED \
99{ \
100 NULL, /* dummy1 */ \
101 NULL, /* dummy2 */ \
102 0, /* dummy3 */ \
103 0, /* dummy4 */ \
104 0, /* dummy5 */ \
105 0, /* dummy6 */ \
106 0, /* dummy7 */ \
107 0, /* dummy8 */ \
108 0, /* dummy9 */ \
109 0, /* dummy10 */ \
110 0, /* dummy11 */ \
111 0, /* pad1 */ \
112 NULL, /* pad2 */ \
113 NULL /* pad3 */ \
114}
115#endif
116
117DBUS_EXPORT
118DBusMessage* dbus_message_new (int message_type);
119DBUS_EXPORT
120DBusMessage* dbus_message_new_method_call (const char *bus_name,
121 const char *path,
122 const char *iface,
123 const char *method);
124DBUS_EXPORT
126DBUS_EXPORT
127DBusMessage* dbus_message_new_signal (const char *path,
128 const char *iface,
129 const char *name);
130DBUS_EXPORT
132 const char *error_name,
133 const char *error_message);
134DBUS_EXPORT
136 const char *error_name,
137 const char *error_format,
138 ...) _DBUS_GNUC_PRINTF (3, 4);
139
140DBUS_EXPORT
142
143DBUS_EXPORT
145DBUS_EXPORT
146void dbus_message_unref (DBusMessage *message);
147DBUS_EXPORT
149DBUS_EXPORT
151 const char *object_path);
152DBUS_EXPORT
153const char* dbus_message_get_path (DBusMessage *message);
154DBUS_EXPORT
156 const char *object_path);
157DBUS_EXPORT
159 const char *iface);
160DBUS_EXPORT
161const char* dbus_message_get_interface (DBusMessage *message);
162DBUS_EXPORT
164 const char *iface);
165DBUS_EXPORT
167 const char *member);
168DBUS_EXPORT
169const char* dbus_message_get_member (DBusMessage *message);
170DBUS_EXPORT
172 const char *member);
173DBUS_EXPORT
175 const char *name);
176DBUS_EXPORT
177const char* dbus_message_get_error_name (DBusMessage *message);
178DBUS_EXPORT
180 const char *destination);
181DBUS_EXPORT
182const char* dbus_message_get_destination (DBusMessage *message);
183DBUS_EXPORT
185 const char *sender);
186DBUS_EXPORT
187const char* dbus_message_get_sender (DBusMessage *message);
188DBUS_EXPORT
189const char* dbus_message_get_signature (DBusMessage *message);
190DBUS_EXPORT
192 dbus_bool_t no_reply);
193DBUS_EXPORT
195DBUS_EXPORT
197 const char *iface,
198 const char *method);
199DBUS_EXPORT
201 const char *iface,
202 const char *signal_name);
203DBUS_EXPORT
205 const char *error_name);
206DBUS_EXPORT
208 const char *bus_name);
209DBUS_EXPORT
211 const char *unique_bus_name);
212DBUS_EXPORT
214 const char *signature);
215DBUS_EXPORT
217DBUS_EXPORT
219 dbus_uint32_t serial);
220DBUS_EXPORT
222 dbus_uint32_t reply_serial);
223DBUS_EXPORT
225
226DBUS_EXPORT
228 dbus_bool_t auto_start);
229DBUS_EXPORT
231
232DBUS_EXPORT
234 char ***path);
235
236DBUS_EXPORT
238DBUS_EXPORT
240 const char *object_path);
241
242DBUS_EXPORT
244 int first_arg_type,
245 ...);
246DBUS_EXPORT
248 int first_arg_type,
249 va_list var_args);
250DBUS_EXPORT
252 DBusError *error,
253 int first_arg_type,
254 ...);
255DBUS_EXPORT
257 DBusError *error,
258 int first_arg_type,
259 va_list var_args);
260
261DBUS_EXPORT
263
264DBUS_EXPORT
266DBUS_EXPORT
268 DBusMessageIter *iter);
269DBUS_EXPORT
271DBUS_EXPORT
273DBUS_EXPORT
275DBUS_EXPORT
277DBUS_EXPORT
279DBUS_EXPORT
281 DBusMessageIter *sub);
282DBUS_EXPORT
284 void *value);
285DBUS_EXPORT
287
288#ifndef DBUS_DISABLE_DEPRECATED
289/* This function returns the wire protocol size of the array in bytes,
290 * you do not want to know that probably
291 */
292DBUS_EXPORT
294#endif
295DBUS_EXPORT
297 void *value,
298 int *n_elements);
299
300
301DBUS_EXPORT
303 DBusMessageIter *iter);
304DBUS_EXPORT
306 int type,
307 const void *value);
308DBUS_EXPORT
310 int element_type,
311 const void *value,
312 int n_elements);
313DBUS_EXPORT
315 int type,
316 const char *contained_signature,
317 DBusMessageIter *sub);
318DBUS_EXPORT
320 DBusMessageIter *sub);
321DBUS_EXPORT
323 DBusMessageIter *sub);
324
325DBUS_EXPORT
327 DBusMessageIter *sub);
328
329DBUS_EXPORT
330void dbus_message_lock (DBusMessage *message);
331
332DBUS_EXPORT
334 DBusMessage *message);
335
336
337DBUS_EXPORT
339DBUS_EXPORT
341DBUS_EXPORT
343 dbus_int32_t slot,
344 void *data,
345 DBusFreeFunction free_data_func);
346DBUS_EXPORT
347void* dbus_message_get_data (DBusMessage *message,
348 dbus_int32_t slot);
349
350DBUS_EXPORT
351int dbus_message_type_from_string (const char *type_str);
352DBUS_EXPORT
353const char* dbus_message_type_to_string (int type);
354
355DBUS_EXPORT
357 char **marshalled_data_p,
358 int *len_p);
359DBUS_EXPORT
360DBusMessage* dbus_message_demarshal (const char *str,
361 int len,
362 DBusError *error);
363
364DBUS_EXPORT
365int dbus_message_demarshal_bytes_needed (const char *str,
366 int len);
367
368DBUS_EXPORT
370 dbus_bool_t allow);
371
372DBUS_EXPORT
374 DBusMessage *message);
375
388static inline void
389dbus_clear_message (DBusMessage **pointer_to_message)
390{
391 _dbus_clear_pointer_impl (DBusMessage, pointer_to_message,
393}
394
398
399#endif /* DBUS_MESSAGE_H */
#define DBUS_DEPRECATED
Tells the compiler to warn about a function or type if it's used.
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
dbus_bool_t dbus_message_has_destination(DBusMessage *message, const char *name)
Checks whether the message was sent to the given name.
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...
dbus_bool_t dbus_message_has_interface(DBusMessage *message, const char *iface)
Checks if the message has an interface.
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,...
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.
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...
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...
dbus_bool_t dbus_message_iter_append_basic(DBusMessageIter *iter, int type, const void *value)
Appends a basic-typed value to the message.
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...
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...
DBUS_EXPORT void dbus_message_free_data_slot(dbus_int32_t *slot_p)
Deallocates a global ID for message data slots.
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...
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.
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).
dbus_bool_t dbus_message_has_sender(DBusMessage *message, const char *name)
Checks whether the message has the given unique name as its sender.
dbus_uint32_t dbus_message_get_serial(DBusMessage *message)
Returns the serial of a message or 0 if none has been specified.
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...
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.
void dbus_message_iter_get_basic(DBusMessageIter *iter, void *value)
Reads a basic-typed value from the message iterator.
int dbus_message_get_type(DBusMessage *message)
Gets the type of a message.
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 ...
const char * dbus_message_get_error_name(DBusMessage *message)
Gets the error name (DBUS_MESSAGE_TYPE_ERROR only) or NULL if none.
dbus_bool_t dbus_message_iter_next(DBusMessageIter *iter)
Moves the iterator to the next field, if any.
dbus_bool_t dbus_message_append_args(DBusMessage *message, int first_arg_type,...)
Appends fields to a message given a variable argument list.
int dbus_message_iter_get_arg_type(DBusMessageIter *iter)
Returns the argument type of the argument that the message iterator points to.
dbus_bool_t dbus_message_get_no_reply(DBusMessage *message)
Returns TRUE if the message does not expect a reply.
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.
DBusMessage * dbus_message_new_signal(const char *path, const char *iface, const char *name)
Constructs a new message representing a signal emission.
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.
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...
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...
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.
dbus_bool_t dbus_message_contains_unix_fds(DBusMessage *message)
Checks whether a message contains unix fds.
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...
DBusMessage * dbus_message_ref(DBusMessage *message)
Increments the reference count of a DBusMessage.
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.
int dbus_message_iter_get_element_type(DBusMessageIter *iter)
Returns the element type of the array that the message iterator points to.
dbus_bool_t dbus_message_set_error_name(DBusMessage *message, const char *error_name)
Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR).
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...
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.
dbus_uint32_t dbus_message_get_reply_serial(DBusMessage *message)
Returns the serial that the message is a reply to or 0 if none.
DBusMessage * dbus_message_new_method_return(DBusMessage *method_call)
Constructs a message that is a reply to a 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.
dbus_bool_t dbus_message_iter_init(DBusMessage *message, DBusMessageIter *iter)
Initializes a DBusMessageIter for reading the arguments of the message passed in.
dbus_bool_t dbus_message_set_sender(DBusMessage *message, const char *sender)
Sets the message sender.
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...
DBUS_EXPORT void dbus_message_set_serial(DBusMessage *message, dbus_uint32_t serial)
Sets the serial number of a message.
Definition: dbus-message.c:299
const char * dbus_message_get_destination(DBusMessage *message)
Gets the destination of a message or NULL if there is none set.
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...
dbus_bool_t dbus_message_iter_has_next(DBusMessageIter *iter)
Checks if an iterator has any more fields.
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.
char * dbus_message_iter_get_signature(DBusMessageIter *iter)
Returns the current signature of a message iterator.
void dbus_message_unref(DBusMessage *message)
Decrements the reference count of a DBusMessage, freeing the message if the count reaches 0.
int dbus_message_iter_get_array_len(DBusMessageIter *iter)
Returns the number of bytes in the array as marshaled in the wire protocol.
DBusMessage * dbus_message_new(int message_type)
Constructs a new message of the given message type.
dbus_bool_t dbus_set_error_from_message(DBusError *error, DBusMessage *message)
Sets a DBusError based on the contents of the given message.
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.
int dbus_message_iter_get_element_count(DBusMessageIter *iter)
Returns the number of elements in the array-typed value pointed to by the iterator.
dbus_bool_t dbus_message_set_destination(DBusMessage *message, const char *destination)
Sets the message's destination.
dbus_bool_t dbus_message_has_path(DBusMessage *message, const char *path)
Checks if the message has a particular object path.
DBUS_EXPORT void dbus_message_lock(DBusMessage *message)
Locks a message.
Definition: dbus-message.c:429
dbus_bool_t dbus_message_has_member(DBusMessage *message, const char *member)
Checks if the message has an interface member.
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.
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.
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.
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...
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...
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).
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.
const char * dbus_message_get_signature(DBusMessage *message)
Gets the type signature of the message, i.e.
dbus_bool_t dbus_message_set_container_instance(DBusMessage *message, const char *object_path)
Sets the container instance this message was sent from.
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...
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.
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...
DBUS_EXPORT void dbus_message_iter_init_closed(DBusMessageIter *iter)
Initialize iter as if with DBUS_MESSAGE_ITER_INIT_CLOSED.
Definition: dbus-message.c:753
const char * dbus_message_get_member(DBusMessage *message)
Gets the interface member being invoked (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted (DBUS_MESSAGE_TYPE...
void dbus_message_iter_init_append(DBusMessage *message, DBusMessageIter *iter)
Initializes a DBusMessageIter for appending arguments to the end of a message.
DBUS_EXPORT void * dbus_message_get_data(DBusMessage *message, dbus_int32_t slot)
Retrieves data previously set with dbus_message_set_data().
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.
const char * dbus_message_get_container_instance(DBusMessage *message)
Gets the container instance this message was sent from, or NULL if none.
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
int dbus_int32_t
A 32-bit signed integer on all platforms.
unsigned int dbus_uint32_t
A 32-bit unsigned integer on all platforms.
Object representing an exception.
Definition: dbus-errors.h:49
DBusMessageIter struct; contains no public fields.
Definition: dbus-message.h:62
int dummy8
Don't use this.
Definition: dbus-message.h:73
int dummy11
Don't use this.
Definition: dbus-message.h:76
int dummy4
Don't use this.
Definition: dbus-message.h:69
int pad1
Don't use this.
Definition: dbus-message.h:77
int dummy5
Don't use this.
Definition: dbus-message.h:70
void * pad2
Don't use this.
Definition: dbus-message.h:78
void * dummy1
Don't use this.
Definition: dbus-message.h:66
void * dummy2
Don't use this.
Definition: dbus-message.h:67
int dummy6
Don't use this.
Definition: dbus-message.h:71
dbus_uint32_t dummy3
Don't use this.
Definition: dbus-message.h:68
int dummy7
Don't use this.
Definition: dbus-message.h:72
int dummy10
Don't use this.
Definition: dbus-message.h:75
int dummy9
Don't use this.
Definition: dbus-message.h:74
void * pad3
Don't use this.
Definition: dbus-message.h:79
Internals of DBusMessage.