1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-message.h DBusMessage object
4 * Copyright (C) 2002, 2003, 2005 Red Hat Inc.
5 * Copyright (C) 2015 Samsung Electronics
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
25 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
28 #ifndef DBUS_MESSAGE_H
29 #define DBUS_MESSAGE_H
31 #include <dbus/dbus-macros.h>
32 #include <dbus/dbus-types.h>
33 #include <dbus/dbus-arch-deps.h>
34 #include <dbus/dbus-memory.h>
35 #include <dbus/dbus-errors.h>
41 * @addtogroup DBusMessage
45 typedef struct DBusMessage DBusMessage;
47 * Opaque type representing a message iterator. Can be copied by value and
48 * allocated on the stack.
50 * A DBusMessageIter usually contains no allocated memory. However, there
51 * is one special case: after a successful call to
52 * dbus_message_iter_open_container(), the caller is responsible for calling
53 * either dbus_message_iter_close_container() or
54 * dbus_message_iter_abandon_container() exactly once, with the same pair
57 typedef struct DBusMessageIter DBusMessageIter;
60 * DBusMessageIter struct; contains no public fields.
62 struct DBusMessageIter
64 void *dummy1; /**< Don't use this */
65 void *dummy2; /**< Don't use this */
66 dbus_uint32_t dummy3; /**< Don't use this */
67 int dummy4; /**< Don't use this */
68 int dummy5; /**< Don't use this */
69 int dummy6; /**< Don't use this */
70 void *dummy7; /**< Don't use this */
71 void *dummy8; /**< Don't use this */
72 void *dummy9; /**< Don't use this */
73 void *dummy10; /**< Don't use this */
74 void *dummy11; /**< Don't use this */
75 void *pad1; /**< Don't use this */
76 void *pad2; /**< Don't use this */
77 void *pad3; /**< Don't use this */
81 * A message iterator for which dbus_message_iter_abandon_container_if_open()
82 * is the only valid operation.
84 #define DBUS_MESSAGE_ITER_INIT_CLOSED \
103 DBusMessage* dbus_message_new (int message_type);
105 DBusMessage* dbus_message_new_method_call (const char *bus_name,
110 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
112 DBusMessage* dbus_message_new_signal (const char *path,
116 DBusMessage* dbus_message_new_error (DBusMessage *reply_to,
117 const char *error_name,
118 const char *error_message);
120 DBusMessage* dbus_message_new_error_printf (DBusMessage *reply_to,
121 const char *error_name,
122 const char *error_format,
123 ...) _DBUS_GNUC_PRINTF (3, 4);
126 DBusMessage* dbus_message_copy (const DBusMessage *message);
129 DBusMessage* dbus_message_ref (DBusMessage *message);
131 void dbus_message_unref (DBusMessage *message);
133 int dbus_message_get_type (DBusMessage *message);
135 dbus_bool_t dbus_message_set_path (DBusMessage *message,
136 const char *object_path);
138 const char* dbus_message_get_path (DBusMessage *message);
140 dbus_bool_t dbus_message_has_path (DBusMessage *message,
141 const char *object_path);
143 dbus_bool_t dbus_message_set_interface (DBusMessage *message,
146 const char* dbus_message_get_interface (DBusMessage *message);
148 dbus_bool_t dbus_message_has_interface (DBusMessage *message,
151 dbus_bool_t dbus_message_set_member (DBusMessage *message,
154 const char* dbus_message_get_member (DBusMessage *message);
156 dbus_bool_t dbus_message_has_member (DBusMessage *message,
159 dbus_bool_t dbus_message_set_error_name (DBusMessage *message,
162 const char* dbus_message_get_error_name (DBusMessage *message);
164 dbus_bool_t dbus_message_set_destination (DBusMessage *message,
165 const char *destination);
167 const char* dbus_message_get_destination (DBusMessage *message);
169 dbus_bool_t dbus_message_set_sender (DBusMessage *message,
172 const char* dbus_message_get_sender (DBusMessage *message);
174 const char* dbus_message_get_signature (DBusMessage *message);
176 void dbus_message_set_no_reply (DBusMessage *message,
177 dbus_bool_t no_reply);
179 dbus_bool_t dbus_message_get_no_reply (DBusMessage *message);
181 dbus_bool_t dbus_message_is_method_call (DBusMessage *message,
185 dbus_bool_t dbus_message_is_signal (DBusMessage *message,
187 const char *signal_name);
189 dbus_bool_t dbus_message_is_error (DBusMessage *message,
190 const char *error_name);
192 dbus_bool_t dbus_message_has_destination (DBusMessage *message,
193 const char *bus_name);
195 dbus_bool_t dbus_message_has_sender (DBusMessage *message,
196 const char *unique_bus_name);
198 dbus_bool_t dbus_message_has_signature (DBusMessage *message,
199 const char *signature);
201 dbus_uint32_t dbus_message_get_serial (DBusMessage *message);
203 void dbus_message_set_serial (DBusMessage *message,
204 dbus_uint32_t serial);
206 dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message,
207 dbus_uint32_t reply_serial);
209 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message);
212 void dbus_message_set_auto_start (DBusMessage *message,
213 dbus_bool_t auto_start);
215 dbus_bool_t dbus_message_get_auto_start (DBusMessage *message);
218 dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message,
222 dbus_bool_t dbus_message_append_args (DBusMessage *message,
226 dbus_bool_t dbus_message_append_args_valist (DBusMessage *message,
230 dbus_bool_t dbus_message_get_args (DBusMessage *message,
235 dbus_bool_t dbus_message_get_args_valist (DBusMessage *message,
241 dbus_bool_t dbus_message_contains_unix_fds (DBusMessage *message);
244 void dbus_message_iter_init_closed (DBusMessageIter *iter);
246 dbus_bool_t dbus_message_iter_init (DBusMessage *message,
247 DBusMessageIter *iter);
249 dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter);
251 dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter);
253 char* dbus_message_iter_get_signature (DBusMessageIter *iter);
255 int dbus_message_iter_get_arg_type (DBusMessageIter *iter);
257 int dbus_message_iter_get_element_type (DBusMessageIter *iter);
259 void dbus_message_iter_recurse (DBusMessageIter *iter,
260 DBusMessageIter *sub);
262 void dbus_message_iter_get_basic (DBusMessageIter *iter,
265 int dbus_message_iter_get_element_count(DBusMessageIter *iter);
267 #ifndef DBUS_DISABLE_DEPRECATED
268 /* This function returns the wire protocol size of the array in bytes,
269 * you do not want to know that probably
272 DBUS_DEPRECATED int dbus_message_iter_get_array_len (DBusMessageIter *iter);
275 void dbus_message_iter_get_fixed_array (DBusMessageIter *iter,
281 void dbus_message_iter_init_append (DBusMessage *message,
282 DBusMessageIter *iter);
284 dbus_bool_t dbus_message_iter_append_basic (DBusMessageIter *iter,
288 dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
293 dbus_bool_t dbus_message_iter_open_container (DBusMessageIter *iter,
295 const char *contained_signature,
296 DBusMessageIter *sub);
298 dbus_bool_t dbus_message_iter_close_container (DBusMessageIter *iter,
299 DBusMessageIter *sub);
301 void dbus_message_iter_abandon_container (DBusMessageIter *iter,
302 DBusMessageIter *sub);
305 void dbus_message_iter_abandon_container_if_open (DBusMessageIter *iter,
306 DBusMessageIter *sub);
309 void dbus_message_lock (DBusMessage *message);
312 dbus_bool_t dbus_set_error_from_message (DBusError *error,
313 DBusMessage *message);
317 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p);
319 void dbus_message_free_data_slot (dbus_int32_t *slot_p);
321 dbus_bool_t dbus_message_set_data (DBusMessage *message,
324 DBusFreeFunction free_data_func);
326 void* dbus_message_get_data (DBusMessage *message,
330 int dbus_message_type_from_string (const char *type_str);
332 const char* dbus_message_type_to_string (int type);
335 dbus_bool_t dbus_message_marshal (DBusMessage *msg,
336 char **marshalled_data_p,
339 DBusMessage* dbus_message_demarshal (const char *str,
344 int dbus_message_demarshal_bytes_needed (const char *str,
348 void dbus_message_set_allow_interactive_authorization (DBusMessage *message,
352 dbus_bool_t dbus_message_get_allow_interactive_authorization (
353 DBusMessage *message);
356 void dbus_set_protocol_version (unsigned char version);
358 void dbus_set_default_protocol_strategy (const char *strategy_name);
360 * Clear a variable or struct member that contains a #DBusMessage.
361 * If it does not contain #NULL, the message that was previously
362 * there is unreferenced with dbus_message_unref().
364 * This is very similar to dbus_clear_connection(): see that function
367 * @param pointer_to_message A pointer to a variable or struct member.
368 * pointer_to_message must not be #NULL, but *pointer_to_message
372 dbus_clear_message (DBusMessage **pointer_to_message)
374 _dbus_clear_pointer_impl (DBusMessage, pointer_to_message,
382 #endif /* DBUS_MESSAGE_H */