dbus-message.h

00001 /* -*- mode: C; c-file-style: "gnu" -*- */
00002 /* dbus-message.h DBusMessage object
00003  *
00004  * Copyright (C) 2002, 2003, 2005 Red Hat Inc.
00005  *
00006  * Licensed under the Academic Free License version 2.1
00007  * 
00008  * This program is free software; you can redistribute it and/or modify
00009  * it under the terms of the GNU General Public License as published by
00010  * the Free Software Foundation; either version 2 of the License, or
00011  * (at your option) any later version.
00012  *
00013  * This program is distributed in the hope that it will be useful,
00014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016  * GNU General Public License for more details.
00017  * 
00018  * You should have received a copy of the GNU General Public License
00019  * along with this program; if not, write to the Free Software
00020  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00021  *
00022  */
00023 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
00024 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
00025 #endif
00026 
00027 #ifndef DBUS_MESSAGE_H
00028 #define DBUS_MESSAGE_H
00029 
00030 #include <dbus/dbus-macros.h>
00031 #include <dbus/dbus-types.h>
00032 #include <dbus/dbus-arch-deps.h>
00033 #include <dbus/dbus-memory.h>
00034 #include <dbus/dbus-errors.h>
00035 #include <stdarg.h>
00036 
00037 DBUS_BEGIN_DECLS
00038 
00039 typedef struct DBusMessage DBusMessage;
00040 typedef struct DBusMessageIter DBusMessageIter;
00041 
00045 struct DBusMessageIter
00046 { 
00047   void *dummy1;         
00048   void *dummy2;         
00049   dbus_uint32_t dummy3; 
00050   int dummy4;           
00051   int dummy5;           
00052   int dummy6;           
00053   int dummy7;           
00054   int dummy8;           
00055   int dummy9;           
00056   int dummy10;          
00057   int dummy11;          
00058   int pad1;             
00059   int pad2;             
00060   void *pad3;           
00061 };
00062 
00063 DBusMessage* dbus_message_new               (int          message_type);
00064 DBusMessage* dbus_message_new_method_call   (const char  *bus_name,
00065                                              const char  *path,
00066                                              const char  *interface,
00067                                              const char  *method);
00068 DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
00069 DBusMessage* dbus_message_new_signal        (const char  *path,
00070                                              const char  *interface,
00071                                              const char  *name);
00072 DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
00073                                              const char  *error_name,
00074                                              const char  *error_message);
00075 DBusMessage* dbus_message_new_error_printf  (DBusMessage *reply_to,
00076                                              const char  *error_name,
00077                                              const char  *error_format,
00078                                              ...);
00079 
00080 DBusMessage* dbus_message_copy              (const DBusMessage *message);
00081 
00082 DBusMessage*  dbus_message_ref              (DBusMessage   *message);
00083 void          dbus_message_unref            (DBusMessage   *message);
00084 int           dbus_message_get_type         (DBusMessage   *message);
00085 dbus_bool_t   dbus_message_set_path         (DBusMessage   *message,
00086                                              const char    *object_path);
00087 const char*   dbus_message_get_path         (DBusMessage   *message);
00088 dbus_bool_t   dbus_message_has_path         (DBusMessage   *message, 
00089                                              const char    *object_path);  
00090 dbus_bool_t   dbus_message_set_interface    (DBusMessage   *message,
00091                                              const char    *interface);       
00092 const char*   dbus_message_get_interface    (DBusMessage   *message);
00093 dbus_bool_t   dbus_message_has_interface    (DBusMessage   *message, 
00094                                              const char    *interface);
00095 dbus_bool_t   dbus_message_set_member       (DBusMessage   *message,
00096                                              const char    *member);
00097 const char*   dbus_message_get_member       (DBusMessage   *message);
00098 dbus_bool_t   dbus_message_has_member       (DBusMessage   *message, 
00099                                              const char    *member);
00100 dbus_bool_t   dbus_message_set_error_name   (DBusMessage   *message,
00101                                              const char    *name);
00102 const char*   dbus_message_get_error_name   (DBusMessage   *message);
00103 dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
00104                                              const char    *destination);
00105 const char*   dbus_message_get_destination  (DBusMessage   *message);
00106 dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
00107                                              const char    *sender);
00108 const char*   dbus_message_get_sender       (DBusMessage   *message);
00109 const char*   dbus_message_get_signature    (DBusMessage   *message);
00110 void          dbus_message_set_no_reply     (DBusMessage   *message,
00111                                              dbus_bool_t    no_reply);
00112 dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
00113 dbus_bool_t   dbus_message_is_method_call   (DBusMessage   *message,
00114                                              const char    *interface,
00115                                              const char    *method);
00116 dbus_bool_t   dbus_message_is_signal        (DBusMessage   *message,
00117                                              const char    *interface,
00118                                              const char    *signal_name);
00119 dbus_bool_t   dbus_message_is_error         (DBusMessage   *message,
00120                                              const char    *error_name);
00121 dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
00122                                              const char    *bus_name);
00123 dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
00124                                              const char    *unique_bus_name);
00125 dbus_bool_t   dbus_message_has_signature    (DBusMessage   *message,
00126                                              const char    *signature);
00127 dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
00128 dbus_bool_t   dbus_message_set_reply_serial (DBusMessage   *message,
00129                                              dbus_uint32_t  reply_serial);
00130 dbus_uint32_t dbus_message_get_reply_serial (DBusMessage   *message);
00131 
00132 void          dbus_message_set_auto_start   (DBusMessage   *message,
00133                                              dbus_bool_t    auto_start);
00134 dbus_bool_t   dbus_message_get_auto_start   (DBusMessage   *message);
00135 
00136 dbus_bool_t   dbus_message_get_path_decomposed (DBusMessage   *message,
00137                                                 char        ***path);
00138 
00139 dbus_bool_t dbus_message_append_args          (DBusMessage     *message,
00140                                                int              first_arg_type,
00141                                                ...);
00142 dbus_bool_t dbus_message_append_args_valist   (DBusMessage     *message,
00143                                                int              first_arg_type,
00144                                                va_list          var_args);
00145 dbus_bool_t dbus_message_get_args             (DBusMessage     *message,
00146                                                DBusError       *error,
00147                                                int              first_arg_type,
00148                                                ...);
00149 dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
00150                                                DBusError       *error,
00151                                                int              first_arg_type,
00152                                                va_list          var_args);
00153 
00154 
00155 dbus_bool_t dbus_message_iter_init             (DBusMessage     *message,
00156                                                 DBusMessageIter *iter);
00157 dbus_bool_t dbus_message_iter_has_next         (DBusMessageIter *iter);
00158 dbus_bool_t dbus_message_iter_next             (DBusMessageIter *iter);
00159 char*       dbus_message_iter_get_signature    (DBusMessageIter *iter);
00160 int         dbus_message_iter_get_arg_type     (DBusMessageIter *iter);
00161 int         dbus_message_iter_get_element_type (DBusMessageIter *iter);
00162 void        dbus_message_iter_recurse          (DBusMessageIter *iter,
00163                                                 DBusMessageIter *sub);
00164 void        dbus_message_iter_get_basic        (DBusMessageIter *iter,
00165                                                 void            *value);
00166 int         dbus_message_iter_get_array_len    (DBusMessageIter *iter);
00167 void        dbus_message_iter_get_fixed_array  (DBusMessageIter *iter,
00168                                                 void            *value,
00169                                                 int             *n_elements);
00170 
00171 
00172 void        dbus_message_iter_init_append        (DBusMessage     *message,
00173                                                   DBusMessageIter *iter);
00174 dbus_bool_t dbus_message_iter_append_basic       (DBusMessageIter *iter,
00175                                                   int              type,
00176                                                   const void      *value);
00177 dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
00178                                                   int              element_type,
00179                                                   const void      *value,
00180                                                   int              n_elements);
00181 dbus_bool_t dbus_message_iter_open_container     (DBusMessageIter *iter,
00182                                                   int              type,
00183                                                   const char      *contained_signature,
00184                                                   DBusMessageIter *sub);
00185 dbus_bool_t dbus_message_iter_close_container    (DBusMessageIter *iter,
00186                                                   DBusMessageIter *sub);
00187 
00188 
00189 dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
00190                                            DBusMessage  *message);
00191 
00192 
00193 dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t     *slot_p);
00194 void        dbus_message_free_data_slot     (dbus_int32_t     *slot_p);
00195 dbus_bool_t dbus_message_set_data           (DBusMessage      *message,
00196                                              dbus_int32_t      slot,
00197                                              void             *data,
00198                                              DBusFreeFunction  free_data_func);
00199 void*       dbus_message_get_data           (DBusMessage      *message,
00200                                              dbus_int32_t      slot);
00201 
00202 int dbus_message_type_from_string (const char *type_str);
00203 const char * dbus_message_type_to_string (int type);
00204 
00205 DBUS_END_DECLS
00206 
00207 #endif /* DBUS_MESSAGE_H */

Generated on Tue Jul 7 15:13:59 2009 for D-BUS by  doxygen 1.4.6