alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage Class Reference

#include <AVSGatewayManagerStorage.h>

Inheritance diagram for alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage:

Collaboration diagram for alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage:

Public Member Functions
AVSGatewayManagerStorageInterface Functions
bool	init () override
bool	loadState (GatewayVerifyState *state) override
bool	saveState (const GatewayVerifyState &state) override
void	clear () override
Public Member Functions inherited from alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface
virtual	~AVSGatewayManagerStorageInterface ()=default

Static Public Member Functions
static std::unique_ptr< AVSGatewayManagerStorageInterface >	createAVSGatewayManagerStorageInterface (const std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > &miscStorage)
static std::unique_ptr< AVSGatewayManagerStorage >	create (std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > miscStorage)

Detailed Description

Wrapper to the MiscStorageInterface used by the AVSGatewayManager to store gateway verification state information.

Member Function Documentation

clear()

void alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage::clear ( )

overridevirtual

Clears the stored data from the database.

Implements alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface.

create()

static std::unique_ptr<AVSGatewayManagerStorage> alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage::create ( std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface >  miscStorage )

static

Creates an instance of the AVSGatewayManagerStorage.

Parameters

miscStorage

The underlying miscellaneous storage to store gateway verification data.

Returns

A unique pointer to the instance of the newly created AVSGatewayManagerStorage.

createAVSGatewayManagerStorageInterface()

static std::unique_ptr<AVSGatewayManagerStorageInterface> alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage::createAVSGatewayManagerStorageInterface ( const std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > &  miscStorage )

static

Creates an instance of @ AVSGatewayManagerStorageInterface.

Parameters

miscStorage

The underlying miscellaneous storage to store gateway verification data.

Returns

A unique pointer to the instance of the newly created AVSGatewayManagerStorage.

init()

bool alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage::init ( )

overridevirtual

Initializes the underlying database.

Returns

True if successful, else false.

Implements alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface.

loadState()

bool alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorage::loadState ( GatewayVerifyState *  state )

overridevirtual

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.

Implements alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface.

saveState()

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

overridevirtual

Saves the given state to the database.

Parameters

state

The GatewayVerifyState to be saved.

Returns

True if successful, else false.

Implements alexaClientSDK::avsGatewayManager::storage::AVSGatewayManagerStorageInterface.

---

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

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