Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.DBusMessage

Class Gio.DBusMessage

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GDBusMessage
Class :	DBusMessage
Extends:	GObject.Object

A type for representing D-Bus messages that can be sent or received
on a GDBusConnection.

Properties
Properties		Defined By
	locked : gboolean read only	Gio.DBusMessage

Methods / Constructors
Method / Constructor		Defined By
	new Gio.DBusMessage (Object *properties) Create a new Gio.DBusMessage Create a new Gio.DBusMessage Parameters: Object properties*
	new Gio.DBusMessage.from_blob (guint8 *blob, guint32 blob_len, DBusCapabilityFlags capabilities) : Gio.DBusMessage Create a new Gio.DBusMessage Create a new Gio.DBusMessage Parameters: guint8 blob* Required (not null) A blob represent a binary D-Bus message. guint32 blob_len Required (not null) The length of blob. Gio.DBusCapabilityFlags capabilities Required (not null) A GDBusCapabilityFlags describing what protocol features are supported. Returns: Gio.DBusMessage A new GDBusMessage or NULL if error is set. Free with
	new Gio.DBusMessage.method_call (String *name, String path, String interface_, String method) : Gio.DBusMessage Create a new Gio.DBusMessage Create a new Gio.DBusMessage Parameters: String name* Required (not null) A valid D-Bus name or NULL. String path Required (not null) A valid object path. String interface_ Required (not null) A valid D-Bus interface name or NULL. String method Required (not null) A valid method name. Returns: Gio.DBusMessage A GDBusMessage. Free with g_object_unref().
	new Gio.DBusMessage.signal (String *path, String interface_, String signal) : Gio.DBusMessage Create a new Gio.DBusMessage Create a new Gio.DBusMessage Parameters: String path* Required (not null) A valid object path. String interface_ Required (not null) A valid D-Bus interface name. String signal Required (not null) A valid signal name. Returns: Gio.DBusMessage A GDBusMessage. Free with g_object_unref().
	Gio.DBusMessage.bytes_needed (guint8 *blob, guint32 blob_len) : gint32 Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at blob. Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at blob. determine the size). Parameters: guint8 blob* Required (not null) A blob represent a binary D-Bus message. guint32 blob_len Required (not null) The length of blob (must be at least 16). Returns: gint32 Number of bytes needed or -1 if error is set (e.g. if	Gio.DBusMessage
	copy () : Gio.DBusMessage Copies message. 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. g_object_unref(). Returns: Gio.DBusMessage A new GDBusMessage or NULL if error is set. Free with	Gio.DBusMessage
	get_arg0 () : String Convenience to get the first item in the body of message. Convenience to get the first item in the body of message. Returns: String The string item or NULL if the first item in the body of	Gio.DBusMessage
	get_body () : GLib.Variant Gets the body of a message. Gets the body of a message. Returns: GLib.Variant A GVariant or NULL if the body is empty. Do not free, it is owned by message.	Gio.DBusMessage
	get_byte_order () : Gio.DBusMessageByteOrder Gets the byte order of message. Gets the byte order of message. Returns: Gio.DBusMessageByteOrder The byte order.	Gio.DBusMessage
	get_destination () : String Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. Returns: String The value.	Gio.DBusMessage
	get_error_name () : String Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. Returns: String The value.	Gio.DBusMessage
	get_flags () : Gio.DBusMessageFlags Gets the flags for message. Gets the flags for message. Returns: Gio.DBusMessageFlags Flags that are set (typically values from the GDBusMessageFlags enumeration bitwise ORed together).	Gio.DBusMessage
	get_header (DBusMessageHeaderField *header_field) : GLib.Variant Gets a header field on message. Gets a header field on message. otherwise. Do not free, it is owned by message. Parameters: Gio.DBusMessageHeaderField header_field* Required (not null) A 8-bit unsigned integer (typically a value from the GDBusMessageHeaderField enumeration) Returns: GLib.Variant A GVariant with the value if the header was found, NULL	Gio.DBusMessage
	get_header_fields () : guint8 Gets an array of all header fields on message that are set. Gets an array of all header fields on message that are set. G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a guchar. Free with g_free(). Returns: guint8 An array of header fields terminated by	Gio.DBusMessage
	get_interface () : String Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. Returns: String The value.	Gio.DBusMessage
	get_locked () : gboolean Checks whether message is locked. Checks whether message is locked. To monitor changes to this value, conncet to the GObject::notify signal to listen for changes on the GDBusMessage:locked property. Returns: gboolean TRUE if message is locked, FALSE otherwise.	Gio.DBusMessage
	get_member () : String Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. Returns: String The value.	Gio.DBusMessage
	get_message_type () : Gio.DBusMessageType Gets the type of message. Gets the type of message. Returns: Gio.DBusMessageType A 8-bit unsigned integer (typically a value from the GDBusMessageType enumeration).	Gio.DBusMessage
	get_num_unix_fds () : guint32 Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. Returns: guint32 The value.	Gio.DBusMessage
	get_path () : String Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. Returns: String The value.	Gio.DBusMessage
	get_reply_serial () : guint32 Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. Returns: guint32 The value.	Gio.DBusMessage
	get_sender () : String Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. Returns: String The value.	Gio.DBusMessage
	get_serial () : guint32 Gets the serial for message. Gets the serial for message. Returns: guint32 A guint32.	Gio.DBusMessage
	get_signature () : String Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. Convenience getter for the G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. Returns: String The value.	Gio.DBusMessage
	get_unix_fd_list () : Gio.UnixFDList Gets the UNIX file descriptors associated with message, if any. Gets the UNIX file descriptors associated with message, if any. This method is only available on UNIX. associated. Do not free, this object is owned by message. Returns: Gio.UnixFDList A GUnixFDList or NULL if no file descriptors are	Gio.DBusMessage
	lock () : none If message is locked, does nothing. If message is locked, does nothing. Otherwise locks the message. Returns: none	Gio.DBusMessage
	new_method_error_literal (String *error_name, String error_message) : Gio.DBusMessage Creates a new GDBusMessage* that is an error reply to method_call_message. Creates a new GDBusMessage that is an error reply to method_call_message. Parameters: String error_name Required (not null) A valid D-Bus error name. String error_message Required (not null) The D-Bus error message. Returns: Gio.DBusMessage A GDBusMessage. Free with g_object_unref().	Gio.DBusMessage
	new_method_reply () : Gio.DBusMessage Creates a new GDBusMessage that is a reply to method_call_message. Creates a new GDBusMessage that is a reply to method_call_message. Returns: Gio.DBusMessage GDBusMessage. Free with g_object_unref().	Gio.DBusMessage
	print (guint32 *indent) : String Produces a human-readable multi-line description of message. 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: Headers: path -> objectpath '/org/gtk/GDBus/TestObject' interface -> 'org.gtk.GDBus.TestInterface' member -> 'GimmeStdout' destination -> ':1.146' UNIX File Descriptors: (none) or Headers: reply-serial -> uint32 4 destination -> ':1.159' sender -> ':1.146' num-unix-fds -> uint32 1 UNIX File Descriptors: Parameters: guint32 indent* Required (not null) Indentation level. Returns: String A string that should be freed with g_free().	Gio.DBusMessage
	set_body (Variant *body) : none Sets the body message. 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. Parameters: GLib.Variant body Required (not null) Either NULL or a GVariant that is a tuple. Returns: none	Gio.DBusMessage
	set_byte_order (DBusMessageByteOrder *byte_order) : none Sets the byte order of message. Sets the byte order of message. Parameters: Gio.DBusMessageByteOrder byte_order* Required (not null) The byte order. Returns: none	Gio.DBusMessage
	set_destination (String *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. Parameters: String value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_error_name (String *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. Parameters: String value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_flags (DBusMessageFlags *flags) : none Sets the flags to set on message. Sets the flags to set on message. Parameters: Gio.DBusMessageFlags flags* Required (not null) Flags for message that are set (typically values from the GDBusMessageFlags enumeration bitwise ORed together). Returns: none	Gio.DBusMessage
	set_header (DBusMessageHeaderField *header_field, Variant value) : none Sets a header field on message. Sets a header field on message. If value* is floating, message assumes ownership of value. Parameters: Gio.DBusMessageHeaderField header_field Required (not null) A 8-bit unsigned integer (typically a value from the GDBusMessageHeaderField enumeration) GLib.Variant value Required (not null) A GVariant to set the header field or NULL to clear the header field. Returns: none	Gio.DBusMessage
	set_interface (String *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. Parameters: String value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_member (String *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_MEMBER* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. Parameters: String value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_message_type (DBusMessageType *type) : none Sets message* to be of type. Sets message to be of type. Parameters: Gio.DBusMessageType type Required (not null) A 8-bit unsigned integer (typically a value from the GDBusMessageType enumeration). Returns: none	Gio.DBusMessage
	set_num_unix_fds (guint32 *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. Parameters: guint32 value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_path (String *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_PATH* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. Parameters: String value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_reply_serial (guint32 *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. Parameters: guint32 value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_sender (String *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_SENDER* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. Parameters: String value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_serial (guint32 *serial) : none Sets the serial for message. Sets the serial for message. Parameters: guint32 serial* Required (not null) A guint32. Returns: none	Gio.DBusMessage
	set_signature (String *value) : none Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE* header field. Convenience setter for the G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. Parameters: String value Required (not null) The value to set. Returns: none	Gio.DBusMessage
	set_unix_fd_list (UnixFDList *fd_list) : none Sets the UNIX file descriptors associated with message. 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 This method is only available on UNIX. Parameters: Gio.UnixFDList fd_list A GUnixFDList or NULL. Returns: none	Gio.DBusMessage
	to_blob (guint32 *out_size, DBusCapabilityFlags capabilities) : guint8 Serializes message* to a blob. Serializes message to a blob. The byte order returned by g_dbus_message_get_byte_order() will be used. generated by message or NULL if error is set. Free with g_free(). Parameters: guint32 out_size Required (not null) Return location for size of generated blob. Gio.DBusCapabilityFlags capabilities Required (not null) A GDBusCapabilityFlags describing what protocol features are supported. Returns: guint8 A pointer to a valid binary D-Bus message of out_size bytes	Gio.DBusMessage
	to_gerror () : gboolean If message is not of type G_DBUS_MESSAGE_TYPE_ERROR does nothing and returns FALSE. 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. Returns: gboolean TRUE if error was set, FALSE otherwise.	Gio.DBusMessage

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gio.DBusConnection Method	send_message (DBusMessage *message, DBusSendMessageFlags flags, guint32 out_serial) : gboolean Asynchronously sends message* to the peer represented by connection.
Gio.DBusConnection Method	send_message_with_reply (DBusMessage *message, DBusSendMessageFlags flags, gint32 timeout_msec, guint32 out_serial, Cancellable cancellable, Function callback, void *user_data) : none Asynchronously sends message* to the peer represented by connection.
Gio.DBusConnection Method	send_message_with_reply_finish (AsyncResult *res*) : Gio.DBusMessage Finishes an operation started with g_dbus_connection_send_message_with_reply().
Gio.DBusConnection Method	send_message_with_reply_sync (DBusMessage *message, DBusSendMessageFlags flags, gint32 timeout_msec, guint32 out_serial, Cancellable cancellable) : Gio.DBusMessage Synchronously sends message* to the peer represented by connection and blocks the calling thread until a reply is received or the timeout is reached.
Gio.DBusMethodInvocation Method	get_message () : Gio.DBusMessage Gets the GDBusMessage for the method invocation.

Un-official Seed Documentation

Gio

Classes

Interfaces

Structs

Unions

Enums

Class Gio.DBusMessage