Simias::Storage::LogFileHeader Class Reference

Contains the layout of the LogFile header information. More...

List of all members.

Public Member Functions
	LogFileHeader (string ID, uint maxRecords)
	Initializes a new instance of the struct.
	LogFileHeader (byte[] encodedRecord)
	Initializes a new instance of the struct from an encoded byte array.
byte[]	ToByteArray ()
	Converts the object to a formatted byte array.
Properties
int	Length [get]
	Gets the length of the record.
string	LogFileID [get, set]
	Gets or sets the logFileID.
uint	MaxLogRecords [get, set]
	Gets or sets the maximum number of ChangeLog records in the file.
static int	RecordSize [get]
	Returns the size of the LogFileHeader record.
ulong	LastRecord [get, set]
	Gets or sets the last record written to the file. This is only a hint and may or may not be valid.
long	RecordLocation [get, set]
	Gets or sets the file position of the last record in the file. This is just a hint and may or may not be valid.

---

Detailed Description

Contains the layout of the LogFile header information.

---

Constructor & Destructor Documentation

Simias::Storage::LogFileHeader::LogFileHeader	(	string	ID,
		uint	maxRecords
	)			[inline]

Initializes a new instance of the struct.

Parameters:

	ID	Contains the identifier for this log file.
	maxRecords	Maximum number of records to keep persisted in the file.

Simias::Storage::LogFileHeader::LogFileHeader

(

byte[]

encodedRecord

)

[inline]

Initializes a new instance of the struct from an encoded byte array.

Parameters:

encodedRecord

LogFileHeader encoded record.

---

Member Function Documentation

byte [] Simias::Storage::LogFileHeader::ToByteArray

(

)

[inline]

Converts the object to a formatted byte array.

Returns:

A formatted byte array containing the LogFileHeader data.

---

Property Documentation

int Simias::Storage::LogFileHeader::Length [get]

Gets the length of the record.

string Simias::Storage::LogFileHeader::LogFileID [get, set]

Gets or sets the logFileID.

uint Simias::Storage::LogFileHeader::MaxLogRecords [get, set]

Gets or sets the maximum number of ChangeLog records in the file.

int Simias::Storage::LogFileHeader::RecordSize [static, get]

Returns the size of the LogFileHeader record.

ulong Simias::Storage::LogFileHeader::LastRecord [get, set]

Gets or sets the last record written to the file. This is only a hint and may or may not be valid.

long Simias::Storage::LogFileHeader::RecordLocation [get, set]

Gets or sets the file position of the last record in the file. This is just a hint and may or may not be valid.

---

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

• src/core/ChangeLog/ChangeLog.cs