Base class for data stored to a file system (POSIX, SdFat, SPIFFS) More...

#include <StorageHelperRK.h>

Inheritance diagram for StorageHelperRK::PersistentDataFileSystem:

Public Member Functions
	PersistentDataFileSystem (FileSystemBase fs, const char filename, SavedDataHeader *savedDataHeader, size_t savedDataSize, uint32_t savedDataMagic, uint16_t savedDataVersion)
	Class for persistent data saved to a file system. More...

PersistentDataFileSystem &	withFilename (const char *filename)
	Sets the filename to use to store the data. More...

virtual bool	load ()
	Load the persistent data file. You normally do not need to call this; it will be loaded automatically. More...

virtual void	save ()
	Save the persistent data file. You normally do not need to call this; it will be saved automatically. More...

Public Member Functions inherited from StorageHelperRK::PersistentDataBase
	PersistentDataBase (SavedDataHeader *savedDataHeader, size_t savedDataSize, uint32_t savedDataMagic, uint16_t savedDataVersion)
	Base class for persistent data saved in file or RAM. More...

PersistentDataBase &	withSaveDelayMs (uint32_t value)
	Sets the wait to save delay. Default is 1000 milliseconds. More...

virtual void	setup ()
	Initialize this object for use in StorageHelperRK. More...

virtual void	flush (bool force)
	Write the settings to disk if changed and the wait to save time has expired. More...

virtual void	saveOrDefer ()
	Either saves data or immediately, or defers until later, based on saveDelayMs. More...

template<class T >
T	getValue (size_t offset) const
	Templated class for getting integral values (uint32_t, float, double, etc.) More...

template<class T >
void	setValue (size_t offset, T value)
	Templated class for setting integral values (uint32_t, float, double, etc.) More...

bool	getValueString (size_t offset, size_t size, String &value) const
	Get the value of a string. More...

bool	setValueString (size_t offset, size_t size, const char *value)
	Set the value of a string. More...

uint32_t	getHash () const
	Get the hash valid for data integrity checking.

Public Member Functions inherited from StorageHelperRK::CustomRecursiveMutex
	CustomRecursiveMutex (os_mutex_recursive_t handle)
	Construct a CustomRecursiveMutex wrapper object from an existing recursive mutex. More...

	CustomRecursiveMutex ()
	Default constructor with no mutex - one will be created on first lock.

	~CustomRecursiveMutex ()
	Destroys the underlying mutex object.

void	dispose ()
	Destroys the mutex object.

void	lock () const
	Locks the mutex. Creates a new recursive mutex object if it does not exist yet. More...

bool	trylock () const
	Attempts to lock the mutex. Creates a new recursive mutex object if it does not exist yet. More...

bool	try_lock () const
	Attempts to lock the mutex. Creates a new recursive mutex object if it does not exist yet. More...

void	unlock () const
	Unlocks the mutex. More...

Protected Attributes
FileSystemBase *	fs
	The file system object the persistent data will be stored on.

String	filename
	The filename on the file system.

Protected Attributes inherited from StorageHelperRK::PersistentDataBase
SavedDataHeader *	savedDataHeader = 0
	Pointer to the saved data header, which is followed by the data.

uint32_t	savedDataSize = 0
	Size of the saved data (header + actual data)

uint32_t	savedDataMagic
	Magic bytes for the saved data.

uint16_t	savedDataVersion
	Version number for the saved data.

uint32_t	lastUpdate = 0
	Last time the file was updated. 0 = file has not changed since writing to disk.

uint32_t	saveDelayMs = 1000
	How long to wait to save before writing file to disk. Set to 0 to write immediately.

Additional Inherited Members
Static Public Attributes inherited from StorageHelperRK::PersistentDataBase
static const uint32_t	HASH_SEED = 0x851c2a3f
	Murmur32 hash seed value (randomly generated)

Protected Member Functions inherited from StorageHelperRK::PersistentDataBase
	PersistentDataBase (const PersistentDataBase &)=delete

PersistentDataBase &	operator= (const PersistentDataBase &)=delete

virtual bool	validate (size_t dataSize)
	Used to validate the saved data structure. Used internally by load(). More...

virtual void	initialize ()
	Used to allow subclasses to initialize the saved data structure. Called internally by load(). More...

Detailed Description

Base class for data stored to a file system (POSIX, SdFat, SPIFFS)

Since using the Gen 3/P2/Photon 2 POSIX file system is a common use-case, there is a concrete subclass of this, PersistentDataFile, for use with POSIX file systems.

Constructor & Destructor Documentation

◆ PersistentDataFileSystem()

StorageHelperRK::PersistentDataFileSystem::PersistentDataFileSystem	(	FileSystemBase *	fs,
		const char *	filename,
		SavedDataHeader *	savedDataHeader,
		size_t	savedDataSize,
		uint32_t	savedDataMagic,
		uint16_t	savedDataVersion
	)

inline

Class for persistent data saved to a file system.

Parameters

fs	The FileSystemBase object subclass to use (Posix, SdFat, SPIFFS, etc.)
filename	The filename or pathname to the file used to save data
savedDataHeader	Pointer to the saved data header
savedDataSize	size of the whole structure, including the user data after it
savedDataMagic	Magic bytes to use for this data
savedDataVersion	Version to use for this data

The fs object passed into this constructor is deleted when this object is destructed.

You will probably want to use the withFilename() method to set the filename to save the data to.

Member Function Documentation

◆ load()

bool StorageHelperRK::PersistentDataFileSystem::load ( )

virtual

Load the persistent data file. You normally do not need to call this; it will be loaded automatically.

Returns: true; false

Reimplemented from StorageHelperRK::PersistentDataBase.

◆ save()

void StorageHelperRK::PersistentDataFileSystem::save ( )

virtual

Save the persistent data file. You normally do not need to call this; it will be saved automatically.

Reimplemented from StorageHelperRK::PersistentDataBase.

◆ withFilename()

PersistentDataFileSystem & StorageHelperRK::PersistentDataFileSystem::withFilename ( const char * filename )

inline

Sets the filename to use to store the data.

Parameters

filename

Returns: PersistentDataFileSystem&

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

src/StorageHelperRK.h
src/StorageHelperRK.cpp

Public Member Functions

Protected Attributes