audacity::sqlite::Transaction Class Reference

A class representing a transaction in SQLite. More...

#include <Transaction.h>

Collaboration diagram for audacity::sqlite::Transaction:

Public Member Functions
	Transaction (const Transaction &)=delete
	Transaction (Transaction &&)=delete
Transaction &	operator= (const Transaction &)=delete
Transaction &	operator= (Transaction &&)=delete
	~Transaction ()
Error	GetBeginResult () const noexcept
bool	IsOpen () const noexcept
Error	Commit () noexcept
Error	Abort () noexcept

Private Types
enum class	TransactionOperation { BeginOp , CommitOp , RollbackOp }
using	TransactionHandler = Error(*)(Connection &, TransactionOperation, Transaction &)

Private Member Functions
	Transaction (Connection &connection, TransactionHandler handler, std::string_view name) noexcept

Private Attributes
Connection &	mConnection
TransactionHandler	mHandler
std::string	mName
Error	mBeginResult {}
bool	mCommitted {}

Friends
class	Connection

Detailed Description

A class representing a transaction in SQLite.

Definition at line 19 of file Transaction.h.

Member Typedef Documentation

TransactionHandler

using audacity::sqlite::Transaction::TransactionHandler = Error (*)(Connection&, TransactionOperation, Transaction&)

private

Definition at line 30 of file Transaction.h.

Member Enumeration Documentation

TransactionOperation

enum class audacity::sqlite::Transaction::TransactionOperation

strongprivate

Enumerator
BeginOp
CommitOp
RollbackOp

Definition at line 23 of file Transaction.h.

   {
      BeginOp,
      CommitOp,
      RollbackOp,
   };

Constructor & Destructor Documentation

Transaction() [1/3]

audacity::sqlite::Transaction::Transaction ( Connection &  connection, TransactionHandler  handler, std::string_view  name  )

privatenoexcept

Definition at line 12 of file Transaction.cpp.

    : mConnection(connection)
    , mHandler(handler)
    , mName(name)
{
   mBeginResult = mHandler(mConnection, TransactionOperation::BeginOp, *this);
}

Transaction() [2/3]

audacity::sqlite::Transaction::Transaction ( const Transaction &  )

delete

Transaction() [3/3]

audacity::sqlite::Transaction::Transaction ( Transaction &&  )

delete

~Transaction()

audacity::sqlite::Transaction::~Transaction

(

)

Definition at line 22 of file Transaction.cpp.

{
   Abort();
}

References Abort().

Here is the call graph for this function:

Member Function Documentation

Abort()

Error audacity::sqlite::Transaction::Abort ( )

noexcept

Definition at line 48 of file Transaction.cpp.

{
   if (mCommitted)
      return {};
 
   if (mBeginResult.IsError())
      return mBeginResult;
 
   return mHandler(mConnection, TransactionOperation::RollbackOp, *this);
}

References audacity::sqlite::Error::IsError(), mBeginResult, mCommitted, mConnection, mHandler, and RollbackOp.

Referenced by ~Transaction().

Here is the call graph for this function:

Here is the caller graph for this function:

Commit()

Error audacity::sqlite::Transaction::Commit ( )

noexcept

Definition at line 37 of file Transaction.cpp.

{
   if (mCommitted)
      return {};
 
   if (mBeginResult.IsError())
      return mBeginResult;
 
   return mHandler(mConnection, TransactionOperation::CommitOp, *this);
}

References CommitOp, audacity::sqlite::Error::IsError(), mBeginResult, mCommitted, mConnection, and mHandler.

Here is the call graph for this function:

GetBeginResult()

Error audacity::sqlite::Transaction::GetBeginResult ( ) const

noexcept

Definition at line 27 of file Transaction.cpp.

{
   return mBeginResult;
}

References mBeginResult.

IsOpen()

bool audacity::sqlite::Transaction::IsOpen ( ) const

noexcept

Definition at line 32 of file Transaction.cpp.

{
   return mBeginResult.IsOk() && !mCommitted;
}

References audacity::sqlite::Error::IsOk(), mBeginResult, and mCommitted.

Here is the call graph for this function:

operator=() [1/2]

Transaction & audacity::sqlite::Transaction::operator= ( const Transaction &  )

delete

operator=() [2/2]

Transaction & audacity::sqlite::Transaction::operator= ( Transaction &&  )

delete

Friends And Related Function Documentation

Connection

friend class Connection

friend

Definition at line 21 of file Transaction.h.

Member Data Documentation

mBeginResult

Error audacity::sqlite::Transaction::mBeginResult {}

private

Definition at line 55 of file Transaction.h.

Referenced by Abort(), Commit(), GetBeginResult(), and IsOpen().

mCommitted

bool audacity::sqlite::Transaction::mCommitted {}

private

Definition at line 56 of file Transaction.h.

Referenced by Abort(), Commit(), IsOpen(), and audacity::sqlite::Connection::TransactionHandler().

mConnection

Connection& audacity::sqlite::Transaction::mConnection

private

Definition at line 52 of file Transaction.h.

Referenced by Abort(), and Commit().

mHandler

TransactionHandler audacity::sqlite::Transaction::mHandler

private

Definition at line 53 of file Transaction.h.

Referenced by Abort(), and Commit().

mName

std::string audacity::sqlite::Transaction::mName

private

Definition at line 54 of file Transaction.h.

Referenced by audacity::sqlite::Connection::TransactionHandler().

---

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

• Transaction.h
• Transaction.cpp