Engine::IndexFileT< FileT > Class Template Reference

#include <LogMsgFile.h>

Collaboration diagram for Engine::IndexFileT< FileT >:

Classes
class	Data

Public Types
typedef IndexFile_Header	Header
typedef IndexFile_MagicNumber	MagicNumber
typedef IndexFile_Offset	Offset
typedef IndexFile_Reserved	Reserved
typedef IndexFile_Version	Version

Public Member Functions
void	close ()
void	flush ()
Offset	getFileSize () const
void	getLastMsgData (Data &data)
Offset	getSize () const
bool	hasNext ()
	IndexFileT (FileT &file, bool chunkAlloc, bool readonly=false)
void	load (Offset offset, Data &data)
bool	next (Offset &offset)
bool	next (Data &data)
bool	prev (Offset &offset)
bool	prev (Data &data)
void	read (Data &data)
void	save (Offset offset, const Data &data)
void	seekTo (Offset offset)
void	sync ()
Offset	tell () const
void	toBegin ()
void	toEnd ()
Offset	write (const Data &data, bool flush=false)

Static Public Member Functions
static MagicNumber	generateMagicNumber (Header &header)
static bool	isValid (Header &header)

Protected Attributes
FastFileT< FileT >	file_
Header	header_
const bool	readonly_

Member Typedef Documentation

template<typename FileT>

typedef IndexFile_Header Engine::IndexFileT< FileT >::Header

template<typename FileT>

typedef IndexFile_MagicNumber Engine::IndexFileT< FileT >::MagicNumber

template<typename FileT>

typedef IndexFile_Offset Engine::IndexFileT< FileT >::Offset

template<typename FileT>

typedef IndexFile_Reserved Engine::IndexFileT< FileT >::Reserved

template<typename FileT>

typedef IndexFile_Version Engine::IndexFileT< FileT >::Version

Constructor & Destructor Documentation

template<typename FileT>

Engine::IndexFileT< FileT >::IndexFileT	(	FileT &	file,
		bool	chunkAlloc,
		bool	readonly = false
	)

References Engine::IndexFileT< FileT >::file_, Engine::IndexFileT< FileT >::generateMagicNumber(), Engine::IndexFileT< FileT >::getFileSize(), Engine::IndexFileT< FileT >::header_, Engine::v3::INDEX_FILE_VERSION, Engine::IndexFileT< FileT >::Data::isValid(), Engine::IndexFileT< FileT >::isValid(), Engine::IndexFile_Header::magicNumber, Engine::IndexFileT< FileT >::read(), Engine::IndexFileT< FileT >::readonly_, Engine::IndexFileT< FileT >::Data::SIZE, Engine::IndexFileT< FileT >::tell(), and Engine::IndexFile_Header::version.

Member Function Documentation

template<typename FileT >

void Engine::IndexFileT< FileT >::close

(

)

template<typename FileT >

void Engine::IndexFileT< FileT >::flush

(

)

template<typename FileT >

Engine::IndexFileT< FileT >::MagicNumber Engine::IndexFileT< FileT >::generateMagicNumber ( Header &  header )

static

References Engine::IndexFile_Header::version.

Referenced by Engine::IndexFileT< FileT >::IndexFileT().

template<typename FileT >

Engine::IndexFileT< FileT >::Offset Engine::IndexFileT< FileT >::getFileSize

(

)

const

Referenced by Engine::IndexFileT< FileT >::IndexFileT().

template<typename FileT >

void Engine::IndexFileT< FileT >::getLastMsgData

(

Data &

data

)

template<typename FileT >

Engine::IndexFileT< FileT >::Offset Engine::IndexFileT< FileT >::getSize

(

)

const

template<typename FileT >

bool Engine::IndexFileT< FileT >::hasNext

(

)

template<typename FileT >

bool Engine::IndexFileT< FileT >::isValid ( Header &  header )

static

References Engine::IndexFile_Header::magicNumber.

Referenced by Engine::IndexFileT< FileT >::IndexFileT().

template<typename FileT >

void Engine::IndexFileT< FileT >::load	(	Offset	offset,
		Data &	data
	)

template<typename FileT >

bool Engine::IndexFileT< FileT >::next

(

Offset &

offset

)

template<typename FileT >

bool Engine::IndexFileT< FileT >::next

(

Data &

data

)

References Engine::IndexFileT< FileT >::Data::isValid().

template<typename FileT >

bool Engine::IndexFileT< FileT >::prev

(

Offset &

offset

)

template<typename FileT >

bool Engine::IndexFileT< FileT >::prev

(

Data &

data

)

template<typename FileT >

void Engine::IndexFileT< FileT >::read

(

Data &

data

)

References Engine::IndexFileT< FileT >::Data::getBuffer(), Engine::v3::INDEX_FILE_VERSION, Engine::IndexFileT< FileT >::Data::isValid(), and Engine::IndexFileT< FileT >::Data::reset().

Referenced by Engine::IndexFileT< FileT >::IndexFileT().

template<typename FileT >

void Engine::IndexFileT< FileT >::save	(	Offset	offset,
		const Data &	data
	)

References Engine::IndexFileT< FileT >::Data::getBuffer(), and Engine::IndexFileT< FileT >::Data::isValid().

template<typename FileT >

void Engine::IndexFileT< FileT >::seekTo

(

Offset

offset

)

template<typename FileT >

void Engine::IndexFileT< FileT >::sync

(

)

template<typename FileT >

Engine::IndexFileT< FileT >::Offset Engine::IndexFileT< FileT >::tell

(

)

const

Referenced by Engine::IndexFileT< FileT >::IndexFileT().

template<typename FileT >

void Engine::IndexFileT< FileT >::toBegin

(

)

template<typename FileT >

void Engine::IndexFileT< FileT >::toEnd

(

)

template<typename FileT >

Engine::IndexFileT< FileT >::Offset Engine::IndexFileT< FileT >::write	(	const Data &	data,
		bool	flush = false
	)

References Engine::IndexFileT< FileT >::Data::getBuffer(), Engine::IndexFileT< FileT >::Data::getPersistentData(), Engine::IndexFileT< FileT >::Data::isValid(), and Engine::PersistentData::timestampUsec.

Member Data Documentation

template<typename FileT>

FastFileT<FileT> Engine::IndexFileT< FileT >::file_

protected

Referenced by Engine::IndexFileT< FileT >::IndexFileT().

template<typename FileT>

Header Engine::IndexFileT< FileT >::header_

protected

Referenced by Engine::IndexFileT< FileT >::IndexFileT().

template<typename FileT>

const bool Engine::IndexFileT< FileT >::readonly_

protected

Referenced by Engine::IndexFileT< FileT >::IndexFileT().