fawkes::SQLiteConfiguration Class Reference

Configuration storage using SQLite. More...

#include <config/sqlite.h>

Inheritance diagram for fawkes::SQLiteConfiguration:


Classes
class	SQLiteValueIterator
	SQLite configuration value iterator. More...
Public Types
enum	transaction_type_t { TRANSACTION_DEFERRED, TRANSACTION_IMMEDIATE, TRANSACTION_EXCLUSIVE }
	Transaction type. More...
Public Member Functions
	SQLiteConfiguration (const char *conf_path=NULL)
	Constructor.
virtual	~SQLiteConfiguration ()
	Destructor.
virtual void	copy (Configuration *copyconf)
	Copy all values from the given configuration.
virtual void	load (const char filename, const char defaults_filename, const char *tag=NULL)
	Load configuration.
void	load (const char *tag=NULL)
	Load config from default files.
virtual void	tag (const char *tag)
	Tag this configuration version.
virtual std::list< std::string >	tags ()
	List of tags.
virtual bool	exists (const char *path)
	Check if a given value exists.
virtual bool	is_float (const char *path)
	Check if a value is of type float.
virtual bool	is_uint (const char *path)
	Check if a value is of type unsigned int.
virtual bool	is_int (const char *path)
	Check if a value is of type int.
virtual bool	is_bool (const char *path)
	Check if a value is of type bool.
virtual bool	is_string (const char *path)
	Check if a value is of type string.
virtual bool	is_default (const char *path)
	Check if a value was read from the default config.
virtual std::string	get_type (const char *path)
	Get type of value at given path.
virtual float	get_float (const char *path)
	Get value from configuration which is of type float.
virtual unsigned int	get_uint (const char *path)
	Get value from configuration which is of type unsigned int.
virtual int	get_int (const char *path)
	Get value from configuration which is of type int.
virtual bool	get_bool (const char *path)
	Get value from configuration which is of type bool.
virtual std::string	get_string (const char *path)
	Get value from configuration which is of type string.
virtual ValueIterator *	get_value (const char *path)
	Get value from configuration.
virtual std::string	get_comment (const char *path)
	Get comment of value at given path.
virtual std::string	get_default_comment (const char *path)
	Get comment of value at given path.
virtual void	set_float (const char *path, float f)
	Set new value in configuration of type float.
virtual void	set_uint (const char *path, unsigned int uint)
	Set new value in configuration of type unsigned int.
virtual void	set_int (const char *path, int i)
	Set new value in configuration of type int.
virtual void	set_bool (const char *path, bool b)
	Set new value in configuration of type bool.
virtual void	set_string (const char *path, std::string &s)
	Set new value in configuration of type string.
virtual void	set_string (const char path, const char s)
	Set new value in configuration of type string.
virtual void	set_comment (const char *path, std::string &comment)
	Set new comment for existing value.
virtual void	set_comment (const char path, const char comment)
	Set new comment for existing value.
virtual void	erase (const char *path)
	Erase the given value from the configuration.
virtual void	set_default_float (const char *path, float f)
	Set new default value in configuration of type float.
virtual void	set_default_uint (const char *path, unsigned int uint)
	Set new default value in configuration of type unsigned int.
virtual void	set_default_int (const char *path, int i)
	Set new default value in configuration of type int.
virtual void	set_default_bool (const char *path, bool b)
	Set new default value in configuration of type bool.
virtual void	set_default_string (const char *path, std::string &s)
	Set new default value in configuration of type string.
virtual void	set_default_string (const char path, const char s)
	Set new default value in configuration of type string.
virtual void	set_default_comment (const char path, const char comment)
	Set new default comment for existing default configuration value.
virtual void	set_default_comment (const char *path, std::string &comment)
	Set new default comment for existing default configuration value.
virtual void	erase_default (const char *path)
	Erase the given default value from the configuration.
void	transaction_begin (transaction_type_t ttype=TRANSACTION_DEFERRED)
	Begin SQL Transaction.
void	transaction_commit ()
	Commit SQL Transaction.
void	transaction_rollback ()
	Rollback SQL Transaction.
ValueIterator *	iterator ()
	Iterator for all values.
ValueIterator *	iterator_default ()
	Iterator for all default values.
ValueIterator *	iterator_hostspecific ()
	Iterator for all host-specific values.
ValueIterator *	search (const char *path)
	Iterator with search results.
void	lock ()
	Lock the config.
bool	try_lock ()
	Try to lock the config.
void	unlock ()
	Unlock the config.
SQLiteValueIterator *	modified_iterator ()
	Iterator for modified values.

Detailed Description

Configuration storage using SQLite.

This implementation of the Configuration interface uses SQLite to store the configuration.

The configuration uses two databases, one is used to store the host-specific configuration and the other one is used to store the default values. Only the default database is meant to reside under version control.

See init() for the structure of the databases. This class strictly serializes all accesses to the database such that only one thread at a time can modify the database.

Definition at line 37 of file sqlite.h.

Member Enumeration Documentation

enum fawkes::SQLiteConfiguration::transaction_type_t

Transaction type.

See SQLite Documentation for BEGIN TRANSACTION.

Enumerator:

TRANSACTION_DEFERRED	Deferred transaction, lock acquired late.
TRANSACTION_IMMEDIATE	Immediately acquire lock, reading remains possible.
TRANSACTION_EXCLUSIVE	Immediately acquire lock, no more reading or writing possible.

Definition at line 97 of file sqlite.h.

Constructor & Destructor Documentation

fawkes::SQLiteConfiguration::SQLiteConfiguration ( const char * conf_path = NULL )

Constructor.

Parameters:

conf_path

Path where the configuration resides, maybe NULL in which case the path name for the base databsae supplied to load() must be absolute path names or relative to the execution directory of the surrounding program.

Definition at line 222 of file sqlite.cpp.

fawkes::SQLiteConfiguration::~SQLiteConfiguration ( ) [virtual]

Destructor.

Definition at line 234 of file sqlite.cpp.

References fawkes::Exception::print_trace().

Member Function Documentation

void fawkes::SQLiteConfiguration::copy ( Configuration * copyconf ) [virtual]

Copy all values from the given configuration.

All values from the given configuration are copied. Old values are not erased so that the copied values will overwrite existing values, new values are created, but values existent in current config but not in the copie config will remain unchanged.

Parameters:

copyconf

configuration to copy

	ConfigEntryNotFoundException	shall be thrown if value does not exist
	ConfigurationException	shall be thrown on any other error

void fawkes::SQLiteConfiguration::load	(	const char *	name,
		const char *	defaults_name,
		const char *	tag = `NULL`
	)			`[virtual]`

	name	name of the host-based configuration. If this does not exist it shall be created from the default configuration. The name depends on the implementation and could be a filename.
	defaults_name	name of the default database. As for the name this depends on the actual implementation.
	tag	this optional parameter can denote a specific config version to load. This will cause the host-specific database to be flushed and filled with the values for the given tag. All values that did not exist for the tag are copied over from the default database.

void fawkes::SQLiteConfiguration::set_bool	(	const char *	path,
		bool	b
	)			`[virtual]`

void fawkes::SQLiteConfiguration::set_comment	(	const char *	path,
		const char *	comment
	)			`[virtual]`

void fawkes::SQLiteConfiguration::set_default_bool	(	const char *	path,
		bool	b
	)			`[virtual]`

void fawkes::SQLiteConfiguration::set_float	(	const char *	path,
		float	f
	)			`[virtual]`

void fawkes::SQLiteConfiguration::set_int	(	const char *	path,
		int	i
	)			`[virtual]`

void fawkes::SQLiteConfiguration::set_string	(	const char *	path,
		const char *	s
	)			`[virtual]`

void fawkes::SQLiteConfiguration::set_uint	(	const char *	path,
		unsigned int	uint
	)			`[virtual]`

Context Navigation

fawkes::SQLiteConfiguration Class Reference

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation