FilterStream Class Reference

#include <filterStream.h>

Inheritance diagram for FilterStream:

Public Member Functions
virtual	~FilterStream ()
virtual bool	attachStream (Stream *io_pSlaveStream)=0
virtual void	detachStream ()=0
virtual Stream *	getStream ()=0
bool	hasCapability (const Capability) const
	Checks to see if this stream has the capability of a given function.
U32	getPosition () const
	Gets the position in the stream.
bool	setPosition (const U32 in_newPosition)
	Sets the position of the stream. Returns if the new position is valid or not.
U32	getStreamSize ()
	Gets the size of the stream.
Public Member Functions inherited from Stream
	Stream ()
virtual	~Stream ()
Stream::Status	getStatus () const
	Gets the status of the stream.
void	readLine (U8 *buffer, U32 bufferSize)
void	writeLine (U8 *buffer)
	writes a line to the stream
const char *	readSTString (bool casesens=false)
virtual void	readString (char stringBuf[256])
	Reads a string of maximum 255 characters long.
void	readLongString (U32 maxStringLen, char *stringBuf)
void	writeLongString (U32 maxStringLen, const char *string)
bool	Put (char character)
virtual void	writeString (const char *stringBuf, S32 maxLen=255)
	Writes a string to the stream.
bool	writeFormattedBuffer (const char *format,...)
bool	writeStringBuffer (const char *buffer)
	Writes a NULL terminated string buffer.
bool	write (const ColorI &)
	Write an integral color to the stream.
bool	write (const ColorF &)
	Write a floating point color to the stream.
bool	read (ColorI *)
	Read an integral color from the stream.
bool	read (ColorF *)
	Read a floating point color from the stream.
bool	write (const NetAddress &)
	Write a network address to the stream.
bool	read (NetAddress *)
	Read a network address from the stream.
bool	write (const NetSocket &)
	Write a network socket to the stream.
bool	read (NetSocket *)
	Read a network socket from the stream.
bool	read (const U32 in_numBytes, void *out_pBuffer)
bool	write (const U32 in_numBytes, const void *in_pBuffer)
bool	read (bool *out_pRead)
bool	write (const bool &in_rWrite)
bool	copyFrom (Stream *other)
	Copy the contents of another stream into this one.
void	writeTabs (U32 count)
	Write a number of tabs to this stream.

Protected Member Functions
bool	_read (const U32 in_numBytes, void *out_pBuffer)
bool	_write (const U32 in_numBytes, const void *in_pBuffer)
Protected Member Functions inherited from Stream
void	setStatus (const Status in_newStatus)

Additional Inherited Members
Public Types inherited from Stream
enum	Status {   Ok = 0 , IOError , EOS , IllegalCall ,   Closed , UnknownError }
	Status constantants for the stream. More...
enum	Capability { StreamWrite = BIT(0) , StreamRead = BIT(1) , StreamPosition = BIT(2) }
Static Public Member Functions inherited from Stream
static const char *	getStatusString (const Status in_status)
	Gets a printable string form of the status.

Constructor & Destructor Documentation

~FilterStream()

~FilterStream ( )

virtual

Member Function Documentation

_read()

bool _read ( const U32 in_numBytes, void * out_pBuffer )

protectedvirtual

Implements Stream.

Reimplemented in ResizeFilterStream, ZipStatFilter, ZipCryptRStream, ZipSubRStream, and ZipSubWStream.

_write()

bool _write ( const U32 in_numBytes, const void * in_pBuffer )

protectedvirtual

Implements Stream.

Reimplemented in ZipStatFilter, and ZipSubWStream.

attachStream()

virtual bool attachStream ( Stream * io_pSlaveStream )

pure virtual

Implemented in ResizeFilterStream, ZipStatFilter, ZipCryptRStream, ZipSubRStream, and ZipSubWStream.

detachStream()

virtual void detachStream ( )

pure virtual

Implemented in ResizeFilterStream, ZipStatFilter, ZipCryptRStream, ZipSubRStream, and ZipSubWStream.

getPosition()

U32 getPosition ( ) const

virtual

Gets the position in the stream.

Implements Stream.

Reimplemented in ResizeFilterStream, ZipCryptRStream, ZipSubRStream, and ZipSubWStream.

getStream()

virtual Stream * getStream ( )

pure virtual

Implemented in ResizeFilterStream, ZipStatFilter, ZipCryptRStream, ZipSubRStream, and ZipSubWStream.

getStreamSize()

U32 getStreamSize ( )

virtual

Gets the size of the stream.

Implements Stream.

Reimplemented in ResizeFilterStream, ZipSubRStream, and ZipSubWStream.

hasCapability()

bool hasCapability ( const Capability ) const

virtual

Checks to see if this stream has the capability of a given function.

Implements Stream.

Reimplemented in ZipSubRStream, and ZipSubWStream.

setPosition()

bool setPosition ( const U32 in_newPosition )

virtual

Sets the position of the stream. Returns if the new position is valid or not.

Implements Stream.

Reimplemented in ResizeFilterStream, ZipCryptRStream, ZipSubRStream, and ZipSubWStream.

---

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

• io/filterStream.h
• io/filterStream.cc