Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
fawkes::SQLiteConfiguration Class Reference

Configuration storage using SQLite. More...

#include <>>

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 ()
 Constructor. More...
 
 SQLiteConfiguration (const char *sysconfdir, const char *userconfdir=NULL)
 Constructor. More...
 
virtual ~SQLiteConfiguration ()
 Destructor. More...
 
virtual void copy (Configuration *copyconf)
 Copy all values from the given configuration. More...
 
virtual void load (const char *filename, const char *defaults_filename, const char *tag=NULL)
 Load configuration. More...
 
void load (const char *tag=NULL)
 Load config from default files. More...
 
virtual void tag (const char *tag)
 Tag this configuration version. More...
 
virtual std::list< std::string > tags ()
 List of tags. More...
 
virtual bool exists (const char *path)
 Check if a given value exists. More...
 
virtual bool is_float (const char *path)
 Check if a value is of type float. More...
 
virtual bool is_uint (const char *path)
 Check if a value is of type unsigned int. More...
 
virtual bool is_int (const char *path)
 Check if a value is of type int. More...
 
virtual bool is_bool (const char *path)
 Check if a value is of type bool. More...
 
virtual bool is_string (const char *path)
 Check if a value is of type string. More...
 
virtual bool is_default (const char *path)
 Check if a value was read from the default config. More...
 
virtual std::string get_type (const char *path)
 Get type of value at given path. More...
 
virtual float get_float (const char *path)
 Get value from configuration which is of type float. More...
 
virtual unsigned int get_uint (const char *path)
 Get value from configuration which is of type unsigned int. More...
 
virtual int get_int (const char *path)
 Get value from configuration which is of type int. More...
 
virtual bool get_bool (const char *path)
 Get value from configuration which is of type bool. More...
 
virtual std::string get_string (const char *path)
 Get value from configuration which is of type string. More...
 
virtual ValueIteratorget_value (const char *path)
 Get value from configuration. More...
 
virtual std::string get_comment (const char *path)
 Get comment of value at given path. More...
 
virtual std::string get_default_comment (const char *path)
 Get comment of value at given path. More...
 
virtual void set_float (const char *path, float f)
 Set new value in configuration of type float. More...
 
virtual void set_uint (const char *path, unsigned int uint)
 Set new value in configuration of type unsigned int. More...
 
virtual void set_int (const char *path, int i)
 Set new value in configuration of type int. More...
 
virtual void set_bool (const char *path, bool b)
 Set new value in configuration of type bool. More...
 
virtual void set_string (const char *path, std::string &s)
 Set new value in configuration of type string. More...
 
virtual void set_string (const char *path, const char *s)
 Set new value in configuration of type string. More...
 
virtual void set_comment (const char *path, std::string &comment)
 Set new comment for existing value. More...
 
virtual void set_comment (const char *path, const char *comment)
 Set new comment for existing value. More...
 
virtual void erase (const char *path)
 Erase the given value from the configuration. More...
 
virtual void set_default_float (const char *path, float f)
 Set new default value in configuration of type float. More...
 
virtual void set_default_uint (const char *path, unsigned int uint)
 Set new default value in configuration of type unsigned int. More...
 
virtual void set_default_int (const char *path, int i)
 Set new default value in configuration of type int. More...
 
virtual void set_default_bool (const char *path, bool b)
 Set new default value in configuration of type bool. More...
 
virtual void set_default_string (const char *path, std::string &s)
 Set new default value in configuration of type string. More...
 
virtual void set_default_string (const char *path, const char *s)
 Set new default value in configuration of type string. More...
 
virtual void set_default_comment (const char *path, const char *comment)
 Set new default comment for existing default configuration value. More...
 
virtual void set_default_comment (const char *path, std::string &comment)
 Set new default comment for existing default configuration value. More...
 
virtual void erase_default (const char *path)
 Erase the given default value from the configuration. More...
 
void transaction_begin (transaction_type_t ttype=TRANSACTION_DEFERRED)
 Begin SQL Transaction. More...
 
void transaction_commit ()
 Commit SQL Transaction. More...
 
void transaction_rollback ()
 Rollback SQL Transaction. More...
 
ValueIteratoriterator ()
 Iterator for all values. More...
 
ValueIteratoriterator_default ()
 Iterator for all default values. More...
 
ValueIteratoriterator_hostspecific ()
 Iterator for all host-specific values. More...
 
ValueIteratorsearch (const char *path)
 Iterator with search results. More...
 
void lock ()
 Lock the config. More...
 
bool try_lock ()
 Try to lock the config. More...
 
void unlock ()
 Unlock the config. More...
 
SQLiteValueIteratormodified_iterator ()
 Iterator for modified values. More...
 
void try_dump ()
 Try to dump default configuration. More...
 
- Public Member Functions inherited from fawkes::Configuration
virtual ~Configuration ()
 Virtual empty destructor. More...
 
virtual void add_change_handler (ConfigurationChangeHandler *h)
 Add a configuration change handler. More...
 
virtual void rem_change_handler (ConfigurationChangeHandler *h)
 Remove a configuration change handler. More...
 

Additional Inherited Members

- Protected Types inherited from fawkes::Configuration
typedef std::list
< ConfigurationChangeHandler * > 
ChangeHandlerList
 List that contains pointers to ConfigurationChangeHandler. More...
 
typedef std::multimap< const
char
*, ConfigurationChangeHandler
*, StringLess
ChangeHandlerMultimap
 Multimap string to config change handlers. More...
 
typedef std::pair
< ChangeHandlerMultimap::iterator,
ChangeHandlerMultimap::iterator > 
ChangeHandlerMultimapRange
 Config change handler multimap range. More...
 
- Protected Member Functions inherited from fawkes::Configuration
ChangeHandlerListfind_handlers (const char *path)
 Find handlers for given path. More...
 
void notify_handlers (const char *path, bool comment_changed=false)
 Notify handlers for given path. More...
 
- Protected Attributes inherited from fawkes::Configuration
ChangeHandlerMultimap _change_handlers
 Registered change handlers. More...
 
ChangeHandlerMultimapRange _ch_range
 Change handler range. More...
 

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 39 of file sqlite.h.

Member Enumeration Documentation

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 100 of file sqlite.h.

Constructor & Destructor Documentation

fawkes::SQLiteConfiguration::SQLiteConfiguration ( )

Constructor.

Definition at line 221 of file sqlite.cpp.

fawkes::SQLiteConfiguration::SQLiteConfiguration ( const char *  sysconfdir,
const char *  userconfdir = NULL 
)

Constructor.

Parameters
sysconfdirsystem configuration directory, will be searched for default configuration file, and system will try to create host-specific database if writable
userconfdiruser configuration directory, will be searched preferably for default configuration file, and will be used to create host-specific database if sysconfdir is not writable. This directory will be created if it does not exist during load().

Definition at line 242 of file sqlite.cpp.

fawkes::SQLiteConfiguration::~SQLiteConfiguration ( )
virtual

Destructor.

Definition at line 267 of file sqlite.cpp.

Member Function Documentation

void fawkes::SQLiteConfiguration::erase ( const char *  path)
virtual

Erase the given value from the configuration.

It is not an error if the value does not exists before deletion.

Parameters
pathpath to value

Implements fawkes::Configuration.

Definition at line 1555 of file sqlite.cpp.

References fawkes::Configuration::notify_handlers().

void fawkes::SQLiteConfiguration::erase_default ( const char *  path)
virtual

Erase the given default value from the configuration.

It is not an error if the value does not exists before deletion.

Parameters
pathpath to value

Implements fawkes::Configuration.

Definition at line 1876 of file sqlite.cpp.

References fawkes::Configuration::notify_handlers().

bool fawkes::SQLiteConfiguration::exists ( const char *  path)
virtual

Check if a given value exists.

Parameters
pathpath to value
Returns
true if the value exists, false otherwise

Implements fawkes::Configuration.

Definition at line 858 of file sqlite.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

bool fawkes::SQLiteConfiguration::get_bool ( const char *  path)
virtual

Get value from configuration which is of type bool.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 1146 of file sqlite.cpp.

References get_value(), fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by fawkes::NetworkConfiguration::get_bool().

std::string fawkes::SQLiteConfiguration::get_comment ( const char *  path)
virtual

Get comment of value at given path.

The value at the given path must exist in the host-specific configuration.

Parameters
pathpath to value
Returns
comment
Exceptions
ConfigEntryNotFoundExceptionshall be thrown if value does not exist
ConfigurationExceptionshall be thrown on any other error

Implements fawkes::Configuration.

Definition at line 920 of file sqlite.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by fawkes::NetworkConfiguration::get_comment().

std::string fawkes::SQLiteConfiguration::get_default_comment ( const char *  path)
virtual

Get comment of value at given path.

The value at the given path must exist in the default configuration.

Parameters
pathpath to value
Returns
comment
Exceptions
ConfigEntryNotFoundExceptionshall be thrown if value does not exist
ConfigurationExceptionshall be thrown on any other error

Implements fawkes::Configuration.

Definition at line 950 of file sqlite.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by fawkes::NetworkConfiguration::get_default_comment().

float fawkes::SQLiteConfiguration::get_float ( const char *  path)
virtual

Get value from configuration which is of type float.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 1085 of file sqlite.cpp.

References get_value(), fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by fawkes::NetworkConfiguration::get_float().

int fawkes::SQLiteConfiguration::get_int ( const char *  path)
virtual

Get value from configuration which is of type int.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 1127 of file sqlite.cpp.

References get_value(), fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by fawkes::NetworkConfiguration::get_int().

std::string fawkes::SQLiteConfiguration::get_string ( const char *  path)
virtual

Get value from configuration which is of type string.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 1164 of file sqlite.cpp.

References fawkes::Exception::append(), get_value(), fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by fawkes::NetworkConfiguration::get_string(), and WebviewUserVerifier::verify_user().

std::string fawkes::SQLiteConfiguration::get_type ( const char *  path)
virtual

Get type of value at given path.

Parameters
pathpath to value
Returns
string representation of type, one of float, unsigned int, int, bool, or string
Exceptions
ConfigurationExceptionshall be thrown if value does not exist or on any other error.

Implements fawkes::Configuration.

Definition at line 886 of file sqlite.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by fawkes::NetworkConfiguration::get_type(), is_bool(), is_float(), is_int(), is_string(), and is_uint().

unsigned int fawkes::SQLiteConfiguration::get_uint ( const char *  path)
virtual

Get value from configuration which is of type unsigned int.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 1104 of file sqlite.cpp.

References get_value(), fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by fawkes::NetworkConfiguration::get_uint().

Configuration::ValueIterator * fawkes::SQLiteConfiguration::get_value ( const char *  path)
virtual

Get value from configuration.

Parameters
pathpath to value
Returns
value iterator for just this one value, maybe invalid if value does not exists.

Implements fawkes::Configuration.

Definition at line 1185 of file sqlite.cpp.

Referenced by get_bool(), get_float(), get_int(), get_string(), get_uint(), and fawkes::NetworkConfiguration::get_value().

bool fawkes::SQLiteConfiguration::is_bool ( const char *  path)
virtual

Check if a value is of type bool.

Parameters
pathpath to value
Returns
true if the value exists and is of type bool

Implements fawkes::Configuration.

Definition at line 1001 of file sqlite.cpp.

References get_type().

bool fawkes::SQLiteConfiguration::is_default ( const char *  path)
virtual

Check if a value was read from the default config.

Parameters
pathpath to value
Returns
true if the value exists and is only stored in the default config

Implements fawkes::Configuration.

Definition at line 1015 of file sqlite.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

bool fawkes::SQLiteConfiguration::is_float ( const char *  path)
virtual

Check if a value is of type float.

Parameters
pathpath to value
Returns
true if the value exists and is of type float

Implements fawkes::Configuration.

Definition at line 980 of file sqlite.cpp.

References get_type().

bool fawkes::SQLiteConfiguration::is_int ( const char *  path)
virtual

Check if a value is of type int.

Parameters
pathpath to value
Returns
true if the value exists and is of type int

Implements fawkes::Configuration.

Definition at line 994 of file sqlite.cpp.

References get_type().

bool fawkes::SQLiteConfiguration::is_string ( const char *  path)
virtual

Check if a value is of type string.

Parameters
pathpath to value
Returns
true if the value exists and is of type string

Implements fawkes::Configuration.

Definition at line 1008 of file sqlite.cpp.

References get_type().

bool fawkes::SQLiteConfiguration::is_uint ( const char *  path)
virtual

Check if a value is of type unsigned int.

Parameters
pathpath to value
Returns
true if the value exists and is of type unsigned int

Implements fawkes::Configuration.

Definition at line 987 of file sqlite.cpp.

References get_type().

Configuration::ValueIterator * fawkes::SQLiteConfiguration::iterator ( )
virtual

Iterator for all values.

Returns an iterator that can be used to iterate over all values in the current configuration, it will value the overlay. If a default and a host-specific value exists you will only see the host-specific value.

Returns
iterator over all values

Implements fawkes::Configuration.

Definition at line 1934 of file sqlite.cpp.

Referenced by fawkes::NetworkConfiguration::iterator().

Configuration::ValueIterator * fawkes::SQLiteConfiguration::iterator_default ( )
virtual

Iterator for all default values.

Returns an iterator that can be used to iterate over all default values in the current default configuration. Note that this might return less paths than available, because the values for which no default entry exists are not returned.

Returns
iterator over all default values

Implements fawkes::Configuration.

Definition at line 1948 of file sqlite.cpp.

Referenced by fawkes::NetworkConfiguration::iterator_default().

Configuration::ValueIterator * fawkes::SQLiteConfiguration::iterator_hostspecific ( )
virtual

Iterator for all host-specific values.

Returns an iterator that can be used to iterate over all host-specific values in the current configuration. Note that this might return less paths than available, because the default values for which no host-specific entry exists are not returned.

Returns
iterator over all host-specific values

Implements fawkes::Configuration.

Definition at line 1961 of file sqlite.cpp.

Referenced by fawkes::NetworkConfiguration::iterator_hostspecific().

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

Load configuration.

Loads configuration data, or opens a file, depending on the implementation. After this call access to all other methods shall be possible.

Parameters
namename 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_namename of the default database. As for the name this depends on the actual implementation.
tagthis 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.

Implements fawkes::Configuration.

Definition at line 611 of file sqlite.cpp.

References fawkes::Exception::append(), fawkes::Mutex::lock(), fawkes::HostInfo::short_name(), and fawkes::Mutex::unlock().

Referenced by load(), and fawkes::NetworkConfiguration::set_mirror_mode().

void fawkes::SQLiteConfiguration::load ( const char *  tag = NULL)

Load config from default files.

Default file is "shorthostname.db" (shorthostname replaced by the short host name returned by uname) and default.db).

Parameters
tagoptional tag to restore

Definition at line 768 of file sqlite.cpp.

References load().

void fawkes::SQLiteConfiguration::lock ( )
virtual

Lock the config.

No further changes or queries can be executed on the configuration and will block until the config is unlocked.

Implements fawkes::Configuration.

Definition at line 1907 of file sqlite.cpp.

References fawkes::Mutex::lock().

SQLiteConfiguration::SQLiteValueIterator * fawkes::SQLiteConfiguration::modified_iterator ( )

Iterator for modified values.

Returns an iterator that can be used to iterate over all values that have been modified in the default database in the last load (added, erased or changed).

Returns
iterator over all values

Definition at line 1979 of file sqlite.cpp.

Configuration::ValueIterator * fawkes::SQLiteConfiguration::search ( const char *  path)
virtual

Iterator with search results.

Returns an iterator that can be used to iterate over the search results. All values whose component and path start with the given strings are returned. A call like

* config->search("");
*

is effectively the same as a call to iterator().

Parameters
pathstart of path
Returns
iterator to search results

Implements fawkes::Configuration.

Definition at line 2004 of file sqlite.cpp.

Referenced by fawkes::NetworkConfiguration::search().

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

Set new value in configuration of type bool.

Parameters
pathpath to value
bnew bool value

Implements fawkes::Configuration.

Definition at line 1403 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

Referenced by copy().

void fawkes::SQLiteConfiguration::set_comment ( const char *  path,
std::string &  comment 
)
virtual

Set new comment for existing value.

Parameters
pathpath to value
commentnew comment string

Implements fawkes::Configuration.

Definition at line 1548 of file sqlite.cpp.

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

Set new comment for existing value.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
commentnew comment string

Implements fawkes::Configuration.

Definition at line 1511 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

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

Set new default value in configuration of type bool.

Parameters
pathpath to value
bnew bool value

Implements fawkes::Configuration.

Definition at line 1726 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

void fawkes::SQLiteConfiguration::set_default_comment ( const char *  path,
const char *  comment 
)
virtual

Set new default comment for existing default configuration value.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
commentnew comment string

Implements fawkes::Configuration.

Definition at line 1833 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

Referenced by set_default_comment().

void fawkes::SQLiteConfiguration::set_default_comment ( const char *  path,
std::string &  comment 
)
virtual

Set new default comment for existing default configuration value.

Parameters
pathpath to value
commentnew comment string

Implements fawkes::Configuration.

Definition at line 1869 of file sqlite.cpp.

References set_default_comment().

void fawkes::SQLiteConfiguration::set_default_float ( const char *  path,
float  f 
)
virtual

Set new default value in configuration of type float.

Parameters
pathpath to value
fnew float value

Implements fawkes::Configuration.

Definition at line 1582 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

void fawkes::SQLiteConfiguration::set_default_int ( const char *  path,
int  i 
)
virtual

Set new default value in configuration of type int.

Parameters
pathpath to value
inew int value

Implements fawkes::Configuration.

Definition at line 1679 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

void fawkes::SQLiteConfiguration::set_default_string ( const char *  path,
std::string &  s 
)
virtual

Set new default value in configuration of type string.

Parameters
pathpath to value
snew string value

Implements fawkes::Configuration.

Definition at line 1826 of file sqlite.cpp.

void fawkes::SQLiteConfiguration::set_default_string ( const char *  path,
const char *  s 
)
virtual

Set new default value in configuration of type string.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
snew string value

Implements fawkes::Configuration.

Definition at line 1775 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

void fawkes::SQLiteConfiguration::set_default_uint ( const char *  path,
unsigned int  uint 
)
virtual

Set new default value in configuration of type unsigned int.

Parameters
pathpath to value
uintnew unsigned int value

Implements fawkes::Configuration.

Definition at line 1631 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

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

Set new value in configuration of type float.

Parameters
pathpath to value
fnew float value

Implements fawkes::Configuration.

Definition at line 1257 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

Referenced by copy().

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

Set new value in configuration of type int.

Parameters
pathpath to value
inew int value

Implements fawkes::Configuration.

Definition at line 1354 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

Referenced by copy().

void fawkes::SQLiteConfiguration::set_string ( const char *  path,
std::string &  s 
)
virtual

Set new value in configuration of type string.

Parameters
pathpath to value
snew string value

Implements fawkes::Configuration.

Definition at line 1504 of file sqlite.cpp.

Referenced by copy().

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

Set new value in configuration of type string.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
snew string value

Implements fawkes::Configuration.

Definition at line 1452 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

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

Set new value in configuration of type unsigned int.

Parameters
pathpath to value
uintnew unsigned int value

Implements fawkes::Configuration.

Definition at line 1306 of file sqlite.cpp.

References fawkes::Mutex::lock(), fawkes::Configuration::notify_handlers(), and fawkes::Mutex::unlock().

Referenced by copy().

void fawkes::SQLiteConfiguration::tag ( const char *  tag)
virtual

Tag this configuration version.

This creates a new tagged version of the current config. The tagged config can be accessed via load().

Parameters
tagtag for this version

Implements fawkes::Configuration.

Definition at line 813 of file sqlite.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

std::list< std::string > fawkes::SQLiteConfiguration::tags ( )
virtual

List of tags.

Returns
list of tags

Implements fawkes::Configuration.

Definition at line 838 of file sqlite.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

void fawkes::SQLiteConfiguration::transaction_begin ( transaction_type_t  ttype = TRANSACTION_DEFERRED)

Begin SQL Transaction.

Parameters
ttypetransaction type

Definition at line 552 of file sqlite.cpp.

References TRANSACTION_EXCLUSIVE, and TRANSACTION_IMMEDIATE.

Referenced by copy().

void fawkes::SQLiteConfiguration::transaction_commit ( )

Commit SQL Transaction.

Definition at line 569 of file sqlite.cpp.

Referenced by copy().

void fawkes::SQLiteConfiguration::transaction_rollback ( )

Rollback SQL Transaction.

Definition at line 582 of file sqlite.cpp.

void fawkes::SQLiteConfiguration::try_dump ( )

Try to dump default configuration.

This method will try to open the SQL dump file for writing and dump the current content of the default database into the file.

Exceptions
Exceptionthrown if dumping fails

Definition at line 426 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::try_lock ( )
virtual

Try to lock the config.

See Also
Configuration::lock()
Returns
true, if the lock has been aquired, false otherwise

Implements fawkes::Configuration.

Definition at line 1918 of file sqlite.cpp.

References fawkes::Mutex::try_lock().

void fawkes::SQLiteConfiguration::unlock ( )
virtual

Unlock the config.

Modifications and queries are possible again.

Implements fawkes::Configuration.

Definition at line 1927 of file sqlite.cpp.

References fawkes::Mutex::unlock().


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