SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Protected Member Functions
RWCharOutputStreamImp Class Referenceabstract

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

#include <rw/stream/RWCharOutputStreamImp.h>

Inheritance diagram for RWCharOutputStreamImp:
RWOutputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock > RWCharArrayOutputStreamImp RWCharToStreambufOutputStreamImp RWFilteredCharOutputStreamImp RWChainedCharArrayOutputStreamImp

Public Member Functions

virtual ~RWCharOutputStreamImp ()
 
virtual RWCharOutputStream acquire ()
 
virtual void release ()
 
virtual void write (char charValue)=0
 
virtual void write (const char *charArray, RWSize numChars)=0
 
- Public Member Functions inherited from RWOutputStreamImp
virtual ~RWOutputStreamImp ()
 
virtual void close ()
 
virtual void flush ()=0
 
- Public Member Functions inherited from RWStreamImp
virtual ~RWStreamImp ()
 
virtual bool isBad () const =0
 
virtual bool isFail () const =0
 
virtual bool isGood () const =0
 

Protected Member Functions

 RWCharOutputStreamImp ()
 
- 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 narrow character output stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWCharOutputStreamImp::~RWCharOutputStreamImp ( )
inlinevirtual

Destructor.

RWCharOutputStreamImp::RWCharOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

virtual RWCharOutputStream RWCharOutputStreamImp::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 output operation after acquiring the synchronization mechanism.

virtual void RWCharOutputStreamImp::release ( )
inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

virtual void RWCharOutputStreamImp::write ( char  charValue)
pure virtual

Writes a single narrow character to the stream.

Parameters
charValueThe narrow character to be written to the stream.

Implemented in RWChainedCharArrayOutputStreamImp, RWCharToStreambufOutputStreamImp, and RWFilteredCharOutputStreamImp.

virtual void RWCharOutputStreamImp::write ( const char *  charArray,
RWSize  numChars 
)
pure virtual

Writes an array of narrow characters to the stream.

Parameters
charArrayA pointer to the first element of the array.
numCharsThe number of narrow characters to be written to the stream.

Implemented in RWCharToStreambufOutputStreamImp, RWChainedCharArrayOutputStreamImp, and RWFilteredCharOutputStreamImp.

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