CloudBuilder::CFilesystemManager Class Reference

#include <CFilesystem.h>

Public Member Functions
bool	Delete (const char *aRelativePath)
CInputFile *	OpenFileForReading (const char *aRelativeName)
COutputFile *	OpenFileForWriting (const char *aRelativeName)
void	SetFilesystemHandler (CFilesystemHandler *aHandler, bool aDeleteAutomatically=true)
CotCHelpers::CHJSON *	ReadJson (const char *aRelativeName)
bool	WriteJson (const char *aRelativeName, const CotCHelpers::CHJSON *aJSON)

Static Public Member Functions
static CFilesystemManager *	Instance ()

Friends
struct	singleton_holder< CFilesystemManager >
void	CClan::Setup (const CotCHelpers::CHJSON *, CResultHandler *)
void	CClan::Terminate ()

Detailed Description

File system manager, allowing to write and read files. This class is used by the system but users may also have access to it. You can pass a custom file system handler in order to customize how and where files are written on your system.

Member Function Documentation

Delete()

bool CloudBuilder::CFilesystemManager::Delete

(

const char *

aRelativePath

)

Deletes a file.

Parameters

aRelativePath

file name.

Returns

whether the deletion succeeded.

Instance()

static CFilesystemManager* CloudBuilder::CFilesystemManager::Instance ( )

static

Returns

a static instance of this manager.

OpenFileForReading()

CInputFile* CloudBuilder::CFilesystemManager::OpenFileForReading

(

const char *

aRelativeName

)

Opens a file for input.

Parameters

aRelativeName

file name.

Returns

an input file – may not actually be opened (check isOpen()).

OpenFileForWriting()

COutputFile* CloudBuilder::CFilesystemManager::OpenFileForWriting

(

const char *

aRelativeName

)

Opens a file for output.

Parameters

aRelativeName

file name.

Returns

an output file – may not actually be writable (check isOpen()).

ReadJson()

CotCHelpers::CHJSON* CloudBuilder::CFilesystemManager::ReadJson

(

const char *

aRelativeName

)

Reads a JSON persisted to the storage.

Parameters

aRelativeName

file name.

Returns

a JSON that you need to delete.

SetFilesystemHandler()

void CloudBuilder::CFilesystemManager::SetFilesystemHandler	(	CFilesystemHandler *	aHandler,
		bool	aDeleteAutomatically = true
	)

Allows to replace the file system handler. You can use that if you want to persist data in a special fashion, such as in RAM.

Parameters

aHandler	handler to use from now on.
aDeleteAutomatically	whether to delete this instance when no longer used.

---

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

• E:/XtraLife/GitHub/XtraLife/cloudbuilder/CloudBuilder/Headers/CFilesystem.h