DBusMessage

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool locked { get; }

Static methods:

• public static ssize_t bytes_needed (uchar[] blob, size_t blob_len) throws Error
  Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at blob.

Creation methods:

• public DBusMessage ()
  Creates a new empty DBusMessage.
• public DBusMessage.from_blob (uchar[] blob, size_t blob_len, DBusCapabilityFlags capabilities) throws Error
  Creates a new DBusMessage from the data stored at blob. The byte order that the message was in can be retrieved using get_byte_order.
• public DBusMessage.method_call (string name, string path, string interface_, string method)
  Creates a new DBusMessage for a method call.
• public DBusMessage.method_error (DBusMessage method_call_message, string error_name, string error_message_format)
  Creates a new DBusMessage that is an error reply to method_call_message.
• public DBusMessage.method_error_literal (DBusMessage method_call_message, string error_name, string error_message)
  Creates a new DBusMessage that is an error reply to method_call_message.
• public DBusMessage.method_error_valist (DBusMessage method_call_message, string error_name, string error_message_format, void* var_args)
  Like DBusMessage.method_error but intended for language bindings.
• public DBusMessage.method_reply (DBusMessage method_call_message)
  Creates a new DBusMessage that is a reply to method_call_message.
• public DBusMessage.signal (string path, string interface_, string signal)
  Creates a new DBusMessage for a signal emission.

Methods:

• public weak DBusMessage copy () throws Error
  Copies message. The copy is a deep copy and the returned DBusMessage is completely identical except that it is guaranteed to not be locked.
• public unowned string get_arg0 ()
  Convenience to get the first item in the body of message.
• public weak Variant get_body ()
  Gets the body of a message.
• public DBusMessageByteOrder get_byte_order ()
  Gets the byte order of message.
• public unowned string get_destination ()
  Convenience getter for the DESTINATION header field.
• public unowned string get_error_name ()
  Convenience getter for the ERROR_NAME header field.
• public DBusMessageFlags get_flags ()
  Gets the flags for message.
• public weak Variant get_header (DBusMessageHeaderField header_field)
  Gets a header field on message.
• public weak uchar[] get_header_fields ()
  Gets an array of all header fields on message that are set.
• public unowned string get_interface ()
  Convenience getter for the INTERFACE header field.
• public bool get_locked ()
  Checks whether message is locked. To monitor changes to this value, conncet to the notify signal to listen for changes on the locked property.
• public unowned string get_member ()
  Convenience getter for the MEMBER header field.
• public DBusMessageType get_message_type ()
  Gets the type of message.
• public uint32 get_num_unix_fds ()
  Convenience getter for the NUM_UNIX_FDS header field.
• public unowned string get_path ()
  Convenience getter for the PATH header field.
• public uint32 get_reply_serial ()
  Convenience getter for the REPLY_SERIAL header field.
• public unowned string get_sender ()
  Convenience getter for the SENDER header field.
• public uint32 get_serial ()
  Gets the serial for message.
• public unowned string get_signature ()
  Convenience getter for the SIGNATURE header field.
• public unowned UnixFDList get_unix_fd_list ()
  Gets the UNIX file descriptors associated with message, if any.
• public void lock ()
  If message is locked, does nothing. Otherwise locks the message.
• public unowned string print (uint indent = 0)
  Produces a human-readable multi-line description of message.
• public void set_body (Variant body)
  Sets the body message. As a side-effect the SIGNATURE header field is set to the type string of body (or cleared if body is null).
• public void set_byte_order (DBusMessageByteOrder byte_order)
  Sets the byte order of message.
• public void set_destination (string value)
  Convenience setter for the DESTINATION header field.
• public void set_error_name (string value)
  Convenience setter for the ERROR_NAME header field.
• public void set_flags (DBusMessageFlags flags)
  Sets the flags to set on message.
• public void set_header (DBusMessageHeaderField header_field, Variant value)
  Sets a header field on message.
• public void set_interface (string value)
  Convenience setter for the INTERFACE header field.
• public void set_member (string value)
  Convenience setter for the MEMBER header field.
• public void set_message_type (DBusMessageType type)
  Sets message to be of type.
• public void set_num_unix_fds (uint32 value)
  Convenience setter for the NUM_UNIX_FDS header field.
• public void set_path (string value)
  Convenience setter for the PATH header field.
• public void set_reply_serial (uint32 value)
  Convenience setter for the REPLY_SERIAL header field.
• public void set_sender (string value)
  Convenience setter for the SENDER header field.
• public void set_serial (uint32 serial)
  Sets the serial for message.
• public void set_signature (string value)
  Convenience setter for the SIGNATURE header field.
• public void set_unix_fd_list (UnixFDList fd_list)
  Sets the UNIX file descriptors associated with message. As a side-effect the NUM_UNIX_FDS header field is set to the number of fds in fd_list (or cleared if fd_list is null).
• public weak uchar[] to_blob (size_t out_size, DBusCapabilityFlags capabilities) throws Error
  Serializes message to a blob. The byte order returned by get_byte_order will be used.
• public bool to_gerror () throws Error
  If message is not of type ERROR does nothing and returns false.