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 #include <gio/giotypes.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_TYPE_DBUS_MESSAGE         (g_dbus_message_get_type ())
  31 #define G_DBUS_MESSAGE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_MESSAGE, GDBusMessage))
  32 #define G_DBUS_MESSAGE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DBUS_MESSAGE, GDBusMessageClass))
  33 #define G_DBUS_MESSAGE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DBUS_MESSAGE, GDBusMessageClass))
  34 #define G_IS_DBUS_MESSAGE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_MESSAGE))
  35 #define G_IS_DBUS_MESSAGE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DBUS_MESSAGE))
  36
  37 typedef struct _GDBusMessageClass   GDBusMessageClass;
  38 typedef struct _GDBusMessagePrivate GDBusMessagePrivate;
  39
  40 /**
  41  * GDBusMessageClass:
  42  *
  43  * Class structure for #GDBusMessage.
  44  *
  45  * Since: 2.26
  46  */
  47 struct _GDBusMessageClass
  48 {
  49   /*< private >*/
  50   GObjectClass parent_class;
  51 };
  52
  53 /**
  54  * GDBusMessage:
  55  *
  56  * The #GDBusMessage structure contains only private data and should
  57  * only be accessed using the provided API.
  58  *
  59  * Since: 2.26
  60  */
  61 struct _GDBusMessage
  62 {
  63   /*< private >*/
  64   GObject parent_instance;
  65   GDBusMessagePrivate *priv;
  66 };
  67
  68 GType                     g_dbus_message_get_type           (void) G_GNUC_CONST;
  69 GDBusMessage             *g_dbus_message_new                (void);
  70 GDBusMessage             *g_dbus_message_new_signal         (const gchar              *path,
  71                                                              const gchar              *interface,
  72                                                              const gchar              *signal);
  73 GDBusMessage             *g_dbus_message_new_method_call    (const gchar              *name,
  74                                                              const gchar              *path,
  75                                                              const gchar              *interface,
  76                                                              const gchar              *method);
  77 GDBusMessage             *g_dbus_message_new_method_reply   (GDBusMessage             *method_call_message);
  78 GDBusMessage             *g_dbus_message_new_method_error   (GDBusMessage             *method_call_message,
  79                                                              const gchar              *error_name,
  80                                                              const gchar              *error_message_format,
  81                                                              ...);
  82 GDBusMessage             *g_dbus_message_new_method_error_valist (GDBusMessage             *method_call_message,
  83                                                                   const gchar              *error_name,
  84                                                                   const gchar              *error_message_format,
  85                                                                   va_list                   var_args);
  86 GDBusMessage             *g_dbus_message_new_method_error_literal (GDBusMessage             *method_call_message,
  87                                                                    const gchar              *error_name,
  88                                                                    const gchar              *error_message);
  89 gchar                    *g_dbus_message_print              (GDBusMessage             *message,
  90                                                              guint                     indent);
  91
  92 GDBusMessageType          g_dbus_message_get_message_type   (GDBusMessage             *message);
  93 void                      g_dbus_message_set_message_type   (GDBusMessage             *message,
  94                                                              GDBusMessageType          type);
  95 GDBusMessageFlags         g_dbus_message_get_flags          (GDBusMessage             *message);
  96 void                      g_dbus_message_set_flags          (GDBusMessage             *message,
  97                                                              GDBusMessageFlags         flags);
  98 guint32                   g_dbus_message_get_serial         (GDBusMessage             *message);
  99 void                      g_dbus_message_set_serial         (GDBusMessage             *message,
 100                                                              guint32                   serial);
 101 GVariant                 *g_dbus_message_get_header         (GDBusMessage             *message,
 102                                                              GDBusMessageHeaderField   header_field);
 103 void                      g_dbus_message_set_header         (GDBusMessage             *message,
 104                                                              GDBusMessageHeaderField   header_field,
 105                                                              GVariant                 *value);
 106 guchar                   *g_dbus_message_get_header_fields  (GDBusMessage             *message);
 107 GVariant                 *g_dbus_message_get_body           (GDBusMessage             *message);
 108 void                      g_dbus_message_set_body           (GDBusMessage             *message,
 109                                                              GVariant                 *body);
 110 GUnixFDList              *g_dbus_message_get_unix_fd_list   (GDBusMessage             *message);
 111 void                      g_dbus_message_set_unix_fd_list   (GDBusMessage             *message,
 112                                                              GUnixFDList              *fd_list);
 113
 114 guint32                   g_dbus_message_get_reply_serial   (GDBusMessage             *message);
 115 void                      g_dbus_message_set_reply_serial   (GDBusMessage             *message,
 116                                                              guint32                   value);
 117
 118 const gchar              *g_dbus_message_get_interface      (GDBusMessage             *message);
 119 void                      g_dbus_message_set_interface      (GDBusMessage             *message,
 120                                                              const gchar              *value);
 121
 122 const gchar              *g_dbus_message_get_member         (GDBusMessage             *message);
 123 void                      g_dbus_message_set_member         (GDBusMessage             *message,
 124                                                              const gchar              *value);
 125
 126 const gchar              *g_dbus_message_get_path           (GDBusMessage             *message);
 127 void                      g_dbus_message_set_path           (GDBusMessage             *message,
 128                                                              const gchar              *value);
 129
 130 const gchar              *g_dbus_message_get_sender         (GDBusMessage             *message);
 131 void                      g_dbus_message_set_sender         (GDBusMessage             *message,
 132                                                              const gchar              *value);
 133
 134 const gchar              *g_dbus_message_get_destination    (GDBusMessage             *message);
 135 void                      g_dbus_message_set_destination    (GDBusMessage             *message,
 136                                                              const gchar              *value);
 137
 138 const gchar              *g_dbus_message_get_error_name     (GDBusMessage             *message);
 139 void                      g_dbus_message_set_error_name     (GDBusMessage             *message,
 140                                                              const gchar              *value);
 141
 142 const gchar              *g_dbus_message_get_signature      (GDBusMessage             *message);
 143 void                      g_dbus_message_set_signature      (GDBusMessage             *message,
 144                                                              const gchar              *value);
 145
 146 guint32                   g_dbus_message_get_num_unix_fds   (GDBusMessage             *message);
 147 void                      g_dbus_message_set_num_unix_fds   (GDBusMessage             *message,
 148                                                              guint32                   value);
 149
 150 const gchar              *g_dbus_message_get_arg0           (GDBusMessage             *message);
 151
 152
 153 GDBusMessage             *g_dbus_message_new_from_blob      (guchar                   *blob,
 154                                                              gsize                     blob_len,
 155                                                              GDBusCapabilityFlags      capabilities,
 156                                                              GError                  **error);
 157
 158 gssize                    g_dbus_message_bytes_needed       (guchar                   *blob,
 159                                                              gsize                     blob_len,
 160                                                              GError                  **error);
 161
 162 guchar                   *g_dbus_message_to_blob            (GDBusMessage             *message,
 163                                                              gsize                    *out_size,
 164                                                              GDBusCapabilityFlags      capabilities,
 165                                                              GError                  **error);
 166
 167 gboolean                  g_dbus_message_to_gerror          (GDBusMessage             *message,
 168                                                              GError                  **error);
 169
 170 G_END_DECLS
 171
 172 #endif /* __G_DBUS_MESSAGE_H__ */