alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface Class Reference

#include <BluetoothHostControllerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface:

Public Member Functions
virtual	~BluetoothHostControllerInterface ()=default
	Destructor. More...
virtual std::string	getMac () const =0
virtual std::string	getFriendlyName () const =0
virtual bool	isDiscoverable () const =0
virtual std::future< bool >	enterDiscoverableMode ()=0
virtual std::future< bool >	exitDiscoverableMode ()=0
virtual bool	isScanning () const =0
virtual std::future< bool >	startScan ()=0
virtual std::future< bool >	stopScan ()=0

Detailed Description

An interface to represent the HostControllerInterface on the local system. This is responsible for Scanning and Discovery.

Constructor & Destructor Documentation

~BluetoothHostControllerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::~BluetoothHostControllerInterface ( )

virtualdefault

Destructor.

Member Function Documentation

enterDiscoverableMode()

virtual std::future<bool> alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::enterDiscoverableMode ( )

pure virtual

Set the adapter to become discoverable.

Returns

Indicates whether the operation was successful.

Implemented in alexaClientSDK::bluetoothImplementations::blueZ::BlueZHostController, and alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::test::MockBluetoothHostController.

exitDiscoverableMode()

virtual std::future<bool> alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::exitDiscoverableMode ( )

pure virtual

Set the adapter to become non-discoverable.

Returns

Indicates whether the operation was successful.

Implemented in alexaClientSDK::bluetoothImplementations::blueZ::BlueZHostController, and alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::test::MockBluetoothHostController.

getFriendlyName()

virtual std::string alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::getFriendlyName ( ) const

pure virtual

Getter for the friendly name of the adapter.

Returns

The friendly name of the adapter.

Implemented in alexaClientSDK::bluetoothImplementations::blueZ::BlueZHostController, and alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::test::MockBluetoothHostController.

getMac()

virtual std::string alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::getMac ( ) const

pure virtual

Getter for the MAC address of the adapter.

Returns

The MAC address of the adapter.

Implemented in alexaClientSDK::bluetoothImplementations::blueZ::BlueZHostController, and alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::test::MockBluetoothHostController.

isDiscoverable()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::isDiscoverable ( ) const

pure virtual

Getter for the discoverability of the device. This must wait until any prior enterDiscoverableMode or exitDiscoverableMode methods have finished.

Returns

Whether the device is currently discoverable by other devices.

Implemented in alexaClientSDK::bluetoothImplementations::blueZ::BlueZHostController, and alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::test::MockBluetoothHostController.

isScanning()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::isScanning ( ) const

pure virtual

Getter for the scanning state of the device. This must wait until any prior startScan or stopScan methods have finished.

Returns

Whether the device is currently scanning for other devices.

Implemented in alexaClientSDK::bluetoothImplementations::blueZ::BlueZHostController, and alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::test::MockBluetoothHostController.

startScan()

virtual std::future<bool> alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::startScan ( )

pure virtual

Set the adapter to start scanning.

Returns

Indicates whether the operation was successful.

Implemented in alexaClientSDK::bluetoothImplementations::blueZ::BlueZHostController, and alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::test::MockBluetoothHostController.

stopScan()

virtual std::future<bool> alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterface::stopScan ( )

pure virtual

Set the adapter to stop scanning.

Returns

Indicates whether the operation was successful.

Implemented in alexaClientSDK::bluetoothImplementations::blueZ::BlueZHostController, and alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::test::MockBluetoothHostController.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/Bluetooth/BluetoothHostControllerInterface.h