Simias::Sync::StreamStream Class Reference

Class to copy data from one stream to another. More...

Collaboration diagram for Simias::Sync::StreamStream:

[legend]

List of all members.

Public Member Functions
	StreamStream (Stream stream)
	Constructor.
override void	Flush ()
	Flushes the stream.
override int	Read (byte[] buffer, int offset, int count)
	Read data from the stream.
override void	Write (byte[] buffer, int offset, int count)
	Write data to the stream.
override long	Seek (long offset, SeekOrigin origin)
	Move the current stream posistion to the specified location.
override void	SetLength (long value)
	Set the stream length.
int	Read (Stream outStream, int count)
	Read into the supplied stream.
int	Read (Stream outStream, int count, string encryptionAlgorithm, string EncryptionKey)
	Read into the supplied stream.
void	Write (Stream inStream, int count)
	Write the data from the supplied stream to this stream.
void	Write (Stream inStream, int count, int actualCount, string encryptionAlgorithm, string EncryptionKey)
	Write the data from the supplied stream to this stream.
override void	Close ()
	Close the stream.
Properties
override bool	CanRead [get]
	Returns true if the stream support reads.
override bool	CanSeek [get]
	Returns true is the stream supports seeks.
override bool	CanWrite [get]
	Returns true if the stream supports writes.
override long	Length [get]
	Returns the length of the stream.
override long	Position [get, set]
	Gets or Sets the posistion of the stream.
Stream	fStream [get]
	Get the stream.

---

Detailed Description

Class to copy data from one stream to another.

---

Constructor & Destructor Documentation

Simias::Sync::StreamStream::StreamStream

(

Stream

stream

)

[inline]

Constructor.

Parameters:

stream

The Stream to construct the object from.

---

Member Function Documentation

override void Simias::Sync::StreamStream::Flush

(

)

[inline]

Flushes the stream.

override int Simias::Sync::StreamStream::Read	(	byte[]	buffer,
		int	offset,
		int	count
	)			[inline]

Read data from the stream.

Parameters:

	buffer	The buffer to read into.
	offset	The offset in the buffer to begin storing data.
	count	The number of bytes to read.

Returns:

override void Simias::Sync::StreamStream::Write	(	byte[]	buffer,
		int	offset,
		int	count
	)			[inline]

Write data to the stream.

Parameters:

	buffer	The buffer containing the data to write.
	offset	The offset in the buffer where the data begins.
	count	The number of bytes to write.

override long Simias::Sync::StreamStream::Seek	(	long	offset,
		SeekOrigin	origin
	)			[inline]

Move the current stream posistion to the specified location.

Parameters:

	offset	The offset from the origin to seek.
	origin	The origin to seek from.

Returns:

The new position.

override void Simias::Sync::StreamStream::SetLength

(

long

value

)

[inline]

Set the stream length.

Parameters:

value

The length to set.

int Simias::Sync::StreamStream::Read	(	Stream	outStream,
		int	count
	)			[inline]

Read into the supplied stream.

Parameters:

	outStream	The stream to recieve the data.
	count	The number of bytes to read.

Returns:

The number of bytes read.

int Simias::Sync::StreamStream::Read	(	Stream	outStream,
		int	count,
		string	encryptionAlgorithm,
		string	EncryptionKey
	)			[inline]

Read into the supplied stream.

Parameters:

	outStream	The stream to recieve the data.
	count	The number of bytes to read.
	encryption_key	The key string to encrypt the data.

Returns:

The number of bytes read.

void Simias::Sync::StreamStream::Write	(	Stream	inStream,
		int	count
	)			[inline]

Write the data from the supplied stream to this stream.

Parameters:

	inStream	The data to write.
	count	The number of bytes to write.

void Simias::Sync::StreamStream::Write	(	Stream	inStream,
		int	count,
		int	actualCount,
		string	encryptionAlgorithm,
		string	EncryptionKey
	)			[inline]

Write the data from the supplied stream to this stream.

Parameters:

	inStream	The data to write.
	count	The number of bytes to write.
	encryption_key	Key to encrypt the data with.

override void Simias::Sync::StreamStream::Close

(

)

[inline]

Close the stream.

---

Property Documentation

override bool Simias::Sync::StreamStream::CanRead [get]

Returns true if the stream support reads.

override bool Simias::Sync::StreamStream::CanSeek [get]

Returns true is the stream supports seeks.

override bool Simias::Sync::StreamStream::CanWrite [get]

Returns true if the stream supports writes.

override long Simias::Sync::StreamStream::Length [get]

Returns the length of the stream.

override long Simias::Sync::StreamStream::Position [get, set]

Gets or Sets the posistion of the stream.

Stream Simias::Sync::StreamStream::fStream [get]

Get the stream.

---

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

• src/core/Sync/StreamStream.cs