alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy Class Reference

#include <DBusProxy.h>

Inheritance diagram for alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy:

Public Member Functions
virtual	~DBusProxy ()
virtual ManagedGVariant	callMethod (const std::string &methodName, GVariant *parameters=nullptr, GError **error=nullptr)
virtual ManagedGVariant	callMethodWithFDList (const std::string &methodName, GVariant *parameters=nullptr, GUnixFDList **outlist=nullptr, GError **error=nullptr)
virtual std::string	getObjectPath () const
virtual GDBusProxy *	get ()

Static Public Member Functions
static std::shared_ptr< DBusProxy >	create (const std::string &interfaceName, const std::string &objectPath)

Protected Member Functions
	DBusProxy (GDBusProxy *proxy, const std::string &objectPath)

Detailed Description

A wrapper class for DBus proxy objects.

Constructor & Destructor Documentation

~DBusProxy()

virtual alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy::~DBusProxy ( )

virtual

DBusProxy()

alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy::DBusProxy ( GDBusProxy *  proxy, const std::string &  objectPath  )

protected

Constructor that initializes the object with an existing GDBusProxy* value. It also receives object path for the object being proxified to keep it for later use.

Parameters

proxy	An existing GDBusProxy* value
objectPath	Object path of an object being proxified

Member Function Documentation

callMethod()

virtual ManagedGVariant alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy::callMethod ( const std::string &  methodName, GVariant *  parameters = nullptr, GError **  error = nullptr  )

virtual

Calls a method of the proxy and returns the its result.

Parameters

	methodName	Name of the method to invoke
	parameters	A GVariant* containing the tuple with the parameters for the method or nullptr if method does not have any parameters
[out]	error	A pointer to a GError* variable that will receive the error returned by method invocation

Returns

The result GVariant* returned by method invocation

callMethodWithFDList()

virtual ManagedGVariant alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy::callMethodWithFDList ( const std::string &  methodName, GVariant *  parameters = nullptr, GUnixFDList **  outlist = nullptr, GError **  error = nullptr  )

virtual

Calls a method of the proxy and returns the its result along with the list of linux file descriptors associated with it.

Parameters

	methodName	Name of the method to invoke
	parameters	A GVariant* containing the tuple with the parameters for the method or nullptr if method does not have any parameters
[out]	outlist	A pointer to GUnixFDList* variable that recieves a list of linux file descriptor list associated with result returned by the method call
[out]	error	A pointer to a GError* variable that will receive the error returned by method invocation

Returns

The result GVariant* returned by method invocation

create()

static std::shared_ptr<DBusProxy> alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy::create ( const std::string &  interfaceName, const std::string &  objectPath  )

static

Factory method to create a new instance of the DBus proxy. DBus proxies are shortcuts that bind to a specific interface of an object and simplifies operations on that object by avoiding providing the object and its interface during the subsequent calls.

Parameters

interfaceName	Name of the DBus interface to be proxified
objectPath	Object path to an object who's interface is to be proxified

Returns

A new instance of DBusProxy on success, nullptr otherwise.

get()

virtual GDBusProxy* alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy::get ( )

virtual

Get the raw GDBusProxy* value associated with the object

Returns

A pointer to GDBusProxy object associated with the this instance. This pointer is valid as long as DBusProxy object is valid.

getObjectPath()

virtual std::string alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy::getObjectPath ( ) const

virtual

Get the path of the object being proxified

Returns

A string containing the object path

---

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

• /workplace/avs-device-sdk/BluetoothImplementations/BlueZ/include/BlueZ/DBusProxy.h