alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface Class Reference

#include <AVSGatewayManagerStorageInterface.h>

Inheritance diagram for alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface:

Public Member Functions
virtual	~AVSGatewayManagerStorageInterface ()=default
virtual bool	init ()=0
virtual bool	loadState (GatewayVerifyState *state)=0
virtual bool	saveState (const GatewayVerifyState &state)=0
virtual void	clear ()=0

Detailed Description

The interface class for AVSGatewayManager Storage.

Constructor & Destructor Documentation

~AVSGatewayManagerStorageInterface()

virtual alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface::~AVSGatewayManagerStorageInterface ( )

virtualdefault

Destructor.

Member Function Documentation

clear()

virtual void alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface::clear ( )

pure virtual

Clears the stored data from the database.

Implemented in alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage.

init()

virtual bool alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface::init ( )

pure virtual

Initializes the underlying database.

Returns

True if successful, else false.

Implemented in alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage.

loadState()

virtual bool alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface::loadState ( GatewayVerifyState *  state )

pure virtual

Loads the GatewayVerifyState from the database.

Parameters

state

The pointer to the GatewayVerifyState that will populated. If the default state is passed and there is no data to be loaded, the state remains unchanged.

Returns

True if load is successful, else false.

Implemented in alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage.

saveState()

virtual bool alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface::saveState ( const GatewayVerifyState &  state )

pure virtual

Saves the given state to the database.

Parameters

state

The GatewayVerifyState to be saved.

Returns

True if successful, else false.

Implemented in alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage.

---

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

• /workplace/avs-device-sdk/AVSGatewayManager/include/AVSGatewayManager/Storage/AVSGatewayManagerStorageInterface.h