#include <AbstractInputStream.h>

Inheritance diagram for zeus::TAbstractInputStream:

Public Member Functions
	TAbstractInputStream ()
virtual Retval MQUALIFIER	read (char *pBuffer, Int iBufferSize, Int &rValidSize) const =0
virtual Int MQUALIFIER	readItem () const =0
virtual bool MQUALIFIER	isEndReached () const =0
virtual void MQUALIFIER	close ()=0
virtual void MQUALIFIER	reset ()=0
virtual bool MQUALIFIER	skip (Int iBytes=1)=0
virtual bool MQUALIFIER	available () const
virtual Int8 MQUALIFIER	readInt8 (bool *pError) const
virtual Int16 MQUALIFIER	readInt16 (bool *pError) const
virtual Int32 MQUALIFIER	readInt32 (bool *pError) const
virtual Int64 MQUALIFIER	readInt64 (bool *pError) const
virtual Uint8 MQUALIFIER	readUint8 (bool *pError) const
virtual Uint16 MQUALIFIER	readUint16 (bool *pError) const
virtual Uint32 MQUALIFIER	readUint32 (bool *pError) const
virtual Uint64 MQUALIFIER	readUint64 (bool *pError) const
virtual Float32 MQUALIFIER	readFloat32 (bool *pError) const
virtual Float64 MQUALIFIER	readFloat64 (bool *pError) const
virtual bool MQUALIFIER	readBool (bool *pError) const
virtual Retval MQUALIFIER	readArray (IByteArray &rData) const
virtual Retval MQUALIFIER	readString (IString &rData) const
virtual Retval MQUALIFIER	askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
Protected Member Functions
virtual	~TAbstractInputStream ()
Protected Attributes
bool	m_bOpen
	flag to check if stream is open
bool	m_bAvailable
	flag to check if stream is valid

Detailed Description

This class implements an abstract input stream class

Constructor & Destructor Documentation

TAbstractInputStream::TAbstractInputStream ( )

Creates an abstract input stream

TAbstractInputStream::~TAbstractInputStream ( ) [protected, virtual]

Destroys the abstract stream

Member Function Documentation

virtual void MQUALIFIER zeus::TAbstractInputStream::addRef ( ) const [virtual]

See also:: IZUnknown::addRef

Reimplemented from zeus::TZObject.

virtual Retval MQUALIFIER zeus::TAbstractInputStream::askForInterface	(	const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpIface
	)		`[virtual]`

See also:: IZUnknown::askForInterface

Reimplemented from zeus::TZObject.

bool MQUALIFIER zeus::TAbstractInputStream::available ( ) const [inline, virtual]

See also:: IInputStream::available

Implements zeus::IInputStream.

Reimplemented in zeus::TByteArrayInputStream, and zeus::TFilterInputStream.

virtual void MQUALIFIER zeus::TAbstractInputStream::close ( ) [pure virtual]

Closes the input stream

Implements zeus::IInputStream.

Implemented in zeus::TByteArrayInputStream, zeus::TFileInputStream, and zeus::TFilterInputStream.

virtual bool MQUALIFIER zeus::TAbstractInputStream::isEndReached ( ) const [pure virtual]

This method checks if the stream is at the end. If a stream is at the end the methods readDouble(), readLong(), readByte() and readBool() should not called anymore. They will return zero. You must call this method before getting data from the stream.

Return values:

true	: Stream is at the end
false	: Stream is not at the end

Implements zeus::IInputStream.

Implemented in zeus::TByteArrayInputStream, zeus::TFileInputStream, and zeus::TFilterInputStream.

virtual Retval MQUALIFIER zeus::TAbstractInputStream::read	(	char *	pBuffer,
		Int	iBufferSize,
		Int &	rValidSize
	)		const `[pure virtual]`

Reads from a stream into a buffer

Parameters:

pBuffer	: Char Array
iBufferSize	: Size of the Array
rValidSize	: Length of the read buffer (return parameter)

Return values:

RET_NOERROR	: Reading was successful
RET_REQUEST_FAILED	: Could not read from Socket

Implements zeus::IInputStream.

Implemented in zeus::TCryptedInputStream, zeus::TBase64InputStream, zeus::TByteArrayInputStream, zeus::TFileInputStream, zeus::TFilterInputStream, zeus::TTextInputStream, and zeus::TZippedInputStream.

Retval MQUALIFIER TAbstractInputStream::readArray ( IByteArray & rData ) const [virtual]

See also:: IInputStream::readArray

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

bool MQUALIFIER zeus::TAbstractInputStream::readBool ( bool * pError ) const [inline, virtual]

See also:: IInputStream::readBool

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Float32 MQUALIFIER TAbstractInputStream::readFloat32 ( bool * pError ) const [virtual]

See also:: IInputStream::readFloat32

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Float64 MQUALIFIER TAbstractInputStream::readFloat64 ( bool * pError ) const [virtual]

See also:: IInputStream::readFloat64

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Int16 MQUALIFIER TAbstractInputStream::readInt16 ( bool * pError ) const [virtual]

See also:: IInputStream::readInt16

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Int32 MQUALIFIER TAbstractInputStream::readInt32 ( bool * pError ) const [virtual]

See also:: IInputStream::readInt32

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Int64 MQUALIFIER TAbstractInputStream::readInt64 ( bool * pError ) const [virtual]

See also:: IInputStream::readInt64

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Int8 MQUALIFIER TAbstractInputStream::readInt8 ( bool * pError ) const [virtual]

See also:: IInputStream::readInt16

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

virtual Int MQUALIFIER zeus::TAbstractInputStream::readItem ( ) const [pure virtual]

Reads a single item from a stream. The size of item is 8bit large.

Returns:: item value. If the stream has an error INVALID_DATA is returned.

Implements zeus::IInputStream.

Implemented in zeus::TCryptedInputStream, zeus::TBase64InputStream, zeus::TByteArrayInputStream, zeus::TFileInputStream, zeus::TFilterInputStream, zeus::TTextInputStream, and zeus::TZippedInputStream.

Retval MQUALIFIER TAbstractInputStream::readString ( IString & rData ) const [virtual]

See also:: IInputStream::readString

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Uint16 MQUALIFIER zeus::TAbstractInputStream::readUint16 ( bool * pError ) const [inline, virtual]

See also:: IInputStream::readUint16

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Uint32 MQUALIFIER zeus::TAbstractInputStream::readUint32 ( bool * pError ) const [inline, virtual]

See also:: IInputStream::readUint32

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Uint64 MQUALIFIER zeus::TAbstractInputStream::readUint64 ( bool * pError ) const [inline, virtual]

See also:: IInputStream::readUint64

Implements zeus::IInputStream.

Reimplemented in zeus::TTextInputStream.

Uint8 MQUALIFIER zeus::TAbstractInputStream::readUint8 ( bool * pError ) const [inline, virtual]

See also:: IInputStream::readUint8

Implements zeus::IInputStream.

virtual void MQUALIFIER zeus::TAbstractInputStream::release ( ) const [virtual]

See also:: IZUnknown::release

Reimplemented from zeus::TZObject.

virtual void MQUALIFIER zeus::TAbstractInputStream::reset ( ) [pure virtual]

Sets the stream position back to the beginning

Implements zeus::IInputStream.

Implemented in zeus::TCryptedInputStream, zeus::TByteArrayInputStream, zeus::TFileInputStream, and zeus::TFilterInputStream.

virtual bool MQUALIFIER zeus::TAbstractInputStream::skip ( Int iBytes = 1 ) [pure virtual]

This method is used to skip a number of bytes

Parameters:

iBytes : Number of bytes to skip (default = 1)

Return values:

true	: Byte skipped
false,:	Error or end of stream reached

Implements zeus::IInputStream.

Implemented in zeus::TByteArrayInputStream, zeus::TFileInputStream, and zeus::TFilterInputStream.

Member Data Documentation

bool zeus::TAbstractInputStream::m_bAvailable [protected]

flag to check if stream is valid

bool zeus::TAbstractInputStream::m_bOpen [protected]

flag to check if stream is open

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

zeus::TAbstractInputStream Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation