SettingTransaction Class Reference

Extend SettingScope with Commit() which flushes updates in a batch. More...

#include <Prefs.h>

Inheritance diagram for SettingTransaction:

Collaboration diagram for SettingTransaction:

Public Member Functions
bool	Commit ()
Public Member Functions inherited from SettingScope
	SettingScope ()
	~SettingScope () noexcept
	SettingScope (const SettingScope &)=delete
SettingScope &	operator= (const SettingScope &)=delete

Additional Inherited Members
Public Types inherited from SettingScope
enum	AddResult { NotAdded , Added , PreviouslyAdded }
Static Public Member Functions inherited from SettingScope
static AddResult	Add (TransactionalSettingBase &setting)
Protected Attributes inherited from SettingScope
std::set< TransactionalSettingBase * >	mPending
bool	mCommitted = false

Detailed Description

Extend SettingScope with Commit() which flushes updates in a batch.

Construct one; then write to some Setting objects; then Commit() before destruction to keep the changes, or else the destructor rolls them back.

Flushes preferences on successful commit.

Nesting of SettingTransaction is not supported. No copy or move.

Definition at line 148 of file Prefs.h.

Member Function Documentation

Commit()

bool SettingTransaction::Commit

(

)

Returns

true if successful

It is unlikely to return false, but in that case an unflushed, partial write of changes to the config file may have happened

Definition at line 322 of file Prefs.cpp.

{
   if (sScopes.empty() || sScopes.back() != this)
      return false;
   
   if ( !mCommitted ) {
      for ( auto pSetting : mPending )
         if ( !pSetting->Commit() )
            return false;
      
      if (sScopes.size() > 1 || gPrefs->Flush())
      {
         mPending.clear();
         mCommitted = true;
         return true;
      }
   }
   
   return false;
}

References audacity::BasicSettings::Flush(), gPrefs, and anonymous_namespace{Prefs.cpp}::sScopes.

Referenced by FindFFmpegLibs().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Prefs.h
• Prefs.cpp