SourcePro® API Reference Guide

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

Abstract base class for binary output streams, allowing retrieval of inserted data as a byte array. More...

#include <rw/stream/RWByteArrayOutputStreamImp.h>

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

Public Member Functions

virtual ~RWByteArrayOutputStreamImp ()
 
virtual void clear ()=0
 
virtual RWBytegetByteArray ()=0
 
virtual RWSize getByteArraySize () const =0
 
- Public Member Functions inherited from RWByteOutputStreamImp
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

 RWByteArrayOutputStreamImp ()
 
- 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

The abstract base class for binary output streams that support an extended interface, which allows retrieval of their inserted data as a byte array. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWByteArrayOutputStreamImp::~RWByteArrayOutputStreamImp ( )
inlinevirtual

Destructor.

RWByteArrayOutputStreamImp::RWByteArrayOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

virtual void RWByteArrayOutputStreamImp::clear ( )
pure virtual

Resets the underlying buffer.

Implemented in RWChainedByteArrayOutputStreamImp.

virtual RWByte* RWByteArrayOutputStreamImp::getByteArray ( )
pure virtual

Returns a pointer to an array of bytes containing the bytes inserted into the stream since its creation. Users are responsible for freeing the memory associated with the array returned by this function, by using operator delete[].

Implemented in RWChainedByteArrayOutputStreamImp.

virtual RWSize RWByteArrayOutputStreamImp::getByteArraySize ( ) const
pure virtual

Returns the size of the byte array that would be returned by a call to function getByteArray().

Implemented in RWChainedByteArrayOutputStreamImp.

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