alexaClientSDK::avsCommon::utils::bluetooth::BluetoothEventBus Class Reference

#include <BluetoothEventBus.h>

Public Types
using	ListenerList = std::list< std::weak_ptr< BluetoothEventListenerInterface > >

Public Member Functions
	BluetoothEventBus ()
void	sendEvent (const BluetoothEvent &event)
void	addListener (const std::vector< BluetoothEventType > &eventTypes, std::shared_ptr< BluetoothEventListenerInterface > listener)
void	removeListener (const std::vector< BluetoothEventType > &eventTypes, std::shared_ptr< BluetoothEventListenerInterface > listener)

Static Public Member Functions
static std::shared_ptr< BluetoothEventBus >	createBluetoothEventBus ()

Detailed Description

Event bus class for Bluetooth CA. Publishes Bluetooth events to all listeners.

Member Typedef Documentation

ListenerList

using alexaClientSDK::avsCommon::utils::bluetooth::BluetoothEventBus::ListenerList = std::list<std::weak_ptr<BluetoothEventListenerInterface> >

A type representing a collection of EventListener objects.

Constructor & Destructor Documentation

BluetoothEventBus()

alexaClientSDK::avsCommon::utils::bluetooth::BluetoothEventBus::BluetoothEventBus

(

)

Constructor

Member Function Documentation

addListener()

void alexaClientSDK::avsCommon::utils::bluetooth::BluetoothEventBus::addListener	(	const std::vector< BluetoothEventType > &	eventTypes,
		std::shared_ptr< BluetoothEventListenerInterface >	listener
	)

Adds a listener to the bus.

Parameters

eventTypes	A list of event types to subscribe listener to.
listener	An EventListener<EventT> object to add as a listener. Listener cannot be registered multiple times for the same BluetoothEventType.

createBluetoothEventBus()

static std::shared_ptr<BluetoothEventBus> alexaClientSDK::avsCommon::utils::bluetooth::BluetoothEventBus::createBluetoothEventBus ( )

static

Factory method to create a shared pointer to BluetoothEventBus.

Returns

A new instance of BluetoothEventBus.

removeListener()

void alexaClientSDK::avsCommon::utils::bluetooth::BluetoothEventBus::removeListener	(	const std::vector< BluetoothEventType > &	eventTypes,
		std::shared_ptr< BluetoothEventListenerInterface >	listener
	)

Removes a listener from the EventBus.

Parameters

eventTypes	A list of event types to unsubscribe listener from.
listener	Listener object to unsubscribe.

sendEvent()

void alexaClientSDK::avsCommon::utils::bluetooth::BluetoothEventBus::sendEvent

(

const BluetoothEvent &

event

)

Send the event to EventBus. Method blocks until all the listeners process the event. The method is thread safe.

Parameters

event

Event to be sent to EventBus

---

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

• /workplace/avs-device-sdk/AVSCommon/Utils/include/AVSCommon/Utils/Bluetooth/BluetoothEventBus.h