IFS::FWFS::ObjectStore Class Reference

object store for read-only filesystem More...

#include <ObjectStore.h>

Inheritance diagram for IFS::FWFS::ObjectStore:

Collaboration diagram for IFS::FWFS::ObjectStore:

Public Member Functions
	ObjectStore (Storage::Partition partition)
int	initialise () override
	called by FWFS More...
int	mounted (const FWObjDesc &od) override
	called by FWFS to confirm successful mount More...
bool	isMounted () override
	determine if store is mounted More...
int	open (FWObjDesc &od) override
	find an object and return a descriptor for it More...
int	openChild (const FWObjDesc &parent, const FWObjDesc &child, FWObjDesc &od) override
	open a descriptor for a child object More...
int	readHeader (FWObjDesc &od) override
	read a root object header More...
int	readChildHeader (const FWObjDesc &parent, FWObjDesc &child) override
	fetch child object header More...
int	readContent (const FWObjDesc &od, uint32_t offset, uint32_t size, void *buffer) override
	read object content More...
int	close (FWObjDesc &od) override
	close an object descriptor More...
Storage::Partition &	getPartition () override
Public Member Functions inherited from IFS::IObjectStore
virtual	~IObjectStore ()

Detailed Description

object store for read-only filesystem

Constructor & Destructor Documentation

ObjectStore()

IFS::FWFS::ObjectStore::ObjectStore ( Storage::Partition  partition )

inline

Member Function Documentation

close()

int IFS::FWFS::ObjectStore::close ( FWObjDesc &  od )

overridevirtual

close an object descriptor

Parameters

od

Return values

int	error code

Note

the implementation should free any allocated resources

Implements IFS::IObjectStore.

getPartition()

Storage::Partition& IFS::FWFS::ObjectStore::getPartition ( )

inlineoverridevirtual

Implements IFS::IObjectStore.

initialise()

int IFS::FWFS::ObjectStore::initialise ( )

overridevirtual

called by FWFS

Return values

error

code

Implements IFS::IObjectStore.

isMounted()

bool IFS::FWFS::ObjectStore::isMounted ( )

inlineoverridevirtual

determine if store is mounted

Return values

true	if mounted

Implements IFS::IObjectStore.

mounted()

int IFS::FWFS::ObjectStore::mounted ( const FWObjDesc &  od )

overridevirtual

called by FWFS to confirm successful mount

Parameters

od	last object (the end marker)

Return values

int	error code

Implements IFS::IObjectStore.

open()

int IFS::FWFS::ObjectStore::open ( FWObjDesc &  od )

overridevirtual

find an object and return a descriptor for it

Parameters

od	IN/OUT: resolved object

Return values

int	error code

Note

od.ref must be initialised

Implements IFS::IObjectStore.

openChild()

int IFS::FWFS::ObjectStore::openChild ( const FWObjDesc &  parent, const FWObjDesc &  child, FWObjDesc &  od  )

overridevirtual

open a descriptor for a child object

Parameters

parent
child	reference to child, relative to parent
od	OUT: resolved object

Return values

int	error code

Implements IFS::IObjectStore.

readChildHeader()

int IFS::FWFS::ObjectStore::readChildHeader ( const FWObjDesc &  parent, FWObjDesc &  child  )

overridevirtual

fetch child object header

Parameters

parent
child	uninitialised child, returns result

Return values

error

code

Note

references are not pursued; the caller must handle that child.ref refers to position relative to parent Implementations must set child.storenum = parent.storenum; other values will be meaningless as object stores are unaware of other stores.

Implements IFS::IObjectStore.

readContent()

int IFS::FWFS::ObjectStore::readContent ( const FWObjDesc &  od, uint32_t  offset, uint32_t  size, void *  buffer  )

overridevirtual

read object content

Parameters

offset	location to start reading, from start of object content
size	bytes to read
buffer	to store data

Return values

number

of bytes read, or error code

Note

must fail if cannot read all requested bytes

Implements IFS::IObjectStore.

readHeader()

int IFS::FWFS::ObjectStore::readHeader ( FWObjDesc &  od )

overridevirtual

read a root object header

Parameters

od	object descriptor, with offset and ID fields initialised

Return values

error

code

Note

this method deals with top-level objects only

Implements IFS::IObjectStore.

---

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

• FWFS/ObjectStore.h