rad  3.0.0
Public Member Functions | List of all members
hellomal::DbInterface Class Reference

#include <dbInterface.hpp>

Public Member Functions

 DbInterface (const std::string &prefix, rad::DbAdapter &runtime_db)
 
virtual ~DbInterface ()
 
std::string GetControlState ()
 
std::string Get (const std::string &key)
 
void SetControlState (const std::string &value)
 
void SetConfig (Config &cfg)
 
void Set (const std::string &key, const std::string &value)
 
 DbInterface (const DbInterface &)=delete
 
DbInterfaceoperator= (const DbInterface &)=delete
 Disable copy constructor. More...
 
 DbInterface (const std::string &prefix, rad::DbAdapter &runtime_db)
 
virtual ~DbInterface ()
 
std::string GetControlState ()
 
std::string Get (const std::string &key)
 
void SetControlState (const std::string &value)
 
void SetConfig (Config &cfg)
 
void Set (const std::string &key, const std::string &value)
 
 DbInterface (const DbInterface &)=delete
 
DbInterfaceoperator= (const DbInterface &)=delete
 Disable copy constructor. More...
 

Detailed Description

This class is the interface to the in-memory DB.

Constructor & Destructor Documentation

◆ DbInterface() [1/4]

hellomal::DbInterface::DbInterface ( const std::string &  prefix,
rad::DbAdapter runtime_db 
)

Constructor.

Parameters
[in]prefixString used as prefix when building the keys.
[in]runtime_dbReference to the in-memory DB adapter.

◆ ~DbInterface() [1/2]

hellomal::DbInterface::~DbInterface ( )
virtual

Destructor

◆ DbInterface() [2/4]

hellomal::DbInterface::DbInterface ( const DbInterface )
delete

◆ DbInterface() [3/4]

hellomal::DbInterface::DbInterface ( const std::string &  prefix,
rad::DbAdapter runtime_db 
)

Constructor.

Parameters
[in]prefixString used as prefix when building the keys.
[in]runtime_dbReference to the in-memory DB adapter.

◆ ~DbInterface() [2/2]

virtual hellomal::DbInterface::~DbInterface ( )
virtual

Destructor

◆ DbInterface() [4/4]

hellomal::DbInterface::DbInterface ( const DbInterface )
delete

Member Function Documentation

◆ Get() [1/2]

std::string hellomal::DbInterface::Get ( const std::string &  key)
Parameters
[in]keyKey in the DB.
Returns
The value stored in the DB associated to the given key.

◆ Get() [2/2]

std::string hellomal::DbInterface::Get ( const std::string &  key)
Parameters
[in]keyKey in the DB.
Returns
The value stored in the DB associated to the given key.

◆ GetControlState() [1/2]

std::string hellomal::DbInterface::GetControlState ( )
Returns
The current state of the application stored in the DB.

◆ GetControlState() [2/2]

std::string hellomal::DbInterface::GetControlState ( )
Returns
The current state of the application stored in the DB.

◆ operator=() [1/2]

DbInterface& hellomal::DbInterface::operator= ( const DbInterface )
delete

Disable copy constructor.

◆ operator=() [2/2]

DbInterface& hellomal::DbInterface::operator= ( const DbInterface )
delete

Disable copy constructor.

◆ Set() [1/2]

void hellomal::DbInterface::Set ( const std::string &  key,
const std::string &  value 
)
Parameters
[in]keyKey to be written in the DB.
[in]valueValue, associated to the given key, to be written in the DB.

◆ Set() [2/2]

void hellomal::DbInterface::Set ( const std::string &  key,
const std::string &  value 
)
Parameters
[in]keyKey to be written in the DB.
[in]valueValue, associated to the given key, to be written in the DB.

◆ SetConfig() [1/2]

void hellomal::DbInterface::SetConfig ( Config cfg)

Set the application configuration information in the DB.

Parameters
[in]reqEndpointRequest msg endpoint.
[in]dbIpAddrDB IP address.
[in]dbPortDB port.
[in]dbTimeoutDB timeout.

◆ SetConfig() [2/2]

void hellomal::DbInterface::SetConfig ( Config cfg)

Set the application configuration information in the DB.

Parameters
[in]reqEndpointRequest msg endpoint.
[in]dbIpAddrDB IP address.
[in]dbPortDB port.
[in]dbTimeoutDB timeout.

◆ SetControlState() [1/2]

void hellomal::DbInterface::SetControlState ( const std::string &  value)
Parameters
[in]valueState to be stored in the DB.

◆ SetControlState() [2/2]

void hellomal::DbInterface::SetControlState ( const std::string &  value)
Parameters
[in]valueState to be stored in the DB.

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