alexaClientSDK::acsdkShutdownManager::ShutdownManager Class Reference

#include <ShutdownManager.h>

Inheritance diagram for alexaClientSDK::acsdkShutdownManager::ShutdownManager:

Collaboration diagram for alexaClientSDK::acsdkShutdownManager::ShutdownManager:

Public Member Functions
ShutdownManagerInterface methods.
bool	shutdown () override
Public Member Functions inherited from alexaClientSDK::acsdkShutdownManagerInterfaces::ShutdownManagerInterface
virtual	~ShutdownManagerInterface ()=default

Static Public Member Functions
static std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownManagerInterface >	createShutdownManagerInterface (const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &notifier)

Detailed Description

Implementation of ShutdownManagerInterface.

When shutdown() is called, observers that have added themselves via ShutdownNotifierInterface will have their shutdown() method called.

Member Function Documentation

createShutdownManagerInterface()

static std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface> alexaClientSDK::acsdkShutdownManager::ShutdownManager::createShutdownManagerInterface ( const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &  notifier )

static

Create a new instance of ShutdownManagerInterface.

Parameters

notifier

The notifier to use to invoke RequiresShutdown::shutdown().

shutdown()

bool alexaClientSDK::acsdkShutdownManager::ShutdownManager::shutdown ( )

overridevirtual

Invoke shutdown() on all instances registered with the ShutdownNotifierInterface instance associated with this instance.

Returns

Whether shutdown was successful. This can fail if new objects are registered with ShutdownNotifierInterface while shutdown() is in progress.

Implements alexaClientSDK::acsdkShutdownManagerInterfaces::ShutdownManagerInterface.

---

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

• /workplace/avs-device-sdk/shared/acsdkShutdownManager/include/acsdkShutdownManager/ShutdownManager.h