SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Protected Member Functions
RWFilteredByteOutputStreamImp Class Reference

Abstract base class for all the filtered binary output stream implementation classes. More...

#include <rw/stream/RWFilteredByteOutputStreamImp.h>

Inheritance diagram for RWFilteredByteOutputStreamImp:
RWByteOutputStreamImp RWOutputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock >

Public Member Functions

virtual ~RWFilteredByteOutputStreamImp ()
 
virtual void close ()
 
virtual void flush ()
 
virtual bool isBad () const
 
virtual bool isFail () const
 
virtual bool isGood () const
 
virtual void write (RWByte byteValue)
 
virtual void write (const RWByte *byteArray, RWSize numBytes)
 
- Public Member Functions inherited from RWByteOutputStreamImp
virtual ~RWByteOutputStreamImp ()
 
virtual RWByteOutputStream acquire ()
 
virtual void release ()
 
- Public Member Functions inherited from RWOutputStreamImp
virtual ~RWOutputStreamImp ()
 
- Public Member Functions inherited from RWStreamImp
virtual ~RWStreamImp ()
 

Protected Member Functions

 RWFilteredByteOutputStreamImp (const RWByteOutputStream &sinkStream)
 
RWByteOutputStreamgetSinkStream ()
 
const RWByteOutputStreamgetSinkStream () const
 
- Protected Member Functions inherited from RWByteOutputStreamImp
 RWByteOutputStreamImp ()
 
- Protected Member Functions inherited from RWOutputStreamImp
 RWOutputStreamImp ()
 
- Protected Member Functions inherited from RWStreamImp
 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 ()
 

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 filtered binary output stream implementation classes. A filtered output stream is a stream that process elements and then forwards the result to another stream for further processing. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWFilteredByteOutputStreamImp::~RWFilteredByteOutputStreamImp ( )
virtual

Destructor. Throws no exceptions.

RWFilteredByteOutputStreamImp::RWFilteredByteOutputStreamImp ( const RWByteOutputStream sinkStream)
inlineprotected

Used by derived classes to initialize the next processing stream.

Parameters
sinkStreamA handle to the next processing stream.

Member Function Documentation

virtual void RWFilteredByteOutputStreamImp::close ( )
virtual

Forwards the close() request to the next processing stream.

Reimplemented from RWOutputStreamImp.

virtual void RWFilteredByteOutputStreamImp::flush ( )
virtual

Forwards the flush() request to the next processing stream.

Implements RWOutputStreamImp.

RWByteOutputStream& RWFilteredByteOutputStreamImp::getSinkStream ( )
inlineprotected

Return a handle to the next processing stream. Throws no exceptions.

const RWByteOutputStream& RWFilteredByteOutputStreamImp::getSinkStream ( ) const
inlineprotected

Return a handle to the next processing stream. Throws no exceptions.

virtual bool RWFilteredByteOutputStreamImp::isBad ( ) const
virtual

Forwards the isBad() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

virtual bool RWFilteredByteOutputStreamImp::isFail ( ) const
virtual

Forwards the isFail() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

virtual bool RWFilteredByteOutputStreamImp::isGood ( ) const
virtual

Forwards the isGood() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

virtual void RWFilteredByteOutputStreamImp::write ( RWByte  byteValue)
virtual

Forwards the writing of a single byte to the next processing stream.

Parameters
byteValueThe byte to be written.

Implements RWByteOutputStreamImp.

virtual void RWFilteredByteOutputStreamImp::write ( const RWByte byteArray,
RWSize  numBytes 
)
virtual

Forwards the writing of an array of bytes to the next processing stream.

Parameters
byteArrayA pointer to the first element of the array.
numBytesThe number of byte(s) to be written to the stream.

Implements RWByteOutputStreamImp.

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