X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dbus%2Fdbus-message.h;h=41b0a5d47a5b3d3f23a363540c4909e18aa69eeb;hb=3ccb027c907f9ee2890028e83b60296204bbf478;hp=9f07565c21b833380eeea61b0b54ce6a0a99c7a1;hpb=958805418359aca169cd363a4a3279f0fdab753c;p=platform%2Fupstream%2Fdbus.git diff --git a/dbus/dbus-message.h b/dbus/dbus-message.h index 9f07565..41b0a5d 100644 --- a/dbus/dbus-message.h +++ b/dbus/dbus-message.h @@ -1,9 +1,9 @@ -/* -*- mode: C; c-file-style: "gnu" -*- */ +/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ /* dbus-message.h DBusMessage object * - * Copyright (C) 2002 Red Hat Inc. + * Copyright (C) 2002, 2003, 2005 Red Hat Inc. * - * Licensed under the Academic Free License version 1.2 + * Licensed under the Academic Free License version 2.1 * * 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 @@ -17,7 +17,7 @@ * * 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 + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * */ #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION) @@ -31,217 +31,284 @@ #include #include #include +#include #include -DBUS_BEGIN_DECLS; +DBUS_BEGIN_DECLS + +/** + * @addtogroup DBusMessage + * @{ + */ typedef struct DBusMessage DBusMessage; +/** 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. */ typedef struct DBusMessageIter DBusMessageIter; +/** + * DBusMessageIter struct; contains no public fields. + */ 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; +{ + 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 */ }; +DBUS_EXPORT +DBusMessage* dbus_message_new (int message_type); +DBUS_EXPORT +DBusMessage* dbus_message_new_method_call (const char *bus_name, + const char *path, + const char *iface, + const char *method); +DBUS_EXPORT +DBusMessage* dbus_message_new_method_return (DBusMessage *method_call); +DBUS_EXPORT +DBusMessage* dbus_message_new_signal (const char *path, + const char *iface, + const char *name); +DBUS_EXPORT +DBusMessage* dbus_message_new_error (DBusMessage *reply_to, + const char *error_name, + const char *error_message); +DBUS_EXPORT +DBusMessage* dbus_message_new_error_printf (DBusMessage *reply_to, + const char *error_name, + const char *error_format, + ...); -DBusMessage* dbus_message_new (const char *name, - const char *destination_service); -DBusMessage* dbus_message_new_reply (DBusMessage *original_message); -DBusMessage* dbus_message_new_error_reply (DBusMessage *original_message, - const char *error_name, - const char *error_message); -DBusMessage *dbus_message_copy (const DBusMessage *message); +DBUS_EXPORT +DBusMessage* dbus_message_copy (const DBusMessage *message); -void dbus_message_ref (DBusMessage *message); +DBUS_EXPORT +DBusMessage* dbus_message_ref (DBusMessage *message); +DBUS_EXPORT void dbus_message_unref (DBusMessage *message); -const char* dbus_message_get_name (DBusMessage *message); +DBUS_EXPORT +int dbus_message_get_type (DBusMessage *message); +DBUS_EXPORT +dbus_bool_t dbus_message_set_path (DBusMessage *message, + const char *object_path); +DBUS_EXPORT +const char* dbus_message_get_path (DBusMessage *message); +DBUS_EXPORT +dbus_bool_t dbus_message_has_path (DBusMessage *message, + const char *object_path); +DBUS_EXPORT +dbus_bool_t dbus_message_set_interface (DBusMessage *message, + const char *iface); +DBUS_EXPORT +const char* dbus_message_get_interface (DBusMessage *message); +DBUS_EXPORT +dbus_bool_t dbus_message_has_interface (DBusMessage *message, + const char *iface); +DBUS_EXPORT +dbus_bool_t dbus_message_set_member (DBusMessage *message, + const char *member); +DBUS_EXPORT +const char* dbus_message_get_member (DBusMessage *message); +DBUS_EXPORT +dbus_bool_t dbus_message_has_member (DBusMessage *message, + const char *member); +DBUS_EXPORT +dbus_bool_t dbus_message_set_error_name (DBusMessage *message, + const char *name); +DBUS_EXPORT +const char* dbus_message_get_error_name (DBusMessage *message); +DBUS_EXPORT +dbus_bool_t dbus_message_set_destination (DBusMessage *message, + const char *destination); +DBUS_EXPORT const char* dbus_message_get_destination (DBusMessage *message); +DBUS_EXPORT dbus_bool_t dbus_message_set_sender (DBusMessage *message, const char *sender); +DBUS_EXPORT const char* dbus_message_get_sender (DBusMessage *message); -void dbus_message_set_is_error (DBusMessage *message, - dbus_bool_t is_error_reply); -dbus_bool_t dbus_message_get_is_error (DBusMessage *message); -dbus_bool_t dbus_message_has_name (DBusMessage *message, - const char *name); +DBUS_EXPORT +const char* dbus_message_get_signature (DBusMessage *message); +DBUS_EXPORT +void dbus_message_set_no_reply (DBusMessage *message, + dbus_bool_t no_reply); +DBUS_EXPORT +dbus_bool_t dbus_message_get_no_reply (DBusMessage *message); +DBUS_EXPORT +dbus_bool_t dbus_message_is_method_call (DBusMessage *message, + const char *iface, + const char *method); +DBUS_EXPORT +dbus_bool_t dbus_message_is_signal (DBusMessage *message, + const char *iface, + const char *signal_name); +DBUS_EXPORT +dbus_bool_t dbus_message_is_error (DBusMessage *message, + const char *error_name); +DBUS_EXPORT dbus_bool_t dbus_message_has_destination (DBusMessage *message, - const char *service); + const char *bus_name); +DBUS_EXPORT dbus_bool_t dbus_message_has_sender (DBusMessage *message, - const char *service); + const char *unique_bus_name); +DBUS_EXPORT +dbus_bool_t dbus_message_has_signature (DBusMessage *message, + const char *signature); +DBUS_EXPORT dbus_uint32_t dbus_message_get_serial (DBusMessage *message); +DBUS_EXPORT +void dbus_message_set_serial (DBusMessage *message, + dbus_uint32_t serial); +DBUS_EXPORT dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message, dbus_uint32_t reply_serial); +DBUS_EXPORT dbus_uint32_t dbus_message_get_reply_serial (DBusMessage *message); +DBUS_EXPORT +void dbus_message_set_auto_start (DBusMessage *message, + dbus_bool_t auto_start); +DBUS_EXPORT +dbus_bool_t dbus_message_get_auto_start (DBusMessage *message); + +DBUS_EXPORT +dbus_bool_t dbus_message_get_path_decomposed (DBusMessage *message, + char ***path); + +DBUS_EXPORT dbus_bool_t dbus_message_append_args (DBusMessage *message, int first_arg_type, ...); +DBUS_EXPORT dbus_bool_t dbus_message_append_args_valist (DBusMessage *message, int first_arg_type, va_list var_args); +DBUS_EXPORT dbus_bool_t dbus_message_get_args (DBusMessage *message, DBusError *error, int first_arg_type, ...); +DBUS_EXPORT 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); +DBUS_EXPORT +dbus_bool_t dbus_message_contains_unix_fds (DBusMessage *message); + +DBUS_EXPORT +dbus_bool_t dbus_message_iter_init (DBusMessage *message, + DBusMessageIter *iter); +DBUS_EXPORT +dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter); +DBUS_EXPORT +dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter); +DBUS_EXPORT +char* dbus_message_iter_get_signature (DBusMessageIter *iter); +DBUS_EXPORT +int dbus_message_iter_get_arg_type (DBusMessageIter *iter); +DBUS_EXPORT +int dbus_message_iter_get_element_type (DBusMessageIter *iter); +DBUS_EXPORT +void dbus_message_iter_recurse (DBusMessageIter *iter, + DBusMessageIter *sub); +DBUS_EXPORT +void dbus_message_iter_get_basic (DBusMessageIter *iter, + void *value); +#ifndef DBUS_DISABLE_DEPRECATED +/* This function returns the wire protocol size of the array in bytes, + * you do not want to know that probably + */ +DBUS_EXPORT +DBUS_DEPRECATED int dbus_message_iter_get_array_len (DBusMessageIter *iter); +#endif +DBUS_EXPORT +void dbus_message_iter_get_fixed_array (DBusMessageIter *iter, + void *value, + int *n_elements); -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_EXPORT +void dbus_message_iter_init_append (DBusMessage *message, + DBusMessageIter *iter); +DBUS_EXPORT +dbus_bool_t dbus_message_iter_append_basic (DBusMessageIter *iter, + int type, + const void *value); +DBUS_EXPORT +dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter, + int element_type, + const void *value, + int n_elements); +DBUS_EXPORT +dbus_bool_t dbus_message_iter_open_container (DBusMessageIter *iter, + int type, + const char *contained_signature, + DBusMessageIter *sub); +DBUS_EXPORT +dbus_bool_t dbus_message_iter_close_container (DBusMessageIter *iter, + DBusMessageIter *sub); +DBUS_EXPORT +void dbus_message_iter_abandon_container (DBusMessageIter *iter, + DBusMessageIter *sub); +DBUS_EXPORT +void dbus_message_lock (DBusMessage *message); +#ifdef ENABLE_KDBUS_TRANSPORT +DBUS_EXPORT +void dbus_message_unlock (DBusMessage *message); +#endif +DBUS_EXPORT dbus_bool_t dbus_set_error_from_message (DBusError *error, DBusMessage *message); +DBUS_EXPORT dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t *slot_p); +DBUS_EXPORT void dbus_message_free_data_slot (dbus_int32_t *slot_p); +DBUS_EXPORT dbus_bool_t dbus_message_set_data (DBusMessage *message, dbus_int32_t slot, void *data, DBusFreeFunction free_data_func); +DBUS_EXPORT void* dbus_message_get_data (DBusMessage *message, dbus_int32_t slot); -DBUS_END_DECLS; +DBUS_EXPORT +int dbus_message_type_from_string (const char *type_str); +DBUS_EXPORT +const char* dbus_message_type_to_string (int type); + +DBUS_EXPORT +dbus_bool_t dbus_message_marshal (DBusMessage *msg, + char **marshalled_data_p, + int *len_p); +DBUS_EXPORT +DBusMessage* dbus_message_demarshal (const char *str, + int len, + DBusError *error); + +DBUS_EXPORT +int dbus_message_demarshal_bytes_needed (const char *str, + int len); + +/** @} */ + +DBUS_END_DECLS #endif /* DBUS_MESSAGE_H */