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