AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Static Public Member Functions | List of all members
alexaClientSDK::acsdkShutdownManager::ShutdownManager Class Reference

#include <ShutdownManager.h>

Inheritance diagram for alexaClientSDK::acsdkShutdownManager::ShutdownManager:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkShutdownManager::ShutdownManager:
Collaboration graph
[legend]

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::ShutdownManagerInterfacecreateShutdownManagerInterface (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()

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

Create a new instance of ShutdownManagerInterface.

Parameters
notifierThe 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 files:

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