SourcePro® API Reference Guide

Product Documentation:
   SourcePro
Documentation Home
List of all members | Public Member Functions | Protected Member Functions | Private Member Functions
RWStreamImp Class Referenceabstract

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

#include <rw/stream/RWStreamImp.h>

Inheritance diagram for RWStreamImp:
RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock > RWInputStreamImp RWOutputStreamImp RWByteInputStreamImp RWCharInputStreamImp RWDataInputStreamImp RWUCharInputStreamImp RWWCharInputStreamImp RWByteOutputStreamImp RWCharOutputStreamImp RWDataOutputStreamImp RWUCharOutputStreamImp RWWCharOutputStreamImp

Public Member Functions

virtual ~RWStreamImp ()
 
virtual void close ()=0
 
virtual bool isBad () const =0
 
virtual bool isFail () const =0
 
virtual bool isGood () const =0
 

Protected Member Functions

 RWStreamImp ()
 
- Protected Member Functions inherited from RWBodyBase
 RWBodyBase (void)
 
 RWBodyBase (RWStaticCtor)
 
 RWBodyBase (const RWBodyBase &second)
 
virtual ~RWBodyBase (void)
 
RWBodyBaseoperator= (const RWBodyBase &second)
 
- Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
 RWTCountingBody (unsigned initCount=0)
 
 RWTCountingBody (RWStaticCtor)
 
 RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)
 
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 ()
 
 RWTMonitor (RWStaticCtor)
 
 RWTMonitor (const RWTMonitor< RWMutexLock > &second)
 
 ~RWTMonitor ()
 
void acquire ()
 
bool isAcquired () const
 
RWTMonitor< RWMutexLock > & monitor () const
 
RWMutexLockmutex ()
 
RWTMonitor< RWMutexLock > & operator= (const RWTMonitor< RWMutexLock > &)
 
void release ()
 
bool tryAcquire ()
 

Private Member Functions

 RWStreamImp (const RWStreamImp &)
 
RWStreamImpoperator= (const RWStreamImp &)
 

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

Constructor & Destructor Documentation

virtual RWStreamImp::~RWStreamImp ( )
inlinevirtual

Destructor.

RWStreamImp::RWStreamImp ( )
inlineprotected

Constructor.

RWStreamImp::RWStreamImp ( const RWStreamImp )
private

Copy construction is not allowed.

Member Function Documentation

virtual void RWStreamImp::close ( )
pure virtual
virtual bool RWStreamImp::isBad ( ) const
pure virtual

Returns true to indicate a loss of integrity resulting from an input or output operation, such as an irrecoverable read error from a file. Throws no exceptions.

Implemented in RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWDataToVirtualOutputStreamImp, RWDataFromVirtualInputStreamImp, RWOstreamDataToCharOutputStreamImp, RWIstreamDataFromCharInputStreamImp, RWChainedCharArrayOutputStreamImp, RWChainedWCharArrayOutputStreamImp, RWChainedUCharArrayOutputStreamImp, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWChainedByteArrayOutputStreamImp, RWUCharToUTF8ByteOutputStreamImp, RWCharToStreambufOutputStreamImp, RWUCharFromUTF8ByteInputStreamImp, RWUCharToByteOutputStreamImp, RWUCharFromByteInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWByteToStreambufOutputStreamImp, RWCharFromStreambufInputStreamImp, RWSynchronizedDataInputStreamImp, RWWCharToWStreambufOutputStreamImp, RWByteFromStreambufInputStreamImp, RWSynchronizedDataOutputStreamImp, RWDataToByteOutputStreamImp, RWFilteredByteOutputStreamImp, RWFilteredUCharOutputStreamImp, RWFilteredWCharOutputStreamImp, RWDataToCharOutputStreamImp, RWDataFromCharInputStreamImp, RWDataFromByteInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredDataOutputStreamImp, RWFilteredWCharInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWFilteredCharOutputStreamImp, and RWFilteredDataInputStreamImp.

virtual bool RWStreamImp::isFail ( ) const
pure virtual

Returns true to indicate that an input operation failed to read the expected data, or that an output operation failed to generate the desired data. Throws no exceptions.

Implemented in RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWOstreamDataToCharOutputStreamImp, RWDataToVirtualOutputStreamImp, RWIstreamDataFromCharInputStreamImp, RWChainedCharArrayOutputStreamImp, RWDataFromVirtualInputStreamImp, RWChainedWCharArrayOutputStreamImp, RWChainedUCharArrayOutputStreamImp, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWChainedByteArrayOutputStreamImp, RWCharToStreambufOutputStreamImp, RWUCharToUTF8ByteOutputStreamImp, RWUCharFromUTF8ByteInputStreamImp, RWUCharToByteOutputStreamImp, RWUCharFromByteInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWByteToStreambufOutputStreamImp, RWCharFromStreambufInputStreamImp, RWSynchronizedDataInputStreamImp, RWWCharToWStreambufOutputStreamImp, RWByteFromStreambufInputStreamImp, RWSynchronizedDataOutputStreamImp, RWDataToByteOutputStreamImp, RWFilteredByteOutputStreamImp, RWFilteredUCharOutputStreamImp, RWFilteredWCharOutputStreamImp, RWDataToCharOutputStreamImp, RWDataFromCharInputStreamImp, RWDataFromByteInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredDataOutputStreamImp, RWFilteredWCharInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWFilteredCharOutputStreamImp, and RWFilteredDataInputStreamImp.

virtual bool RWStreamImp::isGood ( ) const
pure virtual

Returns true to indicate a stream in a valid state. Throws no exceptions.

Implemented in RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWIstreamDataFromCharInputStreamImp, RWDataFromVirtualInputStreamImp, RWChainedCharArrayOutputStreamImp, RWChainedWCharArrayOutputStreamImp, RWChainedUCharArrayOutputStreamImp, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWChainedByteArrayOutputStreamImp, RWCharToStreambufOutputStreamImp, RWUCharToUTF8ByteOutputStreamImp, RWUCharFromUTF8ByteInputStreamImp, RWUCharToByteOutputStreamImp, RWUCharFromByteInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWByteToStreambufOutputStreamImp, RWCharFromStreambufInputStreamImp, RWSynchronizedDataInputStreamImp, RWWCharToWStreambufOutputStreamImp, RWByteFromStreambufInputStreamImp, RWSynchronizedDataOutputStreamImp, RWDataFromCharInputStreamImp, RWDataFromByteInputStreamImp, RWDataToByteOutputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredWCharInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredByteOutputStreamImp, RWFilteredCharInputStreamImp, RWFilteredUCharOutputStreamImp, RWFilteredWCharOutputStreamImp, RWDataToCharOutputStreamImp, RWFilteredDataInputStreamImp, RWFilteredDataOutputStreamImp, and RWFilteredCharOutputStreamImp.

RWStreamImp& RWStreamImp::operator= ( const RWStreamImp )
private

Assignment is not allowed.

Copyright © 2021 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.