Class DBus::Message
In: lib/dbus/message.rb
Parent: Object

D-Bus message class

Class that holds any type of message that travels over the bus.

Methods

add_param   error   marshall   method_return   new   reply_to   unmarshall   unmarshall_buffer  

Constants

MESSAGE_SIGNATURE = "yyyyuua(yv)"   Type of a message (by specification).
INVALID = 0   FIXME: following message type constants should be under Message::Type IMO well, yeah sure

Invalid message type.

METHOD_CALL = 1   Method call message type.
METHOD_RETURN = 2   Method call return value message type.
ERROR = 3   Error message type.
SIGNAL = 4   Signal message type.
NO_REPLY_EXPECTED = 0x1   Message flag signyfing that no reply is expected.
NO_AUTO_START = 0x2   Message flag signifying that no automatic start is required/must be performed.
PATH = 1   FIXME: what are these? a message element constant enumeration? See method below, in a message, you have and array of optional parameters that come with an index, to determine their meaning. The values are in spec, more a definition than an enumeration.
INTERFACE = 2
MEMBER = 3
ERROR_NAME = 4
REPLY_SERIAL = 5
DESTINATION = 6
SENDER = 7
SIGNATURE = 8

Attributes

destination  [RW]  The destination connection of the object that must be used/was used.
error_name  [RW]  The name of the error (in case of an error message type).
interface  [RW]  The interface of the object that must be used/was used.
member  [RW]  The interface member (method/signal name) of the object that must be used/was used.
message_type  [R]  The type of the message.
params  [R]  The parameters of the message.
path  [RW]  The path of the object instance the message must be sent to/is sent from.
protocol  [R]  The protocol.
reply_serial  [RW]  The serial number of the message this message is a reply for.
sender  [RW]  The sender of the message.
serial  [R]  The serial of the message.
signature  [RW]  The signature of the message contents.

Public Class methods

error(m, error_name, description=nil)

Create an error reply to a message m.

method_return(m)

Create a regular reply to a message m.

new(mtype = INVALID)

Create a message with message type mtype with default values and a unique serial number.

Public Instance methods

add_param(type, val)

Add a parameter val of type type to the message.

marshall()

Marshall the message with its current set parameters and return it in a packet form.

reply_to(m)

Mark this message as a reply to a another message m, taking the serial number of m as reply serial and the sender of m as destination.

unmarshall(buf)

Unmarshall the data of a message found in the buffer buf using Message#unmarshall_buf. Return the message.

unmarshall_buffer(buf)

Unmarshall a packet contained in the buffer buf and set the parameters of the message object according the data found in the buffer. Return the detected message and the index pointer of the buffer where the message data ended.

[Validate]