ScopedRead

Fully qualified name: carb::settings::ScopedRead

Defined in carb/settings/detail/ISettingsCommon.h

class ScopedRead : public carb::dictionary::ScopedRead

A helper class for performing a scoped read lock on the settings database.

Public Functions

inline ScopedRead()

RAII constructor.

Immediately takes a read lock and holds it until *this is destroyed.

Note

Settings locks are recursive.

inline ScopedRead(

const ISettings *settings,

dictionary::IDictionary *dict = carb::getCachedInterface<dictionary::IDictionary>(),

)

RAII constructor.

Immediately takes a read lock and holds it until *this is destroyed. This version takes interface pointers for cases where it’s not safe to use getCachedInterface().

Note

Settings locks are recursive.

Parameters:

• settings – The ISettings interface to lock with.

• dict – The carb::dictionary::IDictionary interface to lock with.

~ScopedRead() = default

Destructor. Releases the read lock.