RWByteInputStreamImp Class Reference
[Streams]

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

#include <rw/stream/RWByteInputStreamImp.h>

Inheritance diagram for RWByteInputStreamImp:

List of all members.

Public Member Functions
virtual	~RWByteInputStreamImp ()
virtual RWByte	read ()=0
virtual RWSize	read (RWByte *byteArray, RWSize numBytes)=0
virtual RWSize	readUntil (RWByte *byteArray, RWSize maxSize, RWByte delim)=0
virtual RWByteInputStream	acquire ()
virtual void	release ()
Protected Member Functions
	RWByteInputStreamImp ()

---

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

(

)

[inline, virtual]

Destructor.

RWByteInputStreamImp::RWByteInputStreamImp

(

)

[inline, protected]

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

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, 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 RWByteFromStreambufInputStreamImp, and RWFilteredByteInputStreamImp.

virtual RWByte RWByteInputStreamImp::read

(

)

[pure virtual]

Reads a single byte from the stream.

Implemented in RWByteFromStreambufInputStreamImp, RWFilteredByteInputStreamImp, and RWTInputStreamLockImp< RWByteInputStream, 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

(

)

[inline, virtual]

Releases the synchronization mechanism provided by a stream concrete implementation.

Reimplemented from RWTMonitor< RWMutexLock >.

Reimplemented in RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.