audacity::sqlite::SafeConnection Class Reference

A class representing a safe connection to SQLite. More...

#include <SafeConnection.h>

Inheritance diagram for audacity::sqlite::SafeConnection:

Collaboration diagram for audacity::sqlite::SafeConnection:

Classes
struct	Lock
struct	Tag

Public Member Functions
	SafeConnection (Tag, Connection connection)
Lock	Acquire () noexcept

Static Public Member Functions
static std::shared_ptr< SafeConnection >	Open (std::string_view path, OpenMode mode=OpenMode::ReadWriteCreate, ThreadMode threadMode=ThreadMode::Serialized, Error *openError=nullptr)
static std::shared_ptr< SafeConnection >	Reopen (const Connection &connection, OpenMode mode=OpenMode::ReadWriteCreate, ThreadMode threadMode=ThreadMode::Serialized, Error *openError=nullptr)
static std::shared_ptr< SafeConnection >	Reopen (sqlite3 *connection, OpenMode mode=OpenMode::ReadWriteCreate, ThreadMode threadMode=ThreadMode::Serialized, Error *openError=nullptr)
static std::shared_ptr< SafeConnection >	Reopen (SafeConnection &connection, OpenMode mode=OpenMode::ReadWriteCreate, ThreadMode threadMode=ThreadMode::Serialized, Error *openError=nullptr)

Private Types
using	MutexType = std::recursive_mutex

Private Attributes
Connection	mConnection
MutexType	mConnectionMutex

Detailed Description

A class representing a safe connection to SQLite.

This class is a wrapper around the Connection class that provides a thread-safe access to the connection.

Definition at line 21 of file SafeConnection.h.

Member Typedef Documentation

MutexType

using audacity::sqlite::SafeConnection::MutexType = std::recursive_mutex

private

Definition at line 28 of file SafeConnection.h.

Constructor & Destructor Documentation

SafeConnection()

audacity::sqlite::SafeConnection::SafeConnection	(	Tag	,
		Connection	connection
	)

Definition at line 11 of file SafeConnection.cpp.

    : mConnection(std::move(connection))
{
}

Member Function Documentation

Acquire()

SafeConnection::Lock audacity::sqlite::SafeConnection::Acquire ( )

noexcept

Definition at line 85 of file SafeConnection.cpp.

{
   return Lock { shared_from_this() };
}

Open()

std::shared_ptr< SafeConnection > audacity::sqlite::SafeConnection::Open ( std::string_view  path, OpenMode  mode = OpenMode::ReadWriteCreate, ThreadMode  threadMode = ThreadMode::Serialized, Error *  openError = nullptr  )

static

Definition at line 16 of file SafeConnection.cpp.

{
   auto connection = Connection::Open(path, mode, threadMode);
 
   if (!connection)
   {
      if (openError)
         *openError = connection.GetError();
 
      return {};
   }
 
   return std::make_shared<SafeConnection>(Tag {}, std::move(*connection));
}

References audacity::sqlite::Connection::Open().

Referenced by audacity::cloud::audiocom::sync::CloudProjectsDatabase::OpenConnection().

Here is the call graph for this function:

Here is the caller graph for this function:

Reopen() [1/3]

std::shared_ptr< SafeConnection > audacity::sqlite::SafeConnection::Reopen ( const Connection &  connection, OpenMode  mode = OpenMode::ReadWriteCreate, ThreadMode  threadMode = ThreadMode::Serialized, Error *  openError = nullptr  )

static

Definition at line 33 of file SafeConnection.cpp.

{
   auto connection = Connection::Reopen(prevConnection, mode, threadMode);
 
   if (!connection)
   {
      if (openError)
         *openError = connection.GetError();
 
      return {};
   }
 
   return std::make_shared<SafeConnection>(Tag {}, std::move(*connection));
}

References audacity::sqlite::Connection::Reopen().

Here is the call graph for this function:

Reopen() [2/3]

std::shared_ptr< SafeConnection > audacity::sqlite::SafeConnection::Reopen ( SafeConnection &  connection, OpenMode  mode = OpenMode::ReadWriteCreate, ThreadMode  threadMode = ThreadMode::Serialized, Error *  openError = nullptr  )

static

Definition at line 67 of file SafeConnection.cpp.

{
   auto connection =
      Connection::Reopen(prevConnection.mConnection, mode, threadMode);
 
   if (!connection)
   {
      if (openError)
         *openError = connection.GetError();
 
      return {};
   }
 
   return std::make_shared<SafeConnection>(Tag {}, std::move(*connection));
}

References mConnection, and audacity::sqlite::Connection::Reopen().

Here is the call graph for this function:

Reopen() [3/3]

std::shared_ptr< SafeConnection > audacity::sqlite::SafeConnection::Reopen ( sqlite3 *  connection, OpenMode  mode = OpenMode::ReadWriteCreate, ThreadMode  threadMode = ThreadMode::Serialized, Error *  openError = nullptr  )

static

Definition at line 50 of file SafeConnection.cpp.

{
   auto connection = Connection::Reopen(prevConnection, mode, threadMode);
 
   if (!connection)
   {
      if (openError)
         *openError = connection.GetError();
 
      return {};
   }
 
   return std::make_shared<SafeConnection>(Tag {}, std::move(*connection));
}

References audacity::sqlite::Connection::Reopen().

Here is the call graph for this function:

Member Data Documentation

mConnection

Connection audacity::sqlite::SafeConnection::mConnection

private

Definition at line 80 of file SafeConnection.h.

Referenced by Reopen().

mConnectionMutex

MutexType audacity::sqlite::SafeConnection::mConnectionMutex

private

Definition at line 81 of file SafeConnection.h.

---

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

• SafeConnection.h
• SafeConnection.cpp