LC::Util::DBLock Class Reference

Provides database transaction lock. More...

#include "dblock.h"

Public Member Functions
	DBLock (const DBLock &)=delete
DBLock &	operator= (const DBLock &)=delete
	DBLock (DBLock &&)=default
UTIL_DB_API	DBLock (QSqlDatabase &database)
	Constructor. More...
UTIL_DB_API	~DBLock ()
	Destructor. More...
UTIL_DB_API void	Init ()
	Initializes the transaction. More...
UTIL_DB_API void	Good ()
	Notifies the lock about successful higher-level operations. More...

Static Public Member Functions
static UTIL_DB_API void	DumpError (const QSqlError &error)
	Dumps the error to the qWarning() stream. More...
static UTIL_DB_API void	DumpError (const QSqlQuery &query)
	Dumps the error to the qWarning() stream. More...
static UTIL_DB_API void	Execute (QSqlQuery &query)
	Tries to execute the given query. More...

Detailed Description

Provides database transaction lock.

To use the lock, create an instance of it passing a non-const reference to the QSqlDatabase to be guarded. To initialize and start the locking mechanism, call Init(). To notify DBLock that everything is good and the database shouldn't be rolled back, call Good(). Transaction would be either commited or rolled back in class' destructor.

The state could be unusable, usable or correct. Unusable means that the class itself isn't usable, usable means that the class is usable, but the transaction state isn't necesseraly in a correct state, and correct means that the lock class is usable and the transaction state is correct.

Definition at line 41 of file dblock.h.

Constructor & Destructor Documentation

DBLock() [1/3]

LC::Util::DBLock::DBLock ( const DBLock &  )

delete

DBLock() [2/3]

LC::Util::DBLock::DBLock ( DBLock &&  )

default

DBLock() [3/3]

LC::Util::DBLock::DBLock ( QSqlDatabase &  database )

explicit

Constructor.

Constructs the lock and prepares it to work with the database. Creating the lock doesn't begin the transaction. Lock is in usable state after that.

Parameters

[in]

database

Non-const reference to the database to be guarded.

Definition at line 30 of file dblock.cpp.

~DBLock()

LC::Util::DBLock::~DBLock

(

)

Destructor.

Ends the transaction if the lock is in a correct state. If Good() was called, it commits the transaction, otherwise rolls back.

Definition at line 35 of file dblock.cpp.

Member Function Documentation

DumpError() [1/2]

void LC::Util::DBLock::DumpError ( const QSqlError &  error )

static

Dumps the error to the qWarning() stream.

Parameters

[in]

error

The error class.

Definition at line 74 of file dblock.cpp.

Referenced by LC::Util::MakeDatabase(), and LC::Util::oral::detail::ToVariantF().

Here is the caller graph for this function:

DumpError() [2/2]

void LC::Util::DBLock::DumpError ( const QSqlQuery &  query )

static

Dumps the error to the qWarning() stream.

Parameters

[in]

query

The query that should be dumped.

Definition at line 80 of file dblock.cpp.

Execute()

void LC::Util::DBLock::Execute ( QSqlQuery &  query )

static

Tries to execute the given query.

If query execution is successful, this function just returns. Otherwise it calls DumpError() to write the error to the logs and throws an exception.

Parameters

[in]

query

The query that should be dumped.

Definition at line 87 of file dblock.cpp.

Good()

void LC::Util::DBLock::Good

(

)

Notifies the lock about successful higher-level operations.

Calling this function makes the lock to commit the transaction upon destruction instead of rolling back.

Definition at line 69 of file dblock.cpp.

Init()

void LC::Util::DBLock::Init

(

)

Initializes the transaction.

Tries to start the transaction. If this wasn't successful, the lock remains in a usable but not correct state.

Exceptions

std::runtime_error

Definition at line 51 of file dblock.cpp.

operator=()

DBLock& LC::Util::DBLock::operator= ( const DBLock &  )

delete

---

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

• /home/d34df00d/leechcraft/src/util/db/dblock.h
• /home/d34df00d/leechcraft/src/util/db/dblock.cpp