Stream Class Reference

Base stream class for streaming data across a specific media. More...

#include <stream.h>

Inheritance diagram for Stream:

Public Types
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) }

Public Member Functions
	Stream ()
virtual	~Stream ()
Stream::Status	getStatus () const
	Gets the status of the stream.
virtual bool	hasCapability (const Capability) const =0
	Checks to see if this stream has the capability of a given function.
virtual U32	getPosition () const =0
	Gets the position in the stream.
virtual bool	setPosition (const U32 in_newPosition)=0
	Sets the position of the stream. Returns if the new position is valid or not.
virtual U32	getStreamSize ()=0
	Gets the size 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.

Static Public Member Functions
static const char *	getStatusString (const Status in_status)
	Gets a printable string form of the status.

Protected Member Functions
void	setStatus (const Status in_newStatus)
virtual bool	_read (const U32 in_numBytes, void *out_pBuffer)=0
virtual bool	_write (const U32 in_numBytes, const void *in_pBuffer)=0

Detailed Description

Base stream class for streaming data across a specific media.

Member Enumeration Documentation

Capability

enum Capability

Enumerator
StreamWrite	Can this stream write?
StreamRead	Can this stream read?
StreamPosition	Can this stream position?

Status

enum Status

Status constantants for the stream.

Enumerator
Ok	Ok!
IOError	Read or Write error.
EOS	End of Stream reached (mostly for reads)
IllegalCall	An unsupported operation used. Always w/ accompanied by AssertWarn.
Closed	Tried to operate on a closed stream (or detached filter)
UnknownError	Catchall.

Constructor & Destructor Documentation

Stream()

Stream

(

)

~Stream()

~Stream ( )

virtual

Member Function Documentation

_read()

virtual bool _read ( const U32  in_numBytes, void *  out_pBuffer  )

protectedpure virtual

Implemented in BufferStream, FileStream, FilterStream, MemStream, ResizeFilterStream, ZipCryptRStream, ZipSubRStream, ZipSubWStream, ZipStatFilter, and BitStream.

_write()

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

protectedpure virtual

Implemented in BufferStream, FileStream, FilterStream, MemStream, ZipSubWStream, ZipStatFilter, and BitStream.

copyFrom()

bool copyFrom

(

Stream *

other

)

Copy the contents of another stream into this one.

getPosition()

virtual U32 getPosition ( ) const

pure virtual

Gets the position in the stream.

Implemented in BitStream, BufferStream, FileStream, FilterStream, MemStream, ResizeFilterStream, ZipCryptRStream, ZipSubRStream, and ZipSubWStream.

getStatus()

Stream::Status getStatus ( ) const

inline

Gets the status of the stream.

getStatusString()

const char * getStatusString ( const Status  in_status )

static

Gets a printable string form of the status.

getStreamSize()

virtual U32 getStreamSize ( )

pure virtual

Gets the size of the stream.

Implemented in BitStream, BufferStream, FileStream, FilterStream, MemStream, ResizeFilterStream, ZipSubRStream, and ZipSubWStream.

hasCapability()

virtual bool hasCapability ( const Capability  ) const

pure virtual

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

Implemented in BufferStream, FileStream, BitStream, FilterStream, MemStream, ZipSubRStream, and ZipSubWStream.

Put()

bool Put ( char  character )

inline

read() [1/6]

bool read ( bool *  out_pRead )

inline

read() [2/6]

bool read

(

ColorF *

pColor

)

Read a floating point color from the stream.

read() [3/6]

bool read

(

ColorI *

pColor

)

Read an integral color from the stream.

read() [4/6]

bool read ( const U32  in_numBytes, void *  out_pBuffer  )

inline

read() [5/6]

bool read

(

NetAddress *

na

)

Read a network address from the stream.

read() [6/6]

bool read

(

NetSocket *

so

)

Read a network socket from the stream.

readLine()

void readLine	(	U8 *	buffer,
		U32	bufferSize
	)

Reads a line from the stream.

Parameters

buffer	buffer to be read into
bufferSize	max size of the buffer. Will not read more than the "bufferSize"

readLongString()

void readLongString	(	U32	maxStringLen,
		char *	stringBuf
	)

Reads a string that could potentially be more than 255 characters long.

Parameters

maxStringLen	Maximum length to read. If the string is longer than maxStringLen, only maxStringLen bytes will be read.
stringBuf	buffer where data is read into

readString()

void readString ( char  stringBuf[256] )

virtual

Reads a string of maximum 255 characters long.

Reimplemented in BitStream.

readSTString()

const char * readSTString

(

bool

casesens = false

)

Reads a string and inserts it into the StringTable

See also

StringTable

setPosition()

virtual bool setPosition ( const U32  in_newPosition )

pure virtual

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

Implemented in BufferStream, FileStream, ZipTempStream, BitStream, FilterStream, MemStream, ResizeFilterStream, ZipCryptRStream, ZipSubRStream, and ZipSubWStream.

setStatus()

void setStatus ( const Status  in_newStatus )

inlineprotected

write() [1/6]

bool write ( const bool &  in_rWrite )

inline

write() [2/6]

bool write

(

const ColorF &

rColor

)

Write a floating point color to the stream.

write() [3/6]

bool write

(

const ColorI &

rColor

)

Write an integral color to the stream.

write() [4/6]

bool write

(

const NetAddress &

na

)

Write a network address to the stream.

write() [5/6]

bool write

(

const NetSocket &

so

)

Write a network socket to the stream.

write() [6/6]

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

inline

writeFormattedBuffer()

bool writeFormattedBuffer	(	const char *	format,
			...
	)

Writes a formatted buffer to the stream. NOTE: A maximum string length of 4K is allowed.

writeLine()

void writeLine

(

U8 *

buffer

)

writes a line to the stream

writeLongString()

void writeLongString	(	U32	maxStringLen,
		const char *	string
	)

Writes a string to the stream. This function is slightly unstable. Only use this if you have a valid string that is not empty. writeString is safer.

writeString()

void writeString ( const char *  stringBuf, S32  maxLen = 255  )

virtual

Writes a string to the stream.

Reimplemented in BitStream.

writeStringBuffer()

bool writeStringBuffer ( const char *  buffer )

inline

Writes a NULL terminated string buffer.

writeTabs()

void writeTabs ( U32  count )

inline

Write a number of tabs to this stream.

---

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

• io/stream.h
• io/nStream.cc