utl::BufferedStream Class Reference

Buffered stream. More...

#include <BufferedStream.h>

Inheritance diagram for utl::BufferedStream:

List of all members.

Public Member Functions
virtual void	copy (const Object &rhs)
	Copy another instance.
virtual void	close ()
	Close the stream.
const Stream *	getStream () const
	Get the stream.
Stream *	getStream ()
	Get the stream.
void	setStream (Stream *stream, bool streamOwner=true)
	Set the stream.
Stream *	takeStream ()
	Steal the stream.
bool	eofBlocking ()
	Determine whether an EOF condition exists.
void	setMode (uint_t mode, bool p_setBufs=true)
	Set the mode.
Stream Status Overrides
virtual bool	isInput () const
	Determine whether the stream is an input stream.
virtual void	setInput (bool input)
	Set the input mode flag.
virtual bool	isOutput () const
	Determine whether the stream is an output stream.
virtual void	setOutput (bool output)
	Set the output mode flag.
virtual bool	eof () const
	Determine whether an EOF condition exists.
virtual void	setEOF (bool eof)
	Set the EOF flag.
virtual bool	error () const
	Determine whether an error condition exists.
virtual void	setError (bool error)
	Set the error flag.
Buffering
bool	hasInput () const
	Has unread input?
virtual BufferedStream &	flush (uint_t mode=io_wr)
	Flush the stream (if it is buffered).
bool	isLineBuffered () const
	Determine whether the stream is line-buffered.
void	setLineBuffered (bool lineBuffered)
	Set the line-buffered flag.
void	setMinRead (size_t minRead)
	Set the min-read parameter.
void	setBufs (size_t size=K(4))
	Set the buffers for input and/or output.
void	setInputBuf (size_t size=K(4), size_t minRead=1)
	Set the input buffer size.
void	setOutputBuf (size_t size=K(4))
	Set the output buffer size.
I/O Operators
BufferedStream &	operator<< (bsmanip0 manip)
BufferedStream &	operator<< (void *ptr)
	Write a void pointer.
BufferedStream &	operator<< (const char *str)
	Write a string.
BufferedStream &	operator<< (char c)
BufferedStream &	operator>> (char &c)
BufferedStream &	operator<< (byte_t b)
BufferedStream &	operator>> (byte_t &b)
BufferedStream &	operator<< (short n)
BufferedStream &	operator>> (short &n)
BufferedStream &	operator<< (ushort_t n)
BufferedStream &	operator>> (ushort_t &n)
BufferedStream &	operator<< (int n)
BufferedStream &	operator>> (int &n)
BufferedStream &	operator<< (uint_t n)
BufferedStream &	operator>> (uint_t &n)
BufferedStream &	operator<< (long n)
BufferedStream &	operator>> (long &n)
BufferedStream &	operator<< (ulong_t n)
BufferedStream &	operator>> (ulong_t &n)
BufferedStream &	operator<< (double n)
BufferedStream &	operator>> (double &n)
Public Member Functions inherited from utl::Stream
bool	isOwner () const
	Get the owner flag.
void	setOwner (bool owner)
	Set the owner flag.
size_t	getInputCount () const
	Get the count of input bytes.
size_t	getOutputCount () const
	Get the count of output bytes.
uint_t	getMode () const
	Get the current mode.
const String &	getName () const
	Get the stream's name.
const String *	getNamePtr () const
	Get the stream's name.
void	setName (const String &name)
	Set the name.
void	setName (String *name)
	Set the name.
virtual bool	isBOL () const
	Get the begin-of-line flag.
virtual void	setBOL (bool p_bol)
	Set the BOL flag.
bool	isRDWR () const
	Determine whether the stream is an input/output stream.
void	setBase (uint_t base)
	Set the base, for writing integer values.
void	setMode (uint_t mode)
	Set the mode.
Stream &	put (const char *str)
	Write the given string.
Stream &	putBit (bool b)
	Write the given bit.
Stream &	putBits ()
	Write all outstanding bits.
Stream &	putBits (uint32_t n, uint_t numBits)
	Write multiple bits.
Stream &	putLine (const char *str)
	Write the given string, followed by a newline.
Stream &	operator<< (smanip0 manip)
	Execute a manipulator (e.g.
Stream &	operator<< (int16_t n)
Stream &	operator>> (int16_t &n)
Stream &	operator<< (int32_t n)
Stream &	operator>> (int32_t &n)
uint_t	getIndent () const
	Get the indentation level.
void	setIndent (uint_t indent)
	Set the indentation level.
void	indent (uint_t num=4)
	Increase indentation by the given number of spaces.
void	unindent (uint_t num=4)
	Decrease indentation by the given number of spaces.
void	checkOK () const
	If there is an error condition (error()), throw StreamErrorEx.
void	clearEOF ()
	Clear the EOF condition.
void	clearError ()
	Clear the error condition.
bool	ok () const
	Determine whether an error condition exists.
size_t	copyData (Stream &in, size_t numBytes=size_t_max, size_t bufSize=K(4))
	Copy data from another stream.
bool	getBit ()
	Get a single bit.
uint32_t	getBits (uint_t numBits)
	Get multiple bits.
Public Member Functions inherited from utl::Object
virtual int	compare (const Object &rhs) const
	Compare with another object.
virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance.
virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance.
virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream.
void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name.
virtual const Object &	getKey () const
	Get the key for this object.
bool	hasKey () const
	Determine whether or not the object has a key.
virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none).
virtual size_t	hash (size_t size) const
	Get the hash code for the object.
bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class.
virtual String	toString () const
	Return a string representation of self.
	operator String () const
	Conversion to String.
size_t	allocatedSize () const
	Get the total allocated size of this object.
virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size.
virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator.
virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed.
bool	operator< (const Object &rhs) const
	Less-than operator.
bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator.
bool	operator> (const Object &rhs) const
	Greater-than operator.
bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator.
bool	operator== (const Object &rhs) const
	Equal-to operator.
bool	operator!= (const Object &rhs) const
	Unequal-to operator.
void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream.
void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream.
virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream.
void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream.

Protected Member Functions
virtual void	clear ()
	Revert to initial state.
Protected Member Functions inherited from utl::Stream
void	indentIfBOL ()
	If begin-of-line flag is true, indent and clear the flag.
void	throwStreamEOFex () const
	Throw a StreamEOFex exception.
void	throwStreamErrorEx () const
	Throw a StreamErrorEx exception.
void	readToken (char *buf, size_t size)
	Read a token from the stream.
void	readUntilWS (char *buf, size_t size)
	Read until a whitespace character is encountered.
byte_t	skipWS ()
	Skip past whitespace.

Input
void	get (byte_t &b)
	Get a single byte.
void	get (char &c)
	Get a single char.
byte_t	get ()
	Get a single byte.
byte_t	peek ()
	Peek at the next byte to be read from the stream.
virtual Stream &	readLine (String &str)
	Read a line from stream into the given String object.
virtual size_t	read (byte_t *array, size_t maxBytes, size_t minBytes=uint_t_max)
	Read data into a given buffer.
void	unget (byte_t b)
	Un-get a byte.
void	unget (char c)
	Unget a char.
virtual void	underflow ()
	Periodically (when the input buffer is empty and data is to be read), it's necessary to re-fill the input buffer with data read from the stream.

Output
virtual BufferedStream &	newline ()
	Write a newline.
BufferedStream &	newline (bool forceFlush)
	Write a newline.
BufferedStream &	put (byte_t b)
	Write the given byte.
BufferedStream &	put (char c)
	Write the given character.
BufferedStream &	put (int c)
	Write the given character.
virtual void	write (const byte_t *array, size_t num)
	Write a sequence of bytes.
virtual void	overflow ()
	Periodically (when the output buffer is full), it's necessary to write its contents to the stream.

---

Detailed Description

Buffered stream.

BufferedStream provides input and/or output buffering for a stream.

Attributes

• lineBuffered flag : For a line-buffered stream, the endl manipulator will flush the stream's output.

Author:

Adam McKee

Definition at line 37 of file BufferedStream.h.

---

Member Function Documentation

virtual void utl::BufferedStream::copy ( const Object &  rhs )

virtual

Copy another instance.

When you override copy(), you should usually call the superclass's copy().

Parameters:

rhs	object to copy

Reimplemented from utl::Stream.

virtual void utl::BufferedStream::close ( )

virtual

Close the stream.

Implements utl::Stream.

Reimplemented in utl::Encoder, and utl::SyslogStream.

virtual bool utl::BufferedStream::isInput ( ) const

virtual

Determine whether the stream is an input stream.

Reimplemented from utl::Stream.

virtual void utl::BufferedStream::setInput ( bool  input )

virtual

Set the input mode flag.

Reimplemented from utl::Stream.

virtual bool utl::BufferedStream::isOutput ( ) const

virtual

Determine whether the stream is an output stream.

Reimplemented from utl::Stream.

virtual void utl::BufferedStream::setOutput ( bool  output )

virtual

Set the output mode flag.

Reimplemented from utl::Stream.

virtual bool utl::BufferedStream::eof ( ) const

virtual

Determine whether an EOF condition exists.

Reimplemented from utl::Stream.

virtual void utl::BufferedStream::setEOF ( bool  p_eof )

virtual

Set the EOF flag.

Reimplemented from utl::Stream.

virtual bool utl::BufferedStream::error ( ) const

virtual

Determine whether an error condition exists.

Reimplemented from utl::Stream.

virtual void utl::BufferedStream::setError ( bool  p_error )

virtual

Set the error flag.

Reimplemented from utl::Stream.

const Stream* utl::BufferedStream::getStream ( ) const

inline

Get the stream.

Definition at line 68 of file BufferedStream.h.

Stream* utl::BufferedStream::getStream ( )

inline

Get the stream.

Definition at line 71 of file BufferedStream.h.

void utl::BufferedStream::setStream	(	Stream *	stream,
		bool	streamOwner = true
	)

Set the stream.

Stream* utl::BufferedStream::takeStream

(

)

Steal the stream.

bool utl::BufferedStream::eofBlocking

(

)

Determine whether an EOF condition exists.

If an EOF condition doesn't exist, attempt to read data from the stream. If no data can be read into the buffer, return true, otherwise return false.

void utl::BufferedStream::setMode ( uint_t  mode, bool  p_setBufs = true  )

inline

Set the mode.

Parameters:

mode	I/O mode (see io_t)
p_setBufs	(optional : true) set default buffer sizes?

Definition at line 92 of file BufferedStream.h.

References utl::io_rd, and utl::io_wr.

void utl::BufferedStream::get ( byte_t &  b )

inline

Get a single byte.

Parameters:

b	byte reference

Reimplemented from utl::Stream.

Definition at line 101 of file BufferedStream.h.

References ASSERTD.

void utl::BufferedStream::get ( char &  c )

inline

Get a single char.

Parameters:

c	char reference

Reimplemented from utl::Stream.

Definition at line 109 of file BufferedStream.h.

byte_t utl::BufferedStream::get ( )

inline

Get a single byte.

Returns:

byte

Reimplemented from utl::Stream.

Definition at line 112 of file BufferedStream.h.

byte_t utl::BufferedStream::peek

(

)

Peek at the next byte to be read from the stream.

virtual Stream& utl::BufferedStream::readLine ( String &  str )

virtual

Read a line from stream into the given String object.

Reimplemented from utl::Stream.

virtual size_t utl::BufferedStream::read ( byte_t *  array, size_t  maxBytes, size_t  minBytes = uint_t_max  )

virtual

Read data into a given buffer.

Returns:

number of bytes read

Parameters:

array	buffer to read into
maxBytes	maximum number of bytes to read
minBytes	(optional : maxBytes) minimum number of bytes to read

Implements utl::Stream.

void utl::BufferedStream::unget ( byte_t  b )

inline

Un-get a byte.

You may not un-get more than one byte in a row.

Definition at line 130 of file BufferedStream.h.

References ASSERTD.

void utl::BufferedStream::unget ( char  c )

inline

Unget a char.

You may not un-get more than one char in a row.

Definition at line 134 of file BufferedStream.h.

References unget().

Referenced by unget().

virtual BufferedStream& utl::BufferedStream::newline ( )

inlinevirtual

Write a newline.

Reimplemented from utl::Stream.

Definition at line 141 of file BufferedStream.h.

References newline().

Referenced by utl::endl(), utl::endlf(), and newline().

BufferedStream& utl::BufferedStream::newline ( bool  forceFlush )

inline

Write a newline.

Definition at line 145 of file BufferedStream.h.

References utl::flush().

BufferedStream& utl::BufferedStream::put ( byte_t  b )

inline

Write the given byte.

Reimplemented from utl::Stream.

Definition at line 153 of file BufferedStream.h.

References ASSERTD.

BufferedStream& utl::BufferedStream::put ( char  c )

inline

Write the given character.

Reimplemented from utl::Stream.

Definition at line 163 of file BufferedStream.h.

BufferedStream& utl::BufferedStream::put ( int  c )

inline

Write the given character.

Reimplemented from utl::Stream.

Definition at line 170 of file BufferedStream.h.

References put().

Referenced by put().

virtual void utl::BufferedStream::write ( const byte_t *  array, size_t  num  )

virtual

Write a sequence of bytes.

Parameters:

array	data to write
num	number of bytes to write

Implements utl::Stream.

virtual BufferedStream& utl::BufferedStream::flush ( uint_t  mode = io_wr )

virtual

Flush the stream (if it is buffered).

Parameters:

mode

see io_t

Reimplemented from utl::Stream.

Referenced by utl::flush().

bool utl::BufferedStream::isLineBuffered ( ) const

inline

Determine whether the stream is line-buffered.

Definition at line 185 of file BufferedStream.h.

References utl::io_lineBuffered.

void utl::BufferedStream::setLineBuffered ( bool  lineBuffered )

inline

Set the line-buffered flag.

Definition at line 189 of file BufferedStream.h.

References utl::io_lineBuffered.

void utl::BufferedStream::setMinRead ( size_t  minRead )

inline

Set the min-read parameter.

Definition at line 193 of file BufferedStream.h.

void utl::BufferedStream::setBufs

(

size_t

size = K(4)

)

Set the buffers for input and/or output.

Parameters:

size	(optional : 4 kb) buffer size

void utl::BufferedStream::setInputBuf	(	size_t	size = K(4),
		size_t	minRead = 1
	)

Set the input buffer size.

Parameters:

size	(optional : 4 kb) buffer size
minRead	(optional : 1) minimum read length

void utl::BufferedStream::setOutputBuf

(

size_t

size = K(4)

)

Set the output buffer size.

Parameters:

size	(optional : 4 kb) buffer size

BufferedStream& utl::BufferedStream::operator<< ( void *  ptr )

inline

Write a void pointer.

Reimplemented from utl::Stream.

Definition at line 219 of file BufferedStream.h.

BufferedStream& utl::BufferedStream::operator<< ( const char *  str )

inline

Write a string.

Reimplemented from utl::Stream.

Definition at line 220 of file BufferedStream.h.

virtual void utl::BufferedStream::clear ( )

protectedvirtual

Revert to initial state.

Reimplemented from utl::Stream.

Reimplemented in utl::ArithmeticEncoder, utl::BWTencoder, utl::Encoder, utl::LZencoder, utl::HuffmanEncoder, utl::RLencoder, utl::SyslogStream, and utl::Translator.

virtual void utl::BufferedStream::underflow ( )

protectedvirtual

Periodically (when the input buffer is empty and data is to be read), it's necessary to re-fill the input buffer with data read from the stream.

Upon return, _iBufPos = 0, _iBufLim = number of bytes in the input buffer.

Reimplemented in utl::Encoder, and utl::SyslogStream.

virtual void utl::BufferedStream::overflow ( )

protectedvirtual

Periodically (when the output buffer is full), it's necessary to write its contents to the stream.

Upon return, _oBufPos = 0.

Reimplemented in utl::Encoder, and utl::SyslogStream.

---

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

• BufferedStream.h