RWFilteredByteInputStreamImp Class Reference

Abstract base class for all the filtered binary input stream implementation classes. More...

#include <rw/stream/RWFilteredByteInputStreamImp.h>

Inheritance diagram for RWFilteredByteInputStreamImp:

Public Member Functions
virtual	~RWFilteredByteInputStreamImp ()
virtual RWSize	available () const
virtual void	close ()
virtual bool	isBad () const
virtual bool	isEof () const
virtual bool	isFail () const
virtual bool	isGood () const
virtual RWByte	read ()
virtual RWSize	read (RWByte *byteArray, RWSize numBytes)
virtual RWSize	readUntil (RWByte *byteArray, RWSize maxSize, RWByte delim)
virtual RWSize	skip (RWSize numUnits)
Public Member Functions inherited from RWByteInputStreamImp
virtual	~RWByteInputStreamImp ()
virtual RWByteInputStream	acquire ()
virtual void	release ()
Public Member Functions inherited from RWInputStreamImp
virtual	~RWInputStreamImp ()
Public Member Functions inherited from RWStreamImp
virtual	~RWStreamImp ()

Protected Member Functions
	RWFilteredByteInputStreamImp (const RWByteInputStream &sourceStream)
RWByteInputStream &	getSourceStream ()
const RWByteInputStream &	getSourceStream () const
Protected Member Functions inherited from RWByteInputStreamImp
	RWByteInputStreamImp ()
Protected Member Functions inherited from RWInputStreamImp
	RWInputStreamImp ()
Protected Member Functions inherited from RWStreamImp
	RWStreamImp ()
Protected Member Functions inherited from RWBodyBase
	RWBodyBase (const RWBodyBase &second)
	RWBodyBase (RWStaticCtor)
	RWBodyBase (void)
virtual	~RWBodyBase (void)
RWBodyBase &	operator= (const RWBodyBase &second)
Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
	RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)
	RWTCountingBody (RWStaticCtor)
	RWTCountingBody (unsigned initCount=0)
RWTCountingBody< RWMutexLock > &	operator= (const RWTCountingBody< RWMutexLock > &second)
	~RWTCountingBody (void)
unsigned	addReference (void)
unsigned	references (void) const
unsigned	removeReference (void)
Protected Member Functions inherited from RWTMonitor< RWMutexLock >
	RWTMonitor (const RWTMonitor< RWMutexLock > &second)
	RWTMonitor (RWStaticCtor)
	RWTMonitor (void)
	~RWTMonitor (void)
void	acquire (void)
bool	isAcquired (void) const
RWTMonitor< RWMutexLock > &	monitor (void) const
RWMutexLock &	mutex (void)
RWTMonitor< RWMutexLock > &	operator= (const RWTMonitor< RWMutexLock > &)
void	release (void)
bool	tryAcquire (void)

Additional Inherited Members
Protected Types inherited from RWTCountingBody< RWMutexLock >
typedef RWTLockGuard< RWTMonitor< RWMutexLock > >	LockGuard
typedef RWTTryLockGuard< RWTMonitor< RWMutexLock > >	TryLockGuard
typedef RWTUnlockGuard< RWTMonitor< RWMutexLock > >	UnlockGuard
Protected Types inherited from RWTMonitor< RWMutexLock >
typedef RWTLockGuard< RWTMonitor< RWMutexLock > >	LockGuard
typedef RWTTryLockGuard< RWTMonitor< RWMutexLock > >	TryLockGuard
typedef RWTUnlockGuard< RWTMonitor< RWMutexLock > >	UnlockGuard

Detailed Description

Abstract base class for all the filtered binary input stream implementation classes. A filtered input stream is a stream that uses its attached input stream as the source of elements to its own functions. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

~RWFilteredByteInputStreamImp()

virtual RWFilteredByteInputStreamImp::~RWFilteredByteInputStreamImp ( )

virtual

Destructor. Throws no exceptions.

RWFilteredByteInputStreamImp()

RWFilteredByteInputStreamImp::RWFilteredByteInputStreamImp ( const RWByteInputStream & sourceStream )

inlineprotected

Used by derived classes to initialize the attached source stream. Throws no exceptions.

Parameters

sourceStream

A handle to the attached source stream.

Member Function Documentation

available()

virtual RWSize RWFilteredByteInputStreamImp::available ( ) const

virtual

Returns the number of bytes that can be read from the attached source stream without blocking. Throws no exceptions.

Implements RWInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

close()

virtual void RWFilteredByteInputStreamImp::close ( )

virtual

Forwards the close() request to the attached source stream.

Implements RWStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

getSourceStream() [1/2]

RWByteInputStream & RWFilteredByteInputStreamImp::getSourceStream ( )

inlineprotected

Returns a handle to the attached source stream. Throws no exceptions.

getSourceStream() [2/2]

const RWByteInputStream & RWFilteredByteInputStreamImp::getSourceStream ( ) const

inlineprotected

Returns a handle to the attached source stream. Throws no exceptions.

isBad()

virtual bool RWFilteredByteInputStreamImp::isBad ( ) const

virtual

Forwards the isBad() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

isEof()

virtual bool RWFilteredByteInputStreamImp::isEof ( ) const

virtual

Forwards the isEof() request to the attached source stream. Throws no exceptions.

Implements RWInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

isFail()

virtual bool RWFilteredByteInputStreamImp::isFail ( ) const

virtual

Forwards the isFail() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

isGood()

virtual bool RWFilteredByteInputStreamImp::isGood ( ) const

virtual

Forwards the isGood() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

read() [1/2]

virtual RWByte RWFilteredByteInputStreamImp::read ( )

virtual

Forwards the reading of a single byte to the attached source stream.

Implements RWByteInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

read() [2/2]

virtual RWSize RWFilteredByteInputStreamImp::read ( RWByte * byteArray, RWSize numBytes )

virtual

Forwards the reading of an array of bytes from the attached source stream. The function returns the actual number of bytes read.

Parameters

byteArray	A pointer to the first element of the array. The array must have been pre-allocated to contain at least numBytes elements.
numBytes	The number of byte(s) to be read from the stream.

Implements RWByteInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

readUntil()

virtual RWSize RWFilteredByteInputStreamImp::readUntil ( RWByte * byteArray, RWSize maxSize, RWByte delim )

virtual

Reads bytes from the attached source stream until the last byte read is equal to delim, or maxSize bytes have been read, or the end of the input sequence is reached. The bytes read are stored in byteArray. The function returns the actual number of bytes read from the stream.

Parameters

byteArray	A pointer to the array receiving the byte(s) extracted from the stream.
maxSize	The maximum number of byte(s) to be read.
delim	The byte value used as a delimiter.

Implements RWByteInputStreamImp.

Reimplemented in RWSynchronizedByteInputStreamImp.

skip()

virtual RWSize RWFilteredByteInputStreamImp::skip ( RWSize numUnits )

virtual

Skips numUnits bytes from the input sequence of the attached source stream if possible. The function returns the actual number of bytes skipped, which can be any value between 0 and numUnits.

Parameters

numUnits

The number of byte(s) to be skipped.

Implements RWInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.