SourcePro® API Reference Guide

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

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

#include <rw/stream/RWByteOutputStreamImp.h>

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

Public Member Functions

virtual ~RWByteOutputStreamImp ()
 
virtual RWByteOutputStream acquire ()
 
virtual void release ()
 
virtual void write (RWByte byteValue)=0
 
virtual void write (const RWByte *byteArray, RWSize numBytes)=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

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

Constructor & Destructor Documentation

virtual RWByteOutputStreamImp::~RWByteOutputStreamImp ( )
inlinevirtual

Destructor.

RWByteOutputStreamImp::RWByteOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

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

virtual void RWByteOutputStreamImp::release ( )
inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

virtual void RWByteOutputStreamImp::write ( RWByte  byteValue)
pure virtual

Writes a single byte to the stream.

Parameters
byteValueThe byte to be written to the stream.

Implemented in RWChainedByteArrayOutputStreamImp, RWByteToStreambufOutputStreamImp, and RWFilteredByteOutputStreamImp.

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

Writes an array of bytes to the stream.

Parameters
byteArrayA pointer to the first element of the array.
numBytesThe number of bytes to be written to the stream.

Implemented in RWChainedByteArrayOutputStreamImp, RWByteToStreambufOutputStreamImp, and RWFilteredByteOutputStreamImp.

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