alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType > Class Template Reference

Generic observer operations interface. More...

#include <NotifierInterface.h>

Inheritance diagram for alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >:

Public Member Functions
virtual	~NotifierInterface ()=default
virtual void	addObserver (const std::shared_ptr< ObserverType > &observer)=0
	Add an observer. More...
virtual void	removeObserver (const std::shared_ptr< ObserverType > &observer)=0
	Remove an observer. More...
virtual void	addWeakPtrObserver (const std::weak_ptr< ObserverType > &observer)=0
	Add a weak reference to an observer. More...
virtual void	removeWeakPtrObserver (const std::weak_ptr< ObserverType > &observer)=0
	Remove an observer. More...
virtual void	notifyObservers (std::function< void(const std::shared_ptr< ObserverType > &)> notify)=0
	Notify the observers in the order that they were added. More...
virtual bool	notifyObserversInReverse (std::function< void(const std::shared_ptr< ObserverType > &)> notify)=0
	Notify the observers in the reverse order that they were added. More...
virtual void	setAddObserverFunction (std::function< void(const std::shared_ptr< ObserverType > &)> postAddFunc)=0
	Set a function for notifications on an observer additions. More...

Detailed Description

template<typename ObserverType>
class alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >

Generic observer operations interface.

Interface for maintaining a set of observers that are notified with a caller defined function.

Template Parameters

ObserverType

The type of observer notified by the template instantiation.

Constructor & Destructor Documentation

~NotifierInterface()

template<typename ObserverType>

virtual alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >::~NotifierInterface ( )

virtualdefault

Destructor.

Member Function Documentation

addObserver()

template<typename ObserverType>

virtual void alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >::addObserver ( const std::shared_ptr< ObserverType > &  observer )

pure virtual

Add an observer.

Method adds a strong reference to observer. If the same observer has already been added as a strong or weak reference, the method does nothing.

If the observer function has been installed prior to this call, it will be invoked with the newly added observer.

Parameters

[in]

observer

The observer to add. If observer is nullptr, the method does nothing.

Deprecated:

In the future, Notifier will no longer maintain the life cycle of its observers. Please start using the new addWeakPtrObserver() API instead.

Implemented in alexaClientSDK::notifier::Notifier< ObserverType >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaInputControllerInterfaces::InputControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< T > >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerObserverInterface >, alexaClientSDK::notifier::Notifier< clientInterfaces::ArtifactChangeObserver >, alexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkSystemClockMonitorInterfaces::SystemClockMonitorObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkNotificationsInterfaces::NotificationsObserverInterface >, alexaClientSDK::notifier::Notifier< avsCommon::utils::RequiresShutdown >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::GUIActivityEventObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkStartupManagerInterfaces::RequiresStartupInterface >, and alexaClientSDK::notifier::Notifier< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface >.

addWeakPtrObserver()

template<typename ObserverType>

virtual void alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >::addWeakPtrObserver ( const std::weak_ptr< ObserverType > &  observer )

pure virtual

Add a weak reference to an observer.

Method adds a weak reference to observer. If the same observer has already been added as a strong or weak reference, the method does nothing.

If the observer function has been installed prior to this call, it will be invoked with the newly added observer.

Parameters

[in]

observer

The observer to add. If observer is nullptr, the method does nothing.

Note

Lifecycle of observer will not be managed by the Notifier. If observer object is expired, then no callback will be called to that object.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper, alexaClientSDK::notifier::Notifier< ObserverType >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaInputControllerInterfaces::InputControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< T > >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerObserverInterface >, alexaClientSDK::notifier::Notifier< clientInterfaces::ArtifactChangeObserver >, alexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkSystemClockMonitorInterfaces::SystemClockMonitorObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkNotificationsInterfaces::NotificationsObserverInterface >, alexaClientSDK::notifier::Notifier< avsCommon::utils::RequiresShutdown >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::GUIActivityEventObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkStartupManagerInterfaces::RequiresStartupInterface >, and alexaClientSDK::notifier::Notifier< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface >.

notifyObservers()

template<typename ObserverType>

virtual void alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >::notifyObservers ( std::function< void(const std::shared_ptr< ObserverType > &)>  notify )

pure virtual

Notify the observers in the order that they were added.

Parameters

[in]

notify

The function to invoke to notify an observer.

Implemented in alexaClientSDK::notifier::Notifier< ObserverType >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaInputControllerInterfaces::InputControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< T > >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerObserverInterface >, alexaClientSDK::notifier::Notifier< clientInterfaces::ArtifactChangeObserver >, alexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkSystemClockMonitorInterfaces::SystemClockMonitorObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkNotificationsInterfaces::NotificationsObserverInterface >, alexaClientSDK::notifier::Notifier< avsCommon::utils::RequiresShutdown >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::GUIActivityEventObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkStartupManagerInterfaces::RequiresStartupInterface >, and alexaClientSDK::notifier::Notifier< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface >.

notifyObserversInReverse()

template<typename ObserverType>

virtual bool alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >::notifyObserversInReverse ( std::function< void(const std::shared_ptr< ObserverType > &)>  notify )

pure virtual

Notify the observers in the reverse order that they were added.

Parameters

notify

The function to invoke to notify an observer.

Returns

true if (and only if) all observers were notified (observers added during calls to this method will miss out).

Implemented in alexaClientSDK::notifier::Notifier< ObserverType >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaInputControllerInterfaces::InputControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< T > >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerObserverInterface >, alexaClientSDK::notifier::Notifier< clientInterfaces::ArtifactChangeObserver >, alexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkSystemClockMonitorInterfaces::SystemClockMonitorObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkNotificationsInterfaces::NotificationsObserverInterface >, alexaClientSDK::notifier::Notifier< avsCommon::utils::RequiresShutdown >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::GUIActivityEventObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkStartupManagerInterfaces::RequiresStartupInterface >, and alexaClientSDK::notifier::Notifier< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface >.

removeObserver()

template<typename ObserverType>

virtual void alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >::removeObserver ( const std::shared_ptr< ObserverType > &  observer )

pure virtual

Remove an observer.

Method removes a strong or weak reference to observer. If the class doesn't have a strong or weak reference to observer, the method does nothing.

Parameters

[in]

observer

The observer to remove. If observer is nullptr, the method does nothing.

Deprecated:

In the future, Notifier will no longer maintain the life cycle of its observers. Please start using the new removeWeakPtrObserver() API instead.

Implemented in alexaClientSDK::notifier::Notifier< ObserverType >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaInputControllerInterfaces::InputControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< T > >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerObserverInterface >, alexaClientSDK::notifier::Notifier< clientInterfaces::ArtifactChangeObserver >, alexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkSystemClockMonitorInterfaces::SystemClockMonitorObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkNotificationsInterfaces::NotificationsObserverInterface >, alexaClientSDK::notifier::Notifier< avsCommon::utils::RequiresShutdown >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::GUIActivityEventObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkStartupManagerInterfaces::RequiresStartupInterface >, and alexaClientSDK::notifier::Notifier< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface >.

removeWeakPtrObserver()

template<typename ObserverType>

virtual void alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >::removeWeakPtrObserver ( const std::weak_ptr< ObserverType > &  observer )

pure virtual

Remove an observer.

Method removes a strong or weak reference to observer. If the class doesn't have a strong or weak reference to observer, the method does nothing.

Parameters

[in]

observer

The observer to remove. If observer is nullptr, the method does nothing.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper, alexaClientSDK::notifier::Notifier< ObserverType >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaInputControllerInterfaces::InputControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< T > >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerObserverInterface >, alexaClientSDK::notifier::Notifier< clientInterfaces::ArtifactChangeObserver >, alexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkSystemClockMonitorInterfaces::SystemClockMonitorObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkNotificationsInterfaces::NotificationsObserverInterface >, alexaClientSDK::notifier::Notifier< avsCommon::utils::RequiresShutdown >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::GUIActivityEventObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkStartupManagerInterfaces::RequiresStartupInterface >, and alexaClientSDK::notifier::Notifier< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface >.

setAddObserverFunction()

template<typename ObserverType>

virtual void alexaClientSDK::notifierInterfaces::NotifierInterface< ObserverType >::setAddObserverFunction ( std::function< void(const std::shared_ptr< ObserverType > &)>  postAddFunc )

pure virtual

Set a function for notifications on an observer additions.

Set the function to be called after an observer is added (for example, to notify the newly-added observer of the current state).

If there's any observers that were added before setAddObserverFunction is called, those added observers will be notified as well.

Use caution when setting this function. The function MUST be reentrant, or else you run the risk of deadlock. When an observer adds itself to a NotifierInterface, this function will be called in the same context.

Parameters

[in]

postAddFunc

The function to call after an observer is added.

Implemented in alexaClientSDK::notifier::Notifier< ObserverType >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaInputControllerInterfaces::InputControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< T > >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerObserverInterface >, alexaClientSDK::notifier::Notifier< clientInterfaces::ArtifactChangeObserver >, alexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >, alexaClientSDK::notifier::Notifier< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkSystemClockMonitorInterfaces::SystemClockMonitorObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkNotificationsInterfaces::NotificationsObserverInterface >, alexaClientSDK::notifier::Notifier< avsCommon::utils::RequiresShutdown >, alexaClientSDK::notifier::Notifier< avsCommon::sdkInterfaces::GUIActivityEventObserverInterface >, alexaClientSDK::notifier::Notifier< acsdkStartupManagerInterfaces::RequiresStartupInterface >, and alexaClientSDK::notifier::Notifier< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface >.

---

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

• /workplace/avs-device-sdk/shared/NotifierInterfaces/include/acsdk/NotifierInterfaces/NotifierInterface.h