Simias::Sync::OutFile Class Reference

Class to handle file operations for a file to be synced out. More...

Inheritance diagram for Simias::Sync::OutFile:

[legend]

Collaboration diagram for Simias::Sync::OutFile:

[legend]

List of all members.

Public Member Functions
int	Read (Stream stream, int count)
	Reads data into the buffer.
void	CreateHashMap ()
	Called to create the hash map for the uploaded file.
void	CreateHashMapFile ()
	Called to create the hash map for the uploaded file.
void	DeleteHashMap ()
	Called to delete the hash map since it is not stored in the simias client.
FileStream	GetHashMap (out int entryCount, out int blockSize)
	Called to get the hash map stream for the uploaded file.
Protected Member Functions
	OutFile (Collection collection)
	Constructs an OutFile object.
void	Open (BaseFileNode node, string sessionID)
	Called to open the file.
void	Close ()
	Called to close the file and cleanup resources.
Properties
StreamStream	OutStream [get]
	Gets the output stream.
StreamStream	outStream [get]
	Get the platform file handle.
long	ReadPosition [get, set]
	Gets or Sets the file position.
long	Length [get]
	Gets the length of the stream.

---

Detailed Description

Class to handle file operations for a file to be synced out.

---

Constructor & Destructor Documentation

Simias::Sync::OutFile::OutFile

(

Collection

collection

)

[inline, protected]

Constructs an OutFile object.

Parameters:

collection

The collection that the node belongs to.

---

Member Function Documentation

int Simias::Sync::OutFile::Read	(	Stream	stream,
		int	count
	)			[inline]

Reads data into the buffer.

Parameters:

	stream	The stream to read into.
	count	The number of bytes to read.

Returns:

void Simias::Sync::OutFile::Open	(	BaseFileNode	node,
		string	sessionID
	)			[inline, protected]

Called to open the file.

Parameters:

	node	The node that represents the file.
	sessionID	The unique session ID.

void Simias::Sync::OutFile::CreateHashMap

(

)

[inline]

Called to create the hash map for the uploaded file.

void Simias::Sync::OutFile::CreateHashMapFile

(

)

[inline]

Called to create the hash map for the uploaded file.

void Simias::Sync::OutFile::DeleteHashMap

(

)

[inline]

Called to delete the hash map since it is not stored in the simias client.

FileStream Simias::Sync::OutFile::GetHashMap	(	out int	entryCount,
		out int	blockSize
	)			[inline]

Called to get the hash map stream for the uploaded file.

Reimplemented in Simias::Sync::ServerOutFile.

void Simias::Sync::OutFile::Close

(

)

[inline, protected]

Called to close the file and cleanup resources.

Reimplemented in Simias::Sync::ServerOutFile.

---

Property Documentation

StreamStream Simias::Sync::OutFile::OutStream [get, protected]

Gets the output stream.

StreamStream Simias::Sync::OutFile::outStream [get]

Get the platform file handle.

long Simias::Sync::OutFile::ReadPosition [get, set]

Gets or Sets the file position.

long Simias::Sync::OutFile::Length [get]

Gets the length of the stream.

---

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

• src/core/Sync/SyncFile.cs