otbr::DBus::DBusRequest Class Reference

#include <src/dbus/server/dbus_request.hpp>

Public Member Functions
	DBusRequest (DBusConnection *aConnection, DBusMessage *aMessage)
	DBusRequest (const DBusRequest &aOther)
DBusRequest &	operator= (const DBusRequest &aOther)
DBusMessage *	GetMessage (void)
DBusConnection *	GetConnection (void)
template<typename... Args>
void	Reply (const std::tuple< Args... > &aReply)
template<typename ResultType = int>
void	ReplyOtResult (otError aError, Optional< ResultType > aResult=Optional< ResultType >())
	~DBusRequest (void)

Detailed Description

This class represents a incoming call for a d-bus method.

Constructor & Destructor Documentation

DBusRequest() [1/2]

otbr::DBus::DBusRequest::DBusRequest ( DBusConnection *  aConnection, DBusMessage *  aMessage  )

inline

The constructor of dbus request.

Parameters

[in]	aConnection	The dbus connection.
[in]	aMessage	The incoming dbus message.

DBusRequest() [2/2]

otbr::DBus::DBusRequest::DBusRequest ( const DBusRequest &  aOther )

inline

The copy constructor of dbus request.

Parameters

[in]

aOther

The object to be copied from.

~DBusRequest()

otbr::DBus::DBusRequest::~DBusRequest ( void  )

inline

The destructor of DBusRequest

Member Function Documentation

GetConnection()

DBusConnection* otbr::DBus::DBusRequest::GetConnection ( void  )

inline

This method returns underlying d-bus connection.

Returns

The dbus connection.

GetMessage()

DBusMessage* otbr::DBus::DBusRequest::GetMessage ( void  )

inline

This method returns the message sent to call the d-bus method.

Returns

The dbus message.

operator=()

DBusRequest& otbr::DBus::DBusRequest::operator= ( const DBusRequest &  aOther )

inline

The assignment operator of dbus request.

Parameters

[in]

aOther

The object to be copied from.

Reply()

template<typename... Args>

void otbr::DBus::DBusRequest::Reply ( const std::tuple< Args... > &  aReply )

inline

This method replies to the d-bus method call.

Parameters

[in]

aReply

The tuple to be sent.

ReplyOtResult()

template<typename ResultType = int>

void otbr::DBus::DBusRequest::ReplyOtResult ( otError  aError, Optional< ResultType >  aResult = Optional<ResultType>()  )

inline

This method replies an otError to the d-bus method call.

Parameters

[in]	aError	The error to be sent.
[in]	aResult	The return value of the method call, if any.

---

The documentation for this class was generated from the following file:

• src/dbus/server/dbus_request.hpp