g_dbus_message_new ()

GDBusMessage *
g_dbus_message_new (void);

Creates a new empty GDBusMessage.

Since 2.26

g_dbus_message_new_signal ()

GDBusMessage *
g_dbus_message_new_signal (const gchar *path,
                           const gchar *interface_,
                           const gchar *signal);

Creates a new GDBusMessage for a signal emission.

Since 2.26

g_dbus_message_new_method_call ()

GDBusMessage *
g_dbus_message_new_method_call (const gchar *name,
                                const gchar *path,
                                const gchar *interface_,
                                const gchar *method);

Creates a new GDBusMessage for a method call.

Since 2.26

g_dbus_message_new_method_reply ()

GDBusMessage *
g_dbus_message_new_method_reply (GDBusMessage *method_call_message);

Creates a new GDBusMessage that is a reply to method_call_message .

Since 2.26

g_dbus_message_new_method_error ()

GDBusMessage *
g_dbus_message_new_method_error (GDBusMessage *method_call_message,
                                 const gchar *error_name,
                                 const gchar *error_message_format,
                                 ...);

Creates a new GDBusMessage that is an error reply to method_call_message .

Since 2.26

g_dbus_message_new_method_error_valist ()

GDBusMessage *
g_dbus_message_new_method_error_valist
                               (GDBusMessage *method_call_message,
                                const gchar *error_name,
                                const gchar *error_message_format,
                                va_list var_args);

Like g_dbus_message_new_method_error() but intended for language bindings.

Since 2.26

g_dbus_message_new_method_error_literal ()

GDBusMessage *
g_dbus_message_new_method_error_literal
                               (GDBusMessage *method_call_message,
                                const gchar *error_name,
                                const gchar *error_message);

Creates a new GDBusMessage that is an error reply to method_call_message .

Since 2.26

g_dbus_message_print ()

gchar *
g_dbus_message_print (GDBusMessage *message,
                      guint indent);

Produces a human-readable multi-line description of message .

The contents of the description has no ABI guarantees, the contents and formatting is subject to change at any time. Typical output looks something like this:

1
2
3
4
5
6
7
8
9
10
11
12

Type:    method-call
Flags:   none
Version: 0
Serial:  4
Headers:
  path -> objectpath '/org/gtk/GDBus/TestObject'
  interface -> 'org.gtk.GDBus.TestInterface'
  member -> 'GimmeStdout'
  destination -> ':1.146'
Body: ()
UNIX File Descriptors:
  (none)

or

1
2
3
4
5
6
7
8
9
10
11
12

Type:    method-return
Flags:   no-reply-expected
Version: 0
Serial:  477
Headers:
  reply-serial -> uint32 4
  destination -> ':1.159'
  sender -> ':1.146'
  num-unix-fds -> uint32 1
Body: ()
UNIX File Descriptors:
  fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635

Since 2.26

g_dbus_message_get_locked ()

gboolean
g_dbus_message_get_locked (GDBusMessage *message);

Checks whether message is locked. To monitor changes to this value, conncet to the “notify” signal to listen for changes on the “locked” property.

Since 2.26

g_dbus_message_lock ()

void
g_dbus_message_lock (GDBusMessage *message);

If message is locked, does nothing. Otherwise locks the message.

Since 2.26

g_dbus_message_copy ()

GDBusMessage *
g_dbus_message_copy (GDBusMessage *message,
                     GError **error);

Copies message . The copy is a deep copy and the returned GDBusMessage is completely identical except that it is guaranteed to not be locked.

This operation can fail if e.g. message contains file descriptors and the per-process or system-wide open files limit is reached.

Since 2.26

g_dbus_message_get_byte_order ()

GDBusMessageByteOrder
g_dbus_message_get_byte_order (GDBusMessage *message);

Gets the byte order of message .

g_dbus_message_set_byte_order ()

void
g_dbus_message_set_byte_order (GDBusMessage *message,
                               GDBusMessageByteOrder byte_order);

Sets the byte order of message .

g_dbus_message_get_message_type ()

GDBusMessageType
g_dbus_message_get_message_type (GDBusMessage *message);

Gets the type of message .

Since 2.26

g_dbus_message_set_message_type ()

void
g_dbus_message_set_message_type (GDBusMessage *message,
                                 GDBusMessageType type);

Sets message to be of type .

Since 2.26

g_dbus_message_get_serial ()

guint32
g_dbus_message_get_serial (GDBusMessage *message);

Gets the serial for message .

Since 2.26

g_dbus_message_set_serial ()

void
g_dbus_message_set_serial (GDBusMessage *message,
                           guint32 serial);

Sets the serial for message .

Since 2.26

g_dbus_message_get_flags ()

GDBusMessageFlags
g_dbus_message_get_flags (GDBusMessage *message);

Gets the flags for message .

Since 2.26

g_dbus_message_set_flags ()

void
g_dbus_message_set_flags (GDBusMessage *message,
                          GDBusMessageFlags flags);

Sets the flags to set on message .

Since 2.26

g_dbus_message_get_body ()

GVariant *
g_dbus_message_get_body (GDBusMessage *message);

Gets the body of a message.

Since 2.26

g_dbus_message_set_body ()

void
g_dbus_message_set_body (GDBusMessage *message,
                         GVariant *body);

Sets the body message . As a side-effect the G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the type string of body (or cleared if body is NULL).

If body is floating, message assumes ownership of body .

Since 2.26

g_dbus_message_get_unix_fd_list ()

GUnixFDList *
g_dbus_message_get_unix_fd_list (GDBusMessage *message);

Gets the UNIX file descriptors associated with message , if any.

This method is only available on UNIX.

Since 2.26

g_dbus_message_set_unix_fd_list ()

void
g_dbus_message_set_unix_fd_list (GDBusMessage *message,
                                 GUnixFDList *fd_list);

Sets the UNIX file descriptors associated with message . As a side-effect the G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field is set to the number of fds in fd_list (or cleared if fd_list is NULL).

This method is only available on UNIX.

Since 2.26

g_dbus_message_get_num_unix_fds ()

guint32
g_dbus_message_get_num_unix_fds (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.

Since 2.26

g_dbus_message_set_num_unix_fds ()

void
g_dbus_message_set_num_unix_fds (GDBusMessage *message,
                                 guint32 value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.

Since 2.26

g_dbus_message_get_header_fields ()

guchar *
g_dbus_message_get_header_fields (GDBusMessage *message);

Gets an array of all header fields on message that are set.

Since 2.26

g_dbus_message_get_header ()

GVariant *
g_dbus_message_get_header (GDBusMessage *message,
                           GDBusMessageHeaderField header_field);

Gets a header field on message .

Since 2.26

g_dbus_message_set_header ()

void
g_dbus_message_set_header (GDBusMessage *message,
                           GDBusMessageHeaderField header_field,
                           GVariant *value);

Sets a header field on message .

If value is floating, message assumes ownership of value .

Since 2.26

g_dbus_message_get_destination ()

const gchar *
g_dbus_message_get_destination (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.

Since 2.26

g_dbus_message_set_destination ()

void
g_dbus_message_set_destination (GDBusMessage *message,
                                const gchar *value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.

Since 2.26

g_dbus_message_get_error_name ()

const gchar *
g_dbus_message_get_error_name (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.

Since 2.26

g_dbus_message_set_error_name ()

void
g_dbus_message_set_error_name (GDBusMessage *message,
                               const gchar *value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.

Since 2.26

g_dbus_message_get_interface ()

const gchar *
g_dbus_message_get_interface (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.

Since 2.26

g_dbus_message_set_interface ()

void
g_dbus_message_set_interface (GDBusMessage *message,
                              const gchar *value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.

Since 2.26

g_dbus_message_get_member ()

const gchar *
g_dbus_message_get_member (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.

Since 2.26

g_dbus_message_set_member ()

void
g_dbus_message_set_member (GDBusMessage *message,
                           const gchar *value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.

Since 2.26

g_dbus_message_get_path ()

const gchar *
g_dbus_message_get_path (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.

Since 2.26

g_dbus_message_set_path ()

void
g_dbus_message_set_path (GDBusMessage *message,
                         const gchar *value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.

Since 2.26

g_dbus_message_get_reply_serial ()

guint32
g_dbus_message_get_reply_serial (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.

Since 2.26

g_dbus_message_set_reply_serial ()

void
g_dbus_message_set_reply_serial (GDBusMessage *message,
                                 guint32 value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.

Since 2.26

g_dbus_message_get_sender ()

const gchar *
g_dbus_message_get_sender (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.

Since 2.26

g_dbus_message_set_sender ()

void
g_dbus_message_set_sender (GDBusMessage *message,
                           const gchar *value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.

Since 2.26

g_dbus_message_get_signature ()

const gchar *
g_dbus_message_get_signature (GDBusMessage *message);

Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.

Since 2.26

g_dbus_message_set_signature ()

void
g_dbus_message_set_signature (GDBusMessage *message,
                              const gchar *value);

Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.

Since 2.26

g_dbus_message_get_arg0 ()

const gchar *
g_dbus_message_get_arg0 (GDBusMessage *message);

Convenience to get the first item in the body of message .

Since 2.26

g_dbus_message_to_blob ()

guchar *
g_dbus_message_to_blob (GDBusMessage *message,
                        gsize *out_size,
                        GDBusCapabilityFlags capabilities,
                        GError **error);

Serializes message to a blob. The byte order returned by g_dbus_message_get_byte_order() will be used.

Since 2.26

g_dbus_message_bytes_needed ()

gssize
g_dbus_message_bytes_needed (guchar *blob,
                             gsize blob_len,
                             GError **error);

Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at blob .

Since 2.26

g_dbus_message_new_from_blob ()

GDBusMessage *
g_dbus_message_new_from_blob (guchar *blob,
                              gsize blob_len,
                              GDBusCapabilityFlags capabilities,
                              GError **error);

Creates a new GDBusMessage from the data stored at blob . The byte order that the message was in can be retrieved using g_dbus_message_get_byte_order().

Since 2.26

g_dbus_message_to_gerror ()

gboolean
g_dbus_message_to_gerror (GDBusMessage *message,
                          GError **error);

If message is not of type G_DBUS_MESSAGE_TYPE_ERROR does nothing and returns FALSE.

Otherwise this method encodes the error in message as a GError using g_dbus_error_set_dbus_error() using the information in the G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of message as well as the first string item in message 's body.

Since 2.26

GDBusMessage

typedef struct _GDBusMessage GDBusMessage;

The GDBusMessage structure contains only private data and should only be accessed using the provided API.

Since 2.26

enum GDBusMessageType

Message types used in GDBusMessage.

Since 2.26

enum GDBusMessageFlags

Message flags used in GDBusMessage.

Since 2.26

enum GDBusMessageHeaderField

Header fields used in GDBusMessage.

Since 2.26

enum GDBusMessageByteOrder

Enumeration used to describe the byte order of a D-Bus message.

Since 2.26

The “locked” property

  “locked”                   gboolean

Whether the message is locked.

Flags: Read

Default value: FALSE