AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkShutdownManagerInterfaces::ShutdownManagerInterface Class Referenceabstract

#include <ShutdownManagerInterface.h>

Inheritance diagram for alexaClientSDK::acsdkShutdownManagerInterfaces::ShutdownManagerInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~ShutdownManagerInterface ()=default
 
virtual bool shutdown ()=0
 

Detailed Description

Interface for driving shutdown.

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

Constructor & Destructor Documentation

◆ ~ShutdownManagerInterface()

virtual alexaClientSDK::acsdkShutdownManagerInterfaces::ShutdownManagerInterface::~ShutdownManagerInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ shutdown()

virtual bool alexaClientSDK::acsdkShutdownManagerInterfaces::ShutdownManagerInterface::shutdown ( )
pure virtual

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.

Implemented in alexaClientSDK::acsdkShutdownManager::ShutdownManager.


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

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