RWByteToStreambufOutputStreamImp Class Reference

Concrete class connecting a binary stream to an iostreams narrow character buffer. More...

#include <rw/stream/RWByteToStreambufOutputStreamImp.h>

Inheritance diagram for RWByteToStreambufOutputStreamImp:

Public Member Functions
virtual	~RWByteToStreambufOutputStreamImp ()
virtual void	close ()
virtual void	flush ()
virtual bool	isBad () const
virtual bool	isFail () const
virtual bool	isGood () const
virtual void	write (const RWByte *byteArray, RWSize numBytes)
virtual void	write (RWByte byteValue)
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 ()

Static Public Member Functions
static RWByteOutputStream	make (std::streambuf &sink)

Protected Member Functions
	RWByteToStreambufOutputStreamImp (std::streambuf &sinkBuff)
std::streambuf &	getSinkBuff ()
const std::streambuf &	getSinkBuff () 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 (const RWBodyBase &second)
	RWBodyBase (RWStaticCtor)
	RWBodyBase (void)
virtual	~RWBodyBase (void)
RWBodyBase &	operator= (const RWBodyBase &second)
Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
	RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)
	RWTCountingBody (RWStaticCtor)
	RWTCountingBody (unsigned initCount=0)
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 (const RWTMonitor< RWMutexLock > &second)
	RWTMonitor (RWStaticCtor)
	RWTMonitor (void)
	~RWTMonitor (void)
void	acquire (void)
bool	isAcquired (void) const
RWTMonitor< RWMutexLock > &	monitor (void) const
RWMutexLock &	mutex (void)
RWTMonitor< RWMutexLock > &	operator= (const RWTMonitor< RWMutexLock > &)
void	release (void)
bool	tryAcquire (void)

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

Concrete class connecting a binary stream to an iostreams narrow character buffer. The iostreams buffer is used as the sink for the data written to the binary stream. The iostreams buffer must be opened in binary mode. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

~RWByteToStreambufOutputStreamImp()

virtual RWByteToStreambufOutputStreamImp::~RWByteToStreambufOutputStreamImp ( )

virtual

Destructor.

RWByteToStreambufOutputStreamImp()

RWByteToStreambufOutputStreamImp::RWByteToStreambufOutputStreamImp ( std::streambuf & sinkBuff )

inlineprotected

Initializes the reference to the iostreams std::streambuf, used as the sink of bytes.

Parameters

sinkBuff

The iostreams std::streambuf that will serve as the sink of bytes.

Member Function Documentation

close()

virtual void RWByteToStreambufOutputStreamImp::close ( )

virtual

This function calls flush(). The user is responsible for closing the iostreams std::streambuf used as the sink of bytes, if necessary. Throws RWExternalStreamException and propagates any other exception thrown by the internal std::iostreams streambuf object.

Reimplemented from RWOutputStreamImp.

flush()

virtual void RWByteToStreambufOutputStreamImp::flush ( )

virtual

Forward the flush request to the iostreams std::streambuf. Throws RWExternalStreamException and propagates any other exception thrown by the internal iostreams std::streambuf object.

Implements RWOutputStreamImp.

getSinkBuff() [1/2]

std::streambuf & RWByteToStreambufOutputStreamImp::getSinkBuff ( )

inlineprotected

Returns a reference to the iostreams std::streambuf, which is used as the sink of bytes.

getSinkBuff() [2/2]

const std::streambuf & RWByteToStreambufOutputStreamImp::getSinkBuff ( ) const

inlineprotected

Returns a const reference to the iostreams std::streambuf, which is used as the sink of bytes.

isBad()

virtual bool RWByteToStreambufOutputStreamImp::isBad ( ) const

virtual

Returns true if the last operation performed on the iostreams std::streambuf failed.

Implements RWStreamImp.

isFail()

virtual bool RWByteToStreambufOutputStreamImp::isFail ( ) const

virtual

Returns true if the last operation performed on the iostreams std::streambuf failed.

Implements RWStreamImp.

isGood()

virtual bool RWByteToStreambufOutputStreamImp::isGood ( ) const

virtual

Returns true if the last operation performed on the iostreams std::streambuf succeeded.

Implements RWStreamImp.

make()

static RWByteOutputStream RWByteToStreambufOutputStreamImp::make ( std::streambuf & sink )

inlinestatic

Constructs an RWByteToStreambufOutputStreamImp instance that uses sink as its sink of bytes, and returns a handle to it. Throws no exceptions.

Parameters

sink	The iostreams std::streambuf that is used as the sink of bytes.

write() [1/2]

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

virtual

Writes an array of bytes to the iostreams std::streambuf. Throws exception RWIncompleteStreamOperation and propagates any other exception thrown by the internal iostreams std::streambuf object.

Parameters

byteArray	A pointer to the first element of the array.
numBytes	The number of bytes to be written.

Implements RWByteOutputStreamImp.

write() [2/2]

virtual void RWByteToStreambufOutputStreamImp::write ( RWByte byteValue )

virtual

Writes a single byte to the iostreams std::streambuf. Throws exception RWExternalStreamException and propagates any other exception thrown by the internal iostreams std::streambuf object.

Parameters

byteValue

The byte to be written.

Implements RWByteOutputStreamImp.