RWByteInputStreamImp Class Reference

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

#include <rw/stream/RWByteInputStreamImp.h>

Inheritance diagram for RWByteInputStreamImp:

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

Protected Member Functions
	RWByteInputStreamImp ()
Protected Member Functions inherited from RWInputStreamImp
	RWInputStreamImp ()
Protected Member Functions inherited from RWStreamImp
	RWStreamImp ()
Protected Member Functions inherited from RWBodyBase
	RWBodyBase (void)
	RWBodyBase (RWStaticCtor)
	RWBodyBase (const RWBodyBase &second)
virtual	~RWBodyBase (void)
RWBodyBase &	operator= (const RWBodyBase &second)
Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
	RWTCountingBody (unsigned initCount=0)
	RWTCountingBody (RWStaticCtor)
	RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)
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 ()
	RWTMonitor (RWStaticCtor)
	RWTMonitor (const RWTMonitor< RWMutexLock > &second)
	~RWTMonitor ()
void	acquire ()
bool	isAcquired () const
RWTMonitor< RWMutexLock > &	monitor () const
RWMutexLock &	mutex ()
RWTMonitor< RWMutexLock > &	operator= (const RWTMonitor< RWMutexLock > &)
void	release ()
bool	tryAcquire ()

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 binary input stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWByteInputStreamImp::~RWByteInputStreamImp ( )

inlinevirtual

Destructor.

RWByteInputStreamImp::RWByteInputStreamImp ( )

inlineprotected

Constructor.

Member Function Documentation

virtual RWByteInputStream RWByteInputStreamImp::acquire ( )

virtual

Acquires the synchronization mechanism provided by a stream concrete implementation. The acquire() member function returns a handle to the binary stream that should be used for input operation after acquiring the synchronization mechanism.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

virtual RWByte RWByteInputStreamImp::read ( )

pure virtual

Reads a single byte from the stream.

Implemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWByteFromStreambufInputStreamImp, and RWFilteredByteInputStreamImp.

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

pure virtual

Reads an array of bytes from the stream. The array must be pre-allocated to contain at least of numBytes elements. The function returns the actual number of bytes read from the stream.

Parameters

byteArray	A pointer to the first element of the array.
numBytes	The number of bytes to be read from the stream.

Implemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWByteFromStreambufInputStreamImp, and RWFilteredByteInputStreamImp.

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

pure virtual

Reads bytes from the 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 bytes extracted from the stream.
maxSize	The maximum number of bytes to be read.
delim	The byte value used as a delimiter.

Implemented in RWByteFromStreambufInputStreamImp, RWFilteredByteInputStreamImp, and RWSynchronizedByteInputStreamImp.

virtual void RWByteInputStreamImp::release ( )

inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.