zeus::TFilterInputStream Class Reference

#include <FilterInputStream.h>

Inheritance diagram for zeus::TFilterInputStream:

List of all members.

Public Member Functions
	TFilterInputStream (IInputStream &rParentStream)
virtual bool MQUALIFIER	available () const
virtual bool MQUALIFIER	isEndReached () const
virtual Retval MQUALIFIER	read (char *pBuffer, Int iBufferSize, Int &rValidSize) const
virtual Int MQUALIFIER	readItem () const
virtual void MQUALIFIER	close ()
virtual void MQUALIFIER	reset ()
virtual bool MQUALIFIER	skip (Int iBytes=1)
Protected Member Functions
	TFilterInputStream (IInputStream &rParentStream, bool bDirectCreated)
virtual	~TFilterInputStream ()
virtual Retval	delegateReadBlockToReadItem (char *pBuffer, Int iBufferSize, Int &rValidSize) const

---

Detailed Description

The filter input stream is used to filter streams before reading them. To implement any filter you must simply overwrite the read method and filter the incomming buffer of the parent stream

---

Constructor & Destructor Documentation

TFilterInputStream::TFilterInputStream

(

IInputStream &

rParentStream )

Creates a filter input stream

Parameters:

rParentStream

: Parent stream (source)

TFilterInputStream::TFilterInputStream	(	IInputStream &	rParentStream,
		bool	bDirectCreated
	)		[protected]

Creates a filter input stream

Parameters:

rParentStream	: Parent stream (source)
bDirectCreated	: Dummy, is used to avoid an addref on the input stream

TFilterInputStream::~TFilterInputStream

(

)

[protected, virtual]

Destroys the filter input stream

---

Member Function Documentation

bool MQUALIFIER zeus::TFilterInputStream::available

(

)

const [inline, virtual]

See also:

IInputStream::available

Reimplemented from zeus::TAbstractInputStream.

void MQUALIFIER zeus::TFilterInputStream::close

(

)

[inline, virtual]

See also:

IInputStream::close

Implements zeus::TAbstractInputStream.

Retval TFilterInputStream::delegateReadBlockToReadItem	(	char *	pBuffer,
		Int	iBufferSize,
		Int &	rValidSize
	)		const [protected, virtual]

This method dispatches the read-Block method to the readItem method

bool MQUALIFIER zeus::TFilterInputStream::isEndReached

(

)

const [inline, virtual]

See also:

IInputStream::isEndReached

Implements zeus::TAbstractInputStream.

Retval MQUALIFIER zeus::TFilterInputStream::read	(	char *	pBuffer,
		Int	iBufferSize,
		Int &	rValidSize
	)		const [inline, virtual]

See also:

IInputStream::read

Implements zeus::TAbstractInputStream.

Reimplemented in zeus::TCryptedInputStream, zeus::TBase64InputStream, zeus::TTextInputStream, and zeus::TZippedInputStream.

Int MQUALIFIER zeus::TFilterInputStream::readItem

(

)

const [inline, virtual]

See also:

IInputStream::readItem

Implements zeus::TAbstractInputStream.

Reimplemented in zeus::TCryptedInputStream, zeus::TBase64InputStream, zeus::TTextInputStream, and zeus::TZippedInputStream.

void MQUALIFIER zeus::TFilterInputStream::reset

(

)

[inline, virtual]

See also:

IInputStream::reset

Implements zeus::TAbstractInputStream.

Reimplemented in zeus::TCryptedInputStream.

bool MQUALIFIER TFilterInputStream::skip

(

Int

iBytes = 1 )

[virtual]

The skip method needs to read bytes, since we don't know about the encoding and filter implementation. Therefore the skipping of one byte might be skipping of multible bytes on the origin source stream.

See also:

IInputStream::skip

Implements zeus::TAbstractInputStream.

---

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

• FilterInputStream.h
• FilterInputStream.cpp