Package com.lucimber.dbus.message

Class OutboundSignal

java.lang.Object

com.lucimber.dbus.message.OutboundSignal

All Implemented Interfaces:

Message, OutboundMessage

public final class OutboundSignal
extends Object
implements OutboundMessage

An outbound signal message.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OutboundSignal.Builder

Constructor Summary

Constructors

Constructor	Description
OutboundSignal(DBusUInt32 serial, DBusObjectPath path, DBusString iface, DBusString member, DBusString dst, DBusSignature signature, List<? extends DBusType> payload)	Constructs a new instance with all parameter.

Method Summary

Modifier and Type	Method	Description
Optional<DBusString>	getDestination()	Gets the unique name of the destination.
DBusString	getInterfaceName()	Gets the name of the interface, to which this signal belongs.
DBusString	getMember()	Gets the name of this signal.
DBusObjectPath	getObjectPath()	Gets the object path of this signal.
List<DBusType>	getPayload()	Gets the payload of this D-Bus message.
DBusUInt32	getSerial()	Gets the serial number of this D-Bus message.
Optional<DBusSignature>	getSignature()	Gets the signature of the payload.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.lucimber.dbus.message.Message

getPayload, getSerial, getSignature

Constructor Details

OutboundSignal

public OutboundSignal(DBusUInt32 serial,
 DBusObjectPath path,
 DBusString iface,
 DBusString member,
 DBusString dst,
 DBusSignature signature,
 List<? extends DBusType> payload)

Constructs a new instance with all parameter.

Parameters:

serial - the serial number

path - the object path

iface - the name of the interface

member - the name of this signal

dst - optional; the destination of this signal

signature - optional; the signature of the message body

payload - optional; the message body

Method Details

getDestination

public Optional<DBusString> getDestination()

Description copied from interface: OutboundMessage

Gets the unique name of the destination.

Specified by:

getDestination in interface OutboundMessage

Returns:

an Optional of DBusString

toString

public String toString()

getObjectPath

public DBusObjectPath getObjectPath()

Gets the object path of this signal.

Returns:

The path as an DBusObjectPath.

getMember

public DBusString getMember()

Gets the name of this signal.

Returns:

a DBusString

getInterfaceName

public DBusString getInterfaceName()

Gets the name of the interface, to which this signal belongs.

Returns:

a DBusString

getSerial

public DBusUInt32 getSerial()

Description copied from interface: Message

Gets the serial number of this D-Bus message.

Specified by:

getSerial in interface Message

Returns:

an DBusUInt32

getPayload

public List<DBusType> getPayload()

Description copied from interface: Message

Gets the payload of this D-Bus message.

Specified by:

getPayload in interface Message

Returns:

a List of DBusTypes.

getSignature

public Optional<DBusSignature> getSignature()

Description copied from interface: Message

Gets the signature of the payload.

Specified by:

getSignature in interface Message

Returns:

an Optional of DBusSignature