gio/gdbusmessage.h

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #ifndef __G_DBUS_MESSAGE_H__
  24 #define __G_DBUS_MESSAGE_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_DBUS_MESSAGE         (g_dbus_message_get_type ())
  35 #define G_DBUS_MESSAGE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_MESSAGE, GDBusMessage))
  36 #define G_IS_DBUS_MESSAGE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_MESSAGE))
  37
  38 GLIB_AVAILABLE_IN_ALL
  39 GType                     g_dbus_message_get_type           (void) G_GNUC_CONST;
  40 GLIB_AVAILABLE_IN_ALL
  41 GDBusMessage             *g_dbus_message_new                (void);
  42 GLIB_AVAILABLE_IN_ALL
  43 GDBusMessage             *g_dbus_message_new_signal         (const gchar              *path,
  44                                                              const gchar              *interface_,
  45                                                              const gchar              *signal);
  46 GLIB_AVAILABLE_IN_ALL
  47 GDBusMessage             *g_dbus_message_new_method_call    (const gchar              *name,
  48                                                              const gchar              *path,
  49                                                              const gchar              *interface_,
  50                                                              const gchar              *method);
  51 GLIB_AVAILABLE_IN_ALL
  52 GDBusMessage             *g_dbus_message_new_method_reply   (GDBusMessage             *method_call_message);
  53 GLIB_AVAILABLE_IN_ALL
  54 GDBusMessage             *g_dbus_message_new_method_error   (GDBusMessage             *method_call_message,
  55                                                              const gchar              *error_name,
  56                                                              const gchar              *error_message_format,
  57                                                              ...);
  58 GLIB_AVAILABLE_IN_ALL
  59 GDBusMessage             *g_dbus_message_new_method_error_valist (GDBusMessage             *method_call_message,
  60                                                                   const gchar              *error_name,
  61                                                                   const gchar              *error_message_format,
  62                                                                   va_list                   var_args);
  63 GLIB_AVAILABLE_IN_ALL
  64 GDBusMessage             *g_dbus_message_new_method_error_literal (GDBusMessage             *method_call_message,
  65                                                                    const gchar              *error_name,
  66                                                                    const gchar              *error_message);
  67 GLIB_AVAILABLE_IN_ALL
  68 gchar                    *g_dbus_message_print              (GDBusMessage             *message,
  69                                                              guint                     indent);
  70 GLIB_AVAILABLE_IN_ALL
  71 gboolean                  g_dbus_message_get_locked         (GDBusMessage             *message);
  72 GLIB_AVAILABLE_IN_ALL
  73 void                      g_dbus_message_lock               (GDBusMessage             *message);
  74 GLIB_AVAILABLE_IN_ALL
  75 GDBusMessage             *g_dbus_message_copy               (GDBusMessage             *message,
  76                                                              GError                  **error);
  77 GLIB_AVAILABLE_IN_ALL
  78 GDBusMessageByteOrder     g_dbus_message_get_byte_order     (GDBusMessage             *message);
  79 GLIB_AVAILABLE_IN_ALL
  80 void                      g_dbus_message_set_byte_order     (GDBusMessage             *message,
  81                                                              GDBusMessageByteOrder     byte_order);
  82
  83 GLIB_AVAILABLE_IN_ALL
  84 GDBusMessageType          g_dbus_message_get_message_type   (GDBusMessage             *message);
  85 GLIB_AVAILABLE_IN_ALL
  86 void                      g_dbus_message_set_message_type   (GDBusMessage             *message,
  87                                                              GDBusMessageType          type);
  88 GLIB_AVAILABLE_IN_ALL
  89 GDBusMessageFlags         g_dbus_message_get_flags          (GDBusMessage             *message);
  90 GLIB_AVAILABLE_IN_ALL
  91 void                      g_dbus_message_set_flags          (GDBusMessage             *message,
  92                                                              GDBusMessageFlags         flags);
  93 GLIB_AVAILABLE_IN_ALL
  94 guint32                   g_dbus_message_get_serial         (GDBusMessage             *message);
  95 GLIB_AVAILABLE_IN_ALL
  96 void                      g_dbus_message_set_serial         (GDBusMessage             *message,
  97                                                              guint32                   serial);
  98 GLIB_AVAILABLE_IN_ALL
  99 GVariant                 *g_dbus_message_get_header         (GDBusMessage             *message,
 100                                                              GDBusMessageHeaderField   header_field);
 101 GLIB_AVAILABLE_IN_ALL
 102 void                      g_dbus_message_set_header         (GDBusMessage             *message,
 103                                                              GDBusMessageHeaderField   header_field,
 104                                                              GVariant                 *value);
 105 GLIB_AVAILABLE_IN_ALL
 106 guchar                   *g_dbus_message_get_header_fields  (GDBusMessage             *message);
 107 GLIB_AVAILABLE_IN_ALL
 108 GVariant                 *g_dbus_message_get_body           (GDBusMessage             *message);
 109 GLIB_AVAILABLE_IN_ALL
 110 void                      g_dbus_message_set_body           (GDBusMessage             *message,
 111                                                              GVariant                 *body);
 112 GLIB_AVAILABLE_IN_ALL
 113 GUnixFDList              *g_dbus_message_get_unix_fd_list   (GDBusMessage             *message);
 114 GLIB_AVAILABLE_IN_ALL
 115 void                      g_dbus_message_set_unix_fd_list   (GDBusMessage             *message,
 116                                                              GUnixFDList              *fd_list);
 117
 118 GLIB_AVAILABLE_IN_ALL
 119 guint32                   g_dbus_message_get_reply_serial   (GDBusMessage             *message);
 120 GLIB_AVAILABLE_IN_ALL
 121 void                      g_dbus_message_set_reply_serial   (GDBusMessage             *message,
 122                                                              guint32                   value);
 123
 124 GLIB_AVAILABLE_IN_ALL
 125 const gchar              *g_dbus_message_get_interface      (GDBusMessage             *message);
 126 GLIB_AVAILABLE_IN_ALL
 127 void                      g_dbus_message_set_interface      (GDBusMessage             *message,
 128                                                              const gchar              *value);
 129
 130 GLIB_AVAILABLE_IN_ALL
 131 const gchar              *g_dbus_message_get_member         (GDBusMessage             *message);
 132 GLIB_AVAILABLE_IN_ALL
 133 void                      g_dbus_message_set_member         (GDBusMessage             *message,
 134                                                              const gchar              *value);
 135
 136 GLIB_AVAILABLE_IN_ALL
 137 const gchar              *g_dbus_message_get_path           (GDBusMessage             *message);
 138 GLIB_AVAILABLE_IN_ALL
 139 void                      g_dbus_message_set_path           (GDBusMessage             *message,
 140                                                              const gchar              *value);
 141
 142 GLIB_AVAILABLE_IN_ALL
 143 const gchar              *g_dbus_message_get_sender         (GDBusMessage             *message);
 144 GLIB_AVAILABLE_IN_ALL
 145 void                      g_dbus_message_set_sender         (GDBusMessage             *message,
 146                                                              const gchar              *value);
 147
 148 GLIB_AVAILABLE_IN_ALL
 149 const gchar              *g_dbus_message_get_destination    (GDBusMessage             *message);
 150 GLIB_AVAILABLE_IN_ALL
 151 void                      g_dbus_message_set_destination    (GDBusMessage             *message,
 152                                                              const gchar              *value);
 153
 154 GLIB_AVAILABLE_IN_ALL
 155 const gchar              *g_dbus_message_get_error_name     (GDBusMessage             *message);
 156 GLIB_AVAILABLE_IN_ALL
 157 void                      g_dbus_message_set_error_name     (GDBusMessage             *message,
 158                                                              const gchar              *value);
 159
 160 GLIB_AVAILABLE_IN_ALL
 161 const gchar              *g_dbus_message_get_signature      (GDBusMessage             *message);
 162 GLIB_AVAILABLE_IN_ALL
 163 void                      g_dbus_message_set_signature      (GDBusMessage             *message,
 164                                                              const gchar              *value);
 165
 166 GLIB_AVAILABLE_IN_ALL
 167 guint32                   g_dbus_message_get_num_unix_fds   (GDBusMessage             *message);
 168 GLIB_AVAILABLE_IN_ALL
 169 void                      g_dbus_message_set_num_unix_fds   (GDBusMessage             *message,
 170                                                              guint32                   value);
 171
 172 GLIB_AVAILABLE_IN_ALL
 173 const gchar              *g_dbus_message_get_arg0           (GDBusMessage             *message);
 174
 175
 176 GLIB_AVAILABLE_IN_ALL
 177 GDBusMessage             *g_dbus_message_new_from_blob      (guchar                   *blob,
 178                                                              gsize                     blob_len,
 179                                                              GDBusCapabilityFlags      capabilities,
 180                                                              GError                  **error);
 181
 182 GLIB_AVAILABLE_IN_ALL
 183 gssize                    g_dbus_message_bytes_needed       (guchar                   *blob,
 184                                                              gsize                     blob_len,
 185                                                              GError                  **error);
 186
 187 GLIB_AVAILABLE_IN_ALL
 188 guchar                   *g_dbus_message_to_blob            (GDBusMessage             *message,
 189                                                              gsize                    *out_size,
 190                                                              GDBusCapabilityFlags      capabilities,
 191                                                              GError                  **error);
 192
 193 GLIB_AVAILABLE_IN_ALL
 194 gboolean                  g_dbus_message_to_gerror          (GDBusMessage             *message,
 195                                                              GError                  **error);
 196
 197 G_END_DECLS
 198
 199 #endif /* __G_DBUS_MESSAGE_H__ */