RWCharInputStreamImp Class Reference
[Streams]

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

#include <rw/stream/RWCharInputStreamImp.h>

Inheritance diagram for RWCharInputStreamImp:

List of all members.

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

---

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

virtual RWCharInputStreamImp::~RWCharInputStreamImp

(

)

[inline, virtual]

Destructor.

RWCharInputStreamImp::RWCharInputStreamImp

(

)

[inline, protected]

Constructor.

---

Member Function Documentation

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

Reimplemented in RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >.

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

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 >.

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 delimeter.

Implemented in RWBufferedCharInputStreamImp, RWCharFromStreambufInputStreamImp, RWFilteredCharInputStreamImp, and RWSynchronizedCharInputStreamImp.

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 delimeter.

Implemented in RWCharFromStreambufInputStreamImp, RWFilteredCharInputStreamImp, and RWSynchronizedCharInputStreamImp.

virtual void RWCharInputStreamImp::release

(

)

[inline, virtual]

Releases the synchronization mechanism provided by a stream concrete implementation.

Reimplemented from RWTMonitor< RWMutexLock >.

Reimplemented in RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >.