AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | List of all members
alexaClientSDK::acsdkNotifier::Notifier< ObserverType > Class Template Reference

#include <Notifier.h>

Inheritance diagram for alexaClientSDK::acsdkNotifier::Notifier< ObserverType >:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkNotifier::Notifier< ObserverType >:
Collaboration graph
[legend]

Public Member Functions

 Notifier ()
 
NotifierInterface methods
void addObserver (const std::shared_ptr< ObserverType > &observer) override
 
void removeObserver (const std::shared_ptr< ObserverType > &observer) override
 
void addWeakPtrObserver (const std::weak_ptr< ObserverType > &observer) override
 
void removeWeakPtrObserver (const std::weak_ptr< ObserverType > &observer) override
 
void notifyObservers (std::function< void(const std::shared_ptr< ObserverType > &)> notify) override
 
bool notifyObserversInReverse (std::function< void(const std::shared_ptr< ObserverType > &)> notify) override
 
void setAddObserverFunction (std::function< void(const std::shared_ptr< ObserverType > &)> addObserverFunc) override
 
- Public Member Functions inherited from alexaClientSDK::acsdkNotifierInterfaces::NotifierInterface< ObserverType >
virtual ~NotifierInterface ()=default
 

Detailed Description

template<typename ObserverType>
class alexaClientSDK::acsdkNotifier::Notifier< ObserverType >

Notifier maintains a set of observers that are notified with a caller defined function.

Template Parameters
ObserverTypeThe type of observer notified by the template instantiation.

Constructor & Destructor Documentation

◆ Notifier()

template<typename ObserverType >
alexaClientSDK::acsdkNotifier::Notifier< ObserverType >::Notifier ( )
inline

Constructor.

Member Function Documentation

◆ addObserver()

template<typename ObserverType>
void alexaClientSDK::acsdkNotifier::Notifier< ObserverType >::addObserver ( const std::shared_ptr< ObserverType > &  observer)
inlineoverridevirtual

Add an observer. Duplicate additions are ignored.

Parameters
observerThe observer to add.
Deprecated:
In the future, Notifier will no longer maintain the life cycle of its observers. Please start using the new addWeakPtrObserver() API instead.

Implements alexaClientSDK::acsdkNotifierInterfaces::NotifierInterface< ObserverType >.

◆ addWeakPtrObserver()

template<typename ObserverType>
void alexaClientSDK::acsdkNotifier::Notifier< ObserverType >::addWeakPtrObserver ( const std::weak_ptr< ObserverType > &  observer)
inlineoverridevirtual

Add an observer with weak_ptr. Duplicate additions are ignored.

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

Implements alexaClientSDK::acsdkNotifierInterfaces::NotifierInterface< ObserverType >.

◆ notifyObservers()

template<typename ObserverType>
void alexaClientSDK::acsdkNotifier::Notifier< ObserverType >::notifyObservers ( std::function< void(const std::shared_ptr< ObserverType > &)>  notify)
inlineoverridevirtual

Notify the observers in the order that they were added.

Parameters
notifyThe function to invoke to notify an observer.

Implements alexaClientSDK::acsdkNotifierInterfaces::NotifierInterface< ObserverType >.

◆ notifyObserversInReverse()

template<typename ObserverType>
bool alexaClientSDK::acsdkNotifier::Notifier< ObserverType >::notifyObserversInReverse ( std::function< void(const std::shared_ptr< ObserverType > &)>  notify)
inlineoverridevirtual

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

Parameters
notifyThe 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).

Implements alexaClientSDK::acsdkNotifierInterfaces::NotifierInterface< ObserverType >.

◆ removeObserver()

template<typename ObserverType>
void alexaClientSDK::acsdkNotifier::Notifier< ObserverType >::removeObserver ( const std::shared_ptr< ObserverType > &  observer)
inlineoverridevirtual

Remove an observer. Invalid requests (nullptr or non member observers) are ignored.

Parameters
observerThe observer to remove.
Deprecated:
In the future, Notifier will no longer maintain the life cycle of its observers. Please start using the new removeWeakPtrObserver() API instead.

Implements alexaClientSDK::acsdkNotifierInterfaces::NotifierInterface< ObserverType >.

◆ removeWeakPtrObserver()

template<typename ObserverType>
void alexaClientSDK::acsdkNotifier::Notifier< ObserverType >::removeWeakPtrObserver ( const std::weak_ptr< ObserverType > &  observer)
inlineoverridevirtual

Remove an observer with weak_ptr. Invalid requests (nullptr or non member observers) are ignored.

Parameters
observerThe observer to remove.

Implements alexaClientSDK::acsdkNotifierInterfaces::NotifierInterface< ObserverType >.

◆ setAddObserverFunction()

template<typename ObserverType>
void alexaClientSDK::acsdkNotifier::Notifier< ObserverType >::setAddObserverFunction ( std::function< void(const std::shared_ptr< ObserverType > &)>  postAddFunc)
inlineoverridevirtual

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
postAddFuncThe function to call after an observer is added.

Implements alexaClientSDK::acsdkNotifierInterfaces::NotifierInterface< ObserverType >.


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

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0