IFS::IObjectStore Class Reference

#include <ObjectStore.h>

Inheritance diagram for IFS::IObjectStore:

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

Constructor & Destructor Documentation

~IObjectStore()

virtual IFS::IObjectStore::~IObjectStore ( )

inlinevirtual

Member Function Documentation

close()

virtual int IFS::IObjectStore::close ( FWObjDesc &  od )

pure virtual

close an object descriptor

Parameters

od

Return values

int	error code

Note

the implementation should free any allocated resources

Implemented in IFS::FWFS::ObjectStore.

getPartition()

virtual Storage::Partition& IFS::IObjectStore::getPartition ( )

pure virtual

Implemented in IFS::FWFS::ObjectStore.

initialise()

virtual int IFS::IObjectStore::initialise ( )

pure virtual

called by FWFS

Return values

error

code

Implemented in IFS::FWFS::ObjectStore.

isMounted()

virtual bool IFS::IObjectStore::isMounted ( )

pure virtual

determine if store is mounted

Return values

true	if mounted

Implemented in IFS::FWFS::ObjectStore.

mounted()

virtual int IFS::IObjectStore::mounted ( const FWObjDesc &  od )

pure virtual

called by FWFS to confirm successful mount

Parameters

od	last object (the end marker)

Return values

int	error code

Implemented in IFS::FWFS::ObjectStore.

open()

virtual int IFS::IObjectStore::open ( FWObjDesc &  od )

pure virtual

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

Implemented in IFS::FWFS::ObjectStore.

openChild()

virtual int IFS::IObjectStore::openChild ( const FWObjDesc &  parent, const FWObjDesc &  child, FWObjDesc &  od  )

pure virtual

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

Implemented in IFS::FWFS::ObjectStore.

readChildHeader()

virtual int IFS::IObjectStore::readChildHeader ( const FWObjDesc &  parent, FWObjDesc &  child  )

pure virtual

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.

Implemented in IFS::FWFS::ObjectStore.

readContent()

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

pure virtual

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

Implemented in IFS::FWFS::ObjectStore.

readHeader()

virtual int IFS::IObjectStore::readHeader ( FWObjDesc &  od )

pure virtual

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

Implemented in IFS::FWFS::ObjectStore.

---

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

• ObjectStore.h