Package com.lucimber.dbus.message

Class OutboundMethodCall

java.lang.Object

com.lucimber.dbus.message.OutboundMethodCall

All Implemented Interfaces:

Message, OutboundMessage

public final class OutboundMethodCall
extends Object
implements OutboundMessage

An outbound method call.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OutboundMethodCall.Builder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<DBusString>	getDestination()	Gets the unique name of the destination.
Optional<DBusString>	getInterfaceName()	Gets the name of the interface, to which this method belongs.
DBusString	getMember()	Gets the name of this method.
DBusObjectPath	getObjectPath()	Gets the object path of this method.
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.
Optional<Duration>	getTimeout()	Gets the timeout override for this method call.
boolean	isReplyExpected()	States if the sender expects a reply to this method call or not.
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

OutboundMethodCall

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

Constructs a new instance with all parameter. Please use the builder instead.

Parameters:

serial - the serial number

path - the object path

member - the name of the method

replyExpected - states if reply is expected

dst - optional; the destination of this method call

iface - optional; the name of the interface

signature - optional; the signature of the message body

payload - optional; the message body

OutboundMethodCall

public OutboundMethodCall(DBusUInt32 serial,
 DBusObjectPath path,
 DBusString member,
 boolean replyExpected,
 DBusString dst,
 DBusString iface,
 DBusSignature signature,
 List<? extends DBusType> payload,
 Duration timeout)

Constructs a new instance with all parameter including timeout. Please use the builder instead.

Parameters:

serial - the serial number

path - the object path

member - the name of the method

replyExpected - states if reply is expected

dst - optional; the destination of this method call

iface - optional; the name of the interface

signature - optional; the signature of the message body

payload - optional; the message body

timeout - optional; timeout override for this specific call

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

isReplyExpected

public boolean isReplyExpected()

States if the sender expects a reply to this method call or not.

Returns:

TRUE if reply is expected, FALSE otherwise.

getTimeout

public Optional<Duration> getTimeout()

Gets the timeout override for this method call.

Returns:

the timeout duration, or empty if no override is specified

toString

public String toString()

getObjectPath

public DBusObjectPath getObjectPath()

Gets the object path of this method.

Returns:

an DBusObjectPath

getMember

public DBusString getMember()

Gets the name of this method.

Returns:

a DBusString

getInterfaceName

public Optional<DBusString> getInterfaceName()

Gets the name of the interface, to which this method 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