RWCharInputStreamImp Class Reference

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

#include <rw/stream/RWCharInputStreamImp.h>

Inheritance diagram for RWCharInputStreamImp:

Public Member Functions
virtual	~RWCharInputStreamImp ()
virtual RWCharInputStream	acquire ()
virtual char	read ()=0
virtual RWSize	read (char *charArray, RWSize numChars)=0
virtual void	readStringUntil (RWCString &string, char delim)=0
virtual RWSize	readUntil (char *charArray, RWSize maxSize, char 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
	RWCharInputStreamImp ()
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 narrow character input stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

~RWCharInputStreamImp()

virtual RWCharInputStreamImp::~RWCharInputStreamImp ( )

inlinevirtual

Destructor.

RWCharInputStreamImp()

RWCharInputStreamImp::RWCharInputStreamImp ( )

inlineprotected

Constructor.

Member Function Documentation

acquire()

virtual RWCharInputStream RWCharInputStreamImp::acquire ( )

virtual

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

Reimplemented in RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >.

read() [1/2]

virtual char RWCharInputStreamImp::read ( )

pure virtual

Reads a single narrow character from the stream.

Implemented in RWCharFromStreambufInputStreamImp, RWFilteredCharInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, and RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >.

read() [2/2]

virtual RWSize RWCharInputStreamImp::read ( char * charArray, RWSize numChars )

pure virtual

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

Parameters

charArray	A pointer to the first element of the array.
numChars	The number of narrow characters to be read from the stream.

Implemented in RWCharFromStreambufInputStreamImp, RWFilteredCharInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, and RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >.

readStringUntil()

virtual void RWCharInputStreamImp::readStringUntil ( RWCString & string, char delim )

pure virtual

Reads narrow character(s) from the attached source stream until the last character read is equal to delim, or the end of the input sequence is reached. The narrow character(s) read are stored in a narrow string object.

Parameters

string	A string object receiving the narrow character(s) extracted from the stream.
delim	The narrow character used as a delimiter.

Implemented in RWBufferedCharInputStreamImp, RWCharFromStreambufInputStreamImp, RWFilteredCharInputStreamImp, and RWSynchronizedCharInputStreamImp.

readUntil()

virtual RWSize RWCharInputStreamImp::readUntil ( char * charArray, RWSize maxSize, char delim )

pure virtual

Reads narrow character(s) from the attached source stream until the last narrow character read is equal to delim, or maxSize narrow character(s) have been read, or the end of the input sequence is reached. The narrow character(s) read are stored in charArray. The function returns the actual number of narrow character(s) read from the stream.

Parameters

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

Implemented in RWCharFromStreambufInputStreamImp, RWFilteredCharInputStreamImp, RWSynchronizedCharInputStreamImp, and RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >.

release()

virtual void RWCharInputStreamImp::release ( void )

inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

Reimplemented in RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >.