RWWCharInputStreamImp Class Reference
[Streams]

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

#include <rw/stream/RWWCharInputStreamImp.h>

Inheritance diagram for RWWCharInputStreamImp:

List of all members.

Public Member Functions
virtual	~RWWCharInputStreamImp ()
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 RWWCharInputStream	acquire ()
virtual void	release ()
Protected Member Functions
	RWWCharInputStreamImp ()

---

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

virtual RWWCharInputStreamImp::~RWWCharInputStreamImp

(

)

[inline, virtual]

Destructor.

RWWCharInputStreamImp::RWWCharInputStreamImp

(

)

[inline, protected]

Constructor.

---

Member Function Documentation

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 from RWTMonitor< RWMutexLock >.

Reimplemented in RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >.

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, and RWWCharFromWStreambufInputStreamImp.

virtual wchar_t RWWCharInputStreamImp::read

(

)

[pure virtual]

Reads a single wide character from the stream.

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

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.

virtual void RWWCharInputStreamImp::release

(

void

)

[inline, virtual]

Releases the synchronization mechanism provided by a stream concrete implementation.

Reimplemented from RWTMonitor< RWMutexLock >.

Reimplemented in RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >.