v1.1.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Modules Pages
Public Member Functions | List of all members
Sifteo::FilesystemInfo Class Reference

Information about the composition of the filesystem. More...

#include <sifteo/filesystem.h>

Public Member Functions

uint32_t allocationUnitSize ()
 Return the size of one allocation unit. More...
 
uint32_t freeBytes ()
 Free space, in bytes.
 
uint32_t freeUnits ()
 Free space, in allocation units.
 
uint32_t gameElfBytes ()
 Space used by all game ELF binaries, in bytes.
 
uint32_t gameElfUnits ()
 Space used by all game ELF binaries, in allocation units.
 
uint32_t gameObjBytes ()
 Space used by all game StoredObjects, in bytes.
 
uint32_t gameObjUnits ()
 Space used by all game StoredObjects, in allocation units.
 
void gather ()
 Inspects the current state of the filesystem, and fills in the FilesystemInfo accordingly. More...
 
uint32_t launcherElfBytes ()
 Space used by the launcher's ELF binary, in bytes.
 
uint32_t launcherElfUnits ()
 Space used by the launcher's ELF binary, in allocation units.
 
uint32_t launcherObjBytes ()
 Space used by the launcher's StoredObjects, in bytes.
 
uint32_t launcherObjUnits ()
 Space used by the launcher's StoredObjects, in allocation units.
 
uint32_t selfElfBytes ()
 Space used by the current volume's ELF binary, in bytes.
 
uint32_t selfElfUnits ()
 Space used by the current volume's ELF binary, in allocation units.
 
uint32_t selfObjBytes ()
 Space used by the current volume's StoredObjects, in bytes.
 
uint32_t selfObjUnits ()
 Space used by the current volume's StoredObjects, in allocation units.
 
uint32_t systemBytes ()
 Space used by system data, in bytes.
 
uint32_t systemUnits ()
 
uint32_t totalBytes ()
 Total space, in bytes.
 
uint32_t totalUnits ()
 Total space, in allocation units.
 

Detailed Description

Information about the composition of the filesystem.

This object contains global information about our filesystem, including its total size and amount of free space, as well as space usage totals separated out by category.

The default constructor leaves FilesystemInfo uninitialized. Fill it in with up-to-date information by calling gather().

Member Function Documentation

uint32_t Sifteo::FilesystemInfo::allocationUnitSize ( )
inline

Return the size of one allocation unit.

The filesystem allocates space to Volumes in relatively large units. This returns the size of that unit, in bytes.

void Sifteo::FilesystemInfo::gather ( )
inline

Inspects the current state of the filesystem, and fills in the FilesystemInfo accordingly.

This is a relatively heavyweight operation, similar to Volume::list()

uint32_t Sifteo::FilesystemInfo::systemUnits ( )
inline

Space used by system data, in allocation units

System data includes cube pairing information, asset caching data, and other internal storage used to implement basic system functionality. This is the same data which appears as 'system' space in swiss manifest.


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