#include <dbAdapterRedis.hpp>

Inheritance diagram for rad::DbAdapterRedis:

Public Member Functions
	DbAdapterRedis ()

	DbAdapterRedis (const std::string &ipaddr, const int port, const timeval &timeout)

virtual	~DbAdapterRedis ()

void	Config (const std::string &endpoint, const timeval &timeout)

int	Delete (const std::vector< std::string > &keys)

bool	Exists (const std::string &key)

std::string	Get (const std::string &key)

std::vector< std::string >	MultiGet (const std::vector< std::string > &keys)

std::string	Get (const std::string &key, const std::string &field)

std::vector< std::string >	MultiGet (const std::string &key, const std::vector< std::string > &fields)

std::map< std::string, std::string >	Scan (const std::string &key, const std::string &pattern)

void	Set (const std::string &key, const std::string &value)

void	MultiSet (const std::vector< std::string > &kvs)

void	Set (const std::string &key, const std::string &field, const std::string &value)

void	MultiSet (const std::string &key, const std::vector< std::string > &fvs)

void	Connect ()

void	Disconnect ()

bool	IsConnected ()

	DbAdapterRedis (const DbAdapterRedis &)=delete

DbAdapterRedis &	operator= (const DbAdapterRedis &)=delete
	Disable copy constructor. More...

	DbAdapterRedis ()

	DbAdapterRedis (const std::string &ipaddr, const int port, const timeval &timeout)

virtual	~DbAdapterRedis ()

void	Config (const std::string &endpoint, const timeval &timeout)

int	Delete (const std::vector< std::string > &keys)

bool	Exists (const std::string &key)

std::string	Get (const std::string &key)

std::vector< std::string >	MultiGet (const std::vector< std::string > &keys)

std::string	Get (const std::string &key, const std::string &field)

std::vector< std::string >	MultiGet (const std::string &key, const std::vector< std::string > &fields)

std::map< std::string, std::string >	Scan (const std::string &key, const std::string &pattern)

void	Set (const std::string &key, const std::string &value)

void	MultiSet (const std::vector< std::string > &kvs)

void	Set (const std::string &key, const std::string &field, const std::string &value)

void	MultiSet (const std::string &key, const std::vector< std::string > &fvs)

void	Connect ()

void	Disconnect ()

bool	IsConnected ()

	DbAdapterRedis (const DbAdapterRedis &)=delete

DbAdapterRedis &	operator= (const DbAdapterRedis &)=delete
	Disable copy constructor. More...

Public Member Functions inherited from rad::DbAdapter
virtual	~DbAdapter ()

virtual	~DbAdapter ()

Detailed Description

This class can be used to access Redis Runtime DB.

Constructor & Destructor Documentation

rad::DbAdapterRedis::DbAdapterRedis ( )

rad::DbAdapterRedis::DbAdapterRedis	(	const std::string &	ipaddr,
		const int	port,
		const timeval &	timeout
	)

Parameters

ipaddr	DB IP address.
port	DB port.
timeout	Timeout for GET/SET commands.

rad::DbAdapterRedis::~DbAdapterRedis ( )

virtual

Disconnect from DB, if still connected.

rad::DbAdapterRedis::DbAdapterRedis ( const DbAdapterRedis & )

delete

rad::DbAdapterRedis::DbAdapterRedis ( )

rad::DbAdapterRedis::DbAdapterRedis	(	const std::string &	ipaddr,
		const int	port,
		const timeval &	timeout
	)

virtual rad::DbAdapterRedis::~DbAdapterRedis ( )

virtual

rad::DbAdapterRedis::DbAdapterRedis ( const DbAdapterRedis & )

delete

Member Function Documentation

void rad::DbAdapterRedis::Config	(	const std::string &	endpoint,
		const timeval &	timeout
	)

virtual

Reconfigure the DB connection parameters.

Parameters

endpoint	DB endpoint in the format of "address:port".
timeout	Timeout for GET/SET commands.

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Config	(	const std::string &	endpoint,
		const timeval &	timeout
	)

virtual

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Connect ( )

virtual

Connect to the DB.

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Connect ( )

virtual

Implements rad::DbAdapter.

int rad::DbAdapterRedis::Delete ( const std::vector< std::string > & keys )

virtual

Delete the specified keys from the DB.

Parameters

[in] keys The keys to delete

Returns: The number of keys deleted from the database

Implements rad::DbAdapter.

int rad::DbAdapterRedis::Delete ( const std::vector< std::string > & keys )

virtual

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Disconnect ( )

virtual

Disconnect from the DB.

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Disconnect ( )

virtual

Implements rad::DbAdapter.

bool rad::DbAdapterRedis::Exists ( const std::string & key )

virtual

Implements rad::DbAdapter.

bool rad::DbAdapterRedis::Exists ( const std::string & key )

virtual

Verify if the specified key exists in the DB.

Parameters

[in] key The key to verify

Returns: true if the key exists in the database, false otherwise

Implements rad::DbAdapter.

std::string rad::DbAdapterRedis::Get ( const std::string & key )

virtual

Retrieve from the DB the value associated to the key.

Parameters

[in] key An existing key

Returns: The value associated to the given Key.

Implements rad::DbAdapter.

std::string rad::DbAdapterRedis::Get ( const std::string & key )

virtual

Implements rad::DbAdapter.

std::string rad::DbAdapterRedis::Get	(	const std::string &	key,
		const std::string &	field
	)

virtual

Implements rad::DbAdapter.

std::string rad::DbAdapterRedis::Get	(	const std::string &	key,
		const std::string &	field
	)

virtual

Retrieve from the DB the specified field of a key.

Parameters

[in]	key	An existing key
[in]	field	An existing field of the key

Returns: The value for the field.

Implements rad::DbAdapter.

bool rad::DbAdapterRedis::IsConnected ( )

virtual

Implements rad::DbAdapter.

bool rad::DbAdapterRedis::IsConnected ( )

virtual

Verify the connectivity to the DB.

Returns: true if PING command succeeds, false otherwise.

Implements rad::DbAdapter.

std::vector< std::string > rad::DbAdapterRedis::MultiGet ( const std::vector< std::string > & keys )

virtual

Retrieve from the DB the values associated to multiple keys.

Parameters

[in] keys Vector of keys

Returns: The value associated to the given keys.

Implements rad::DbAdapter.

std::vector<std::string> rad::DbAdapterRedis::MultiGet ( const std::vector< std::string > & keys )

virtual

Implements rad::DbAdapter.

std::vector< std::string > rad::DbAdapterRedis::MultiGet	(	const std::string &	key,
		const std::vector< std::string > &	fields
	)

virtual

Retrieve from the DB the values associated to multiple fields of a key.

Parameters

[in]	key	An existing key
[in]	fields	Vector of fields. If empty, returns all fields and values.

Returns: The values associated to the given fields of the specified key.

Implements rad::DbAdapter.

std::vector<std::string> rad::DbAdapterRedis::MultiGet	(	const std::string &	key,
		const std::vector< std::string > &	fields
	)

virtual

Implements rad::DbAdapter.

void rad::DbAdapterRedis::MultiSet ( const std::vector< std::string > & kvs )

virtual

Set in the DB multiple values associated to multiple keys.

Parameters

[in] kvs Vector of key-value paris.

Implements rad::DbAdapter.

void rad::DbAdapterRedis::MultiSet ( const std::vector< std::string > & kvs )

virtual

Implements rad::DbAdapter.

void rad::DbAdapterRedis::MultiSet	(	const std::string &	key,
		const std::vector< std::string > &	fvs
	)

virtual

Implements rad::DbAdapter.

void rad::DbAdapterRedis::MultiSet	(	const std::string &	key,
		const std::vector< std::string > &	fvs
	)

virtual

Set in the DB multiple values associated to multiple fields of a key.

Parameters

[in]	key	The new or existing key.
[in]	fvs	Vector of field-value pairs.

Implements rad::DbAdapter.

DbAdapterRedis& rad::DbAdapterRedis::operator= ( const DbAdapterRedis & )

delete

Disable copy constructor.

DbAdapterRedis& rad::DbAdapterRedis::operator= ( const DbAdapterRedis & )

delete

Disable copy constructor.

std::map<std::string, std::string> rad::DbAdapterRedis::Scan	(	const std::string &	key,
		const std::string &	pattern
	)

virtual

Implements rad::DbAdapter.

std::map< std::string, std::string > rad::DbAdapterRedis::Scan	(	const std::string &	key,
		const std::string &	pattern
	)

virtual

Retrieve from the DB, the entry associated to value/partial value.

Parameters

[in]	key	An existing key.
[in]	pattern	Value or partial value.

Returns: All db entries with value mathching the pattern.

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Set	(	const std::string &	key,
		const std::string &	value
	)

virtual

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Set	(	const std::string &	key,
		const std::string &	value
	)

virtual

Set in the DB the value associated to the key.

Parameters

[in]	key	The new or existing key
[in]	value	The value associated to the key

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Set	(	const std::string &	key,
		const std::string &	field,
		const std::string &	value
	)

virtual

Implements rad::DbAdapter.

void rad::DbAdapterRedis::Set	(	const std::string &	key,
		const std::string &	field,
		const std::string &	value
	)

virtual

Set in the DB a field associated to a key.

Parameters

[in]	key	The new or existing key
[in]	field	The new or existing field
[in]	value	The value associated to the field

Implements rad::DbAdapter.

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

INTROOT/include/rad/dbAdapterRedis.hpp
rad/cpp/services/src/include/rad/dbAdapterRedis.hpp
rad/cpp/services/src/dbAdapterRedis.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation