RWInputStreamImp Class Reference

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

#include <rw/stream/RWInputStreamImp.h>

Inheritance diagram for RWInputStreamImp:

Public Member Functions
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
	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 input stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

~RWInputStreamImp()

virtual RWInputStreamImp::~RWInputStreamImp ( )

inlinevirtual

Destructor.

RWInputStreamImp()

RWInputStreamImp::RWInputStreamImp ( )

inlineprotected

Constructor.

Member Function Documentation

available()

virtual RWSize RWInputStreamImp::available ( ) const

pure virtual

Returns the number of available elements that can be read from the stream without blocking. The type of the elements read is specified by derived classes and can be one of the following: RWByte, char, RWUChar, or wchar_t. Throws no exceptions.

Implemented in RWByteFromStreambufInputStreamImp, RWCharFromStreambufInputStreamImp, RWDataFromByteInputStreamImp, RWDataFromCharInputStreamImp, RWDataFromVirtualInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWFilteredDataInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredWCharInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWUCharFromByteInputStreamImp, RWUCharFromUTF8ByteInputStreamImp, and RWWCharFromWStreambufInputStreamImp.

isEof()

virtual bool RWInputStreamImp::isEof ( ) const

pure virtual

Returns true to indicate that an input operation reached the end of an input sequence. Throws no exceptions.

Implemented in RWByteFromStreambufInputStreamImp, RWCharFromStreambufInputStreamImp, RWDataFromByteInputStreamImp, RWDataFromCharInputStreamImp, RWDataFromVirtualInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWFilteredDataInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredWCharInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWUCharFromByteInputStreamImp, RWUCharFromUTF8ByteInputStreamImp, and RWWCharFromWStreambufInputStreamImp.

skip()

virtual RWSize RWInputStreamImp::skip ( RWSize numUnits )

pure virtual

Skips numUnits elements from the input sequence if possible. The function returns the actual number of elements skipped, which can be any value between 0 and numUnits. The type of the elements skipped is specified by derived classes and can be one of the following: RWByte, char, RWUChar, or wchar_t.

Parameters

numUnits

The number of elements to be skipped.

Implemented in RWByteFromStreambufInputStreamImp, RWCharFromStreambufInputStreamImp, RWDataFromByteInputStreamImp, RWDataFromCharInputStreamImp, RWDataFromVirtualInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWFilteredDataInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredWCharInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWUCharFromByteInputStreamImp, RWUCharFromUTF8ByteInputStreamImp, and RWWCharFromWStreambufInputStreamImp.