roo_prefs
API Documentation for roo_prefs
Loading...
Searching...
No Matches
roo_prefs::LazyWritePref< T > Class Template Reference

#include <lazy_write_pref.h>

Public Member Functions

 LazyWritePref (Collection &collection, roo_scheduler::Scheduler &scheduler, const char *key, T default_value=T(), uint8_t stable_write_latency_s=2, uint8_t unstable_write_latency_s=10)
 Creates a lazy-write preference. The data is flushed to persistent storage using scheduler, after it has been stable for at least stable_write_latency seconds, but no later than unstable_write_latency_s after the last write.
 
bool isSet () const
 
const T & get () const
 
bool set (const T &value)
 
bool clear ()
 

Detailed Description

template<typename T>
class roo_prefs::LazyWritePref< T >

Definition at line 16 of file lazy_write_pref.h.

Constructor & Destructor Documentation

◆ LazyWritePref()

template<typename T >
roo_prefs::LazyWritePref< T >::LazyWritePref ( Collection collection,
roo_scheduler::Scheduler &  scheduler,
const char *  key,
default_value = T(),
uint8_t  stable_write_latency_s = 2,
uint8_t  unstable_write_latency_s = 10 
)

Creates a lazy-write preference. The data is flushed to persistent storage using scheduler, after it has been stable for at least stable_write_latency seconds, but no later than unstable_write_latency_s after the last write.

Definition at line 61 of file lazy_write_pref.h.

Member Function Documentation

◆ clear()

template<typename T >
bool roo_prefs::LazyWritePref< T >::clear ( )

◆ get()

template<typename T >
const T & roo_prefs::LazyWritePref< T >::get ( ) const

Definition at line 81 of file lazy_write_pref.h.

◆ isSet()

template<typename T >
bool roo_prefs::LazyWritePref< T >::isSet ( ) const

Definition at line 76 of file lazy_write_pref.h.

◆ set()

template<typename T >
bool roo_prefs::LazyWritePref< T >::set ( const T &  value)

Definition at line 86 of file lazy_write_pref.h.


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