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