RWWCharInputStreamImp Class Reference

Abstract base class for all the wide character input stream implementation classes. More...

#include <rw/stream/RWWCharInputStreamImp.h>

Inheritance diagram for RWWCharInputStreamImp:

Public Member Functions
virtual	~RWWCharInputStreamImp ()
virtual RWWCharInputStream	acquire ()
virtual wchar_t	read ()=0
virtual RWSize	read (wchar_t *wcharArray, RWSize numWChars)=0
virtual RWSize	readUntil (wchar_t *wcharArray, RWSize maxSize, wchar_t 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
	RWWCharInputStreamImp ()
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 wide character input stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

~RWWCharInputStreamImp()

virtual RWWCharInputStreamImp::~RWWCharInputStreamImp ( )

inlinevirtual

Destructor.

RWWCharInputStreamImp()

RWWCharInputStreamImp::RWWCharInputStreamImp ( )

inlineprotected

Constructor.

Member Function Documentation

acquire()

virtual RWWCharInputStream RWWCharInputStreamImp::acquire ( )

virtual

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

Reimplemented in RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >.

read() [1/2]

virtual wchar_t RWWCharInputStreamImp::read ( )

pure virtual

Reads a single wide character from the stream.

Implemented in RWFilteredWCharInputStreamImp, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, and RWWCharFromWStreambufInputStreamImp.

read() [2/2]

virtual RWSize RWWCharInputStreamImp::read ( wchar_t * wcharArray, RWSize numWChars )

pure virtual

Reads an array of wide characters from the stream. The array must be pre-allocated to contain at list numWChars elements. The function returns the actual number of wide characters read from the stream.

Parameters

wcharArray	A pointer to the first element of the array.
numWChars	The number of wide characters to be read from the stream.

Implemented in RWFilteredWCharInputStreamImp, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, and RWWCharFromWStreambufInputStreamImp.

readUntil()

virtual RWSize RWWCharInputStreamImp::readUntil ( wchar_t * wcharArray, RWSize maxSize, wchar_t delim )

pure virtual

Reads wide characters from the stream until the last wide character read is equal to delim, or maxSize wide characters have been read, or the end of the input sequence is reached. The wide characters read are stored in wcharArray. The function returns the actual number of wide characters read from the stream.

Parameters

wcharArray	A pointer to the array receiving the wide characters extracted from the stream.
maxSize	The maximum number of wide characters to be read.
delim	The wide character used as a delimiter.

Implemented in RWFilteredWCharInputStreamImp, RWSynchronizedWCharInputStreamImp, and RWWCharFromWStreambufInputStreamImp.

release()

virtual void RWWCharInputStreamImp::release ( void )

inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

Reimplemented in RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >.