SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWSynchronizedDataInputStreamImp Class Reference

Implementation of a simple lock stream that is used with a data input stream. More...

#include <rw/stream/RWSynchronizedDataInputStreamImp.h>

Inheritance diagram for RWSynchronizedDataInputStreamImp:
RWFilteredDataInputStreamImp RWDataInputStreamImp RWInputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock >

Public Member Functions

virtual ~RWSynchronizedDataInputStreamImp ()
 
virtual RWDataInputStream acquire ()
 
virtual RWSize available () const
 
virtual void close ()
 
virtual void getBool (bool &value)
 
virtual RWSize getBools (bool *arrayPt, RWSize count)
 
virtual void getChar (char &value)
 
virtual void getCharacter (char &value)
 
virtual RWSize getChars (char *arrayPt, RWSize count)
 
virtual RWSize getDelimitedString (char *string, RWSize maxCount, char delim)
 
virtual RWSize getDelimitedUString (RWUChar *ustring, RWSize maxCount, RWUChar delim)
 
virtual RWSize getDelimitedWString (wchar_t *wstring, RWSize maxCount, wchar_t delim)
 
virtual void getDouble (double &value)
 
virtual RWSize getDoubles (double *arrayPt, RWSize count)
 
virtual void getFloat (float &value)
 
virtual RWSize getFloats (float *arrayPt, RWSize count)
 
virtual void getInt (int &value)
 
virtual RWSize getInts (int *arrayPt, RWSize count)
 
virtual void getLong (long &value)
 
virtual void getLongDouble (long double &value)
 
virtual RWSize getLongDoubles (long double *arrayPt, RWSize count)
 
virtual void getLongLong (long long &value)
 
virtual RWSize getLongLongs (long long *arrayPt, RWSize count)
 
virtual RWSize getLongs (long *arrayPt, RWSize count)
 
virtual void getShort (short &value)
 
virtual RWSize getShorts (short *arrayPt, RWSize count)
 
virtual void getSignedChar (signed char &value)
 
virtual RWSize getSignedChars (signed char *arrayPt, RWSize count)
 
virtual void getSizeT (size_t &value)
 
virtual RWSize getString (char *string, RWSize count)
 
virtual void getUCharacter (RWUChar &value)
 
virtual void getUnsignedChar (unsigned char &value)
 
virtual RWSize getUnsignedChars (unsigned char *arrayPt, RWSize count)
 
virtual void getUnsignedInt (unsigned int &value)
 
virtual RWSize getUnsignedInts (unsigned int *arrayPt, RWSize count)
 
virtual void getUnsignedLong (unsigned long &value)
 
virtual void getUnsignedLongLong (unsigned long long &value)
 
virtual RWSize getUnsignedLongLongs (unsigned long long *arrayPt, RWSize count)
 
virtual RWSize getUnsignedLongs (unsigned long *arrayPt, RWSize count)
 
virtual void getUnsignedShort (unsigned short &value)
 
virtual RWSize getUnsignedShorts (unsigned short *arrayPt, RWSize count)
 
virtual RWSize getUString (RWUChar *ustring, RWSize count)
 
virtual void getWchar_t (wchar_t &value)
 
virtual RWSize getWchar_ts (wchar_t *arrayPt, RWSize count)
 
virtual void getWCharacter (wchar_t &value)
 
virtual RWSize getWString (wchar_t *wstring, RWSize count)
 
virtual bool isBad () const
 
virtual bool isEof () const
 
virtual bool isFail () const
 
virtual bool isGood () const
 
virtual void release ()
 
virtual RWSize skip (RWSize numUnits)
 
- Public Member Functions inherited from RWFilteredDataInputStreamImp
virtual ~RWFilteredDataInputStreamImp ()
 
- Public Member Functions inherited from RWDataInputStreamImp
virtual ~RWDataInputStreamImp ()
 
- Public Member Functions inherited from RWInputStreamImp
virtual ~RWInputStreamImp ()
 
- Public Member Functions inherited from RWStreamImp
virtual ~RWStreamImp ()
 

Static Public Member Functions

static RWDataInputStream make (const RWDataInputStream &sourceStream)
 

Protected Member Functions

 RWSynchronizedDataInputStreamImp (const RWDataInputStream &sourceStream)
 
RWMutexLockgetStreamMutex ()
 
RWMutexLockgetStreamMutex () const
 
- Protected Member Functions inherited from RWFilteredDataInputStreamImp
 RWFilteredDataInputStreamImp (const RWDataInputStream &sourceStream)
 
RWDataInputStreamgetSourceStream ()
 
const RWDataInputStreamgetSourceStream () const
 
- Protected Member Functions inherited from RWDataInputStreamImp
 RWDataInputStreamImp ()
 
- Protected Member Functions inherited from RWInputStreamImp
 RWInputStreamImp ()
 
- Protected Member Functions inherited from RWStreamImp
 RWStreamImp ()
 
- Protected Member Functions inherited from RWBodyBase
 RWBodyBase (const RWBodyBase &second)
 
 RWBodyBase (RWStaticCtor)
 
 RWBodyBase (void)
 
virtual ~RWBodyBase (void)
 
RWBodyBaseoperator= (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
 
RWMutexLockmutex (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

Class RWSynchronizedDataInputStreamImp implements a simple lock stream that is used with data input stream. The stream locks its internal synchronization mechanism before forwarding input requests to its associated source stream, and then unlocks the internal synchronization mechanism upon completion. The stream's internal synchronization mechanism is locked using a guard object, ensuring its proper release in the event that an exception is thrown.

Constructor & Destructor Documentation

◆ ~RWSynchronizedDataInputStreamImp()

virtual RWSynchronizedDataInputStreamImp::~RWSynchronizedDataInputStreamImp ( )
virtual

Destructor.

◆ RWSynchronizedDataInputStreamImp()

RWSynchronizedDataInputStreamImp::RWSynchronizedDataInputStreamImp ( const RWDataInputStream & sourceStream)
protected

Initializes the reference to the input stream that will be used as the source of data.

Parameters
sourceStreamThe input stream that will serve as the source of data.

Member Function Documentation

◆ acquire()

virtual RWDataInputStream RWSynchronizedDataInputStreamImp::acquire ( )
virtual

Acquires the stream's internal synchronization mechanism. The acquire() member function returns a handle to the next processing stream.

Reimplemented from RWDataInputStreamImp.

◆ available()

virtual RWSize RWSynchronizedDataInputStreamImp::available ( ) const
virtual

Returns the number of bytes that can be read from the stream without blocking. Throws no exceptions.

Reimplemented from RWFilteredDataInputStreamImp.

◆ close()

virtual void RWSynchronizedDataInputStreamImp::close ( )
virtual

Calls close() on the next processing stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getBool()

virtual void RWSynchronizedDataInputStreamImp::getBool ( bool & value)
virtual

Forward reading of a single bool value from the attached source stream.

Parameters
valueThe value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getBools()

virtual RWSize RWSynchronizedDataInputStreamImp::getBools ( bool * arrayPt,
RWSize count )
virtual

Forward the reading of an array of bool elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getChar()

virtual void RWSynchronizedDataInputStreamImp::getChar ( char & value)
virtual

Forward reading of a single char value from the attached source stream.

Parameters
valueThe char value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getCharacter()

virtual void RWSynchronizedDataInputStreamImp::getCharacter ( char & value)
virtual

Forward the reading of a narrow character from the attached source stream.

Parameters
valueThe narrow character to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getChars()

virtual RWSize RWSynchronizedDataInputStreamImp::getChars ( char * arrayPt,
RWSize count )
virtual

Forward the reading of an array of char elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getDelimitedString()

virtual RWSize RWSynchronizedDataInputStreamImp::getDelimitedString ( char * string,
RWSize maxCount,
char delim )
virtual

Forward the reading of narrow characters from the stream until the last character read is equal to delim, or maxCount narrow characters have been read, or the end of the input sequence is reached. The narrow characters read are stored in string. The function returns the actual number of narrow characters read from the stream.

Parameters
stringA pointer to the string receiving the narrow character(s) extracted from the stream.
maxCountThe maximum number of narrow character(s) to be read.
delimThe narrow character used as a delimiter.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getDelimitedUString()

virtual RWSize RWSynchronizedDataInputStreamImp::getDelimitedUString ( RWUChar * ustring,
RWSize maxCount,
RWUChar delim )
virtual

Forward the reading of UTF-16 characters from the stream until the last character read is equal to delim, or maxCount UTF-16 characters have been read, or the end of the input sequence is reached. The UTF-16 characters read are stored in ustring. The function returns the actual number of UTF-16 characters read from the stream.

Parameters
ustringA pointer to the string receiving the unicode character(s) extracted from the stream.
maxCountThe maximum number of unicode character(s) to be read.
delimThe unicode character used as a delimiter.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getDelimitedWString()

virtual RWSize RWSynchronizedDataInputStreamImp::getDelimitedWString ( wchar_t * wstring,
RWSize maxCount,
wchar_t delim )
virtual

Forward the reading of wide characters from the stream until the last character read is equal to delim, or maxCount wide characters have been read, or the end of the input sequence is reached. The wide characters read are stored in wstring. The function returns the actual number of wide characters read from the stream.

Parameters
wstringA pointer to the string receiving the wide character(s) extracted from the stream.
maxCountThe maximum number of wide character(s) to be read.
delimThe wide character used as a delimiter.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getDouble()

virtual void RWSynchronizedDataInputStreamImp::getDouble ( double & value)
virtual

Forward reading of a single double value from the attached source stream.

Parameters
valueThe double value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getDoubles()

virtual RWSize RWSynchronizedDataInputStreamImp::getDoubles ( double * arrayPt,
RWSize count )
virtual

Forward the reading of an array of double elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getFloat()

virtual void RWSynchronizedDataInputStreamImp::getFloat ( float & value)
virtual

Forward reading of a single float value from the attached source stream.

Parameters
valueThe float value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getFloats()

virtual RWSize RWSynchronizedDataInputStreamImp::getFloats ( float * arrayPt,
RWSize count )
virtual

Forward the reading of an array of float elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getInt()

virtual void RWSynchronizedDataInputStreamImp::getInt ( int & value)
virtual

Forward reading of a single int value from the attached source stream.

Parameters
valueThe int value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getInts()

virtual RWSize RWSynchronizedDataInputStreamImp::getInts ( int * arrayPt,
RWSize count )
virtual

Forward the reading of an array of int elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getLong()

virtual void RWSynchronizedDataInputStreamImp::getLong ( long & value)
virtual

Forward reading of a single long value from the attached source stream.

Parameters
valueThe long value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getLongDouble()

virtual void RWSynchronizedDataInputStreamImp::getLongDouble ( long double & value)
virtual

Forward reading of a single long double value from the attached source stream.

Parameters
valueThe long double value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getLongDoubles()

virtual RWSize RWSynchronizedDataInputStreamImp::getLongDoubles ( long double * arrayPt,
RWSize count )
virtual

Forward the reading of an array of long double elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getLongLong()

virtual void RWSynchronizedDataInputStreamImp::getLongLong ( long long & value)
virtual

Forward reading of a single long long value from the attached source stream.

Parameters
valueThe long long value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getLongLongs()

virtual RWSize RWSynchronizedDataInputStreamImp::getLongLongs ( long long * arrayPt,
RWSize count )
virtual

Forward the reading of an array of long long elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getLongs()

virtual RWSize RWSynchronizedDataInputStreamImp::getLongs ( long * arrayPt,
RWSize count )
virtual

Forward the reading of an array of long elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getShort()

virtual void RWSynchronizedDataInputStreamImp::getShort ( short & value)
virtual

Forward reading of a single short value from the attached source stream.

Parameters
valueThe short value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getShorts()

virtual RWSize RWSynchronizedDataInputStreamImp::getShorts ( short * arrayPt,
RWSize count )
virtual

Forward the reading of an array of short elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getSignedChar()

virtual void RWSynchronizedDataInputStreamImp::getSignedChar ( signed char & value)
virtual

Forward reading of a single signed char value from the attached source stream.

Parameters
valueThe signed char value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getSignedChars()

virtual RWSize RWSynchronizedDataInputStreamImp::getSignedChars ( signed char * arrayPt,
RWSize count )
virtual

Forward the reading of an array of signed char elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getSizeT()

virtual void RWSynchronizedDataInputStreamImp::getSizeT ( size_t & value)
virtual

Reads a size_t value from the stream.

Parameters
valueThe size_t value to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getStreamMutex() [1/2]

RWMutexLock & RWSynchronizedDataInputStreamImp::getStreamMutex ( )
inlineprotected

Returns the stream's internal synchronization mechanism. Throws no exception.

◆ getStreamMutex() [2/2]

RWMutexLock & RWSynchronizedDataInputStreamImp::getStreamMutex ( ) const
inlineprotected

Returns the stream's internal synchronization mechanism. Throws no exception.

◆ getString()

virtual RWSize RWSynchronizedDataInputStreamImp::getString ( char * string,
RWSize count )
virtual

Forward the reading of a string of narrow characters from the attached source stream. The function returns the number of narrow characters read.

Parameters
stringA pointer to the first element of the string. The string must have been pre-allocated to contain at least count narrow characters.
countThe number of narrow character(s) to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUCharacter()

virtual void RWSynchronizedDataInputStreamImp::getUCharacter ( RWUChar & value)
virtual

Forward the reading of a UTF-16 character from the attached source stream.

Parameters
valueThe unicode character to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedChar()

virtual void RWSynchronizedDataInputStreamImp::getUnsignedChar ( unsigned char & value)
virtual

Forward reading of a single unsigned char value from the attached source stream.

Parameters
valueThe unsigned char value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedChars()

virtual RWSize RWSynchronizedDataInputStreamImp::getUnsignedChars ( unsigned char * arrayPt,
RWSize count )
virtual

Forward the reading of an array of unsigned char elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedInt()

virtual void RWSynchronizedDataInputStreamImp::getUnsignedInt ( unsigned int & value)
virtual

Forward reading of a single unsigned int value from the attached source stream.

Parameters
valueThe unsigned int value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedInts()

virtual RWSize RWSynchronizedDataInputStreamImp::getUnsignedInts ( unsigned int * arrayPt,
RWSize count )
virtual

Forward the reading of an array of unsigned int elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedLong()

virtual void RWSynchronizedDataInputStreamImp::getUnsignedLong ( unsigned long & value)
virtual

Forward reading of a single unsigned long value from the attached source stream.

Parameters
valueThe unsigned long value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedLongLong()

virtual void RWSynchronizedDataInputStreamImp::getUnsignedLongLong ( unsigned long long & value)
virtual

Forward reading of a single unsigned long long value from the attached source stream.

Parameters
valueThe unsigned long long value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedLongLongs()

virtual RWSize RWSynchronizedDataInputStreamImp::getUnsignedLongLongs ( unsigned long long * arrayPt,
RWSize count )
virtual

Forward the reading of an array of unsigned long long elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedLongs()

virtual RWSize RWSynchronizedDataInputStreamImp::getUnsignedLongs ( unsigned long * arrayPt,
RWSize count )
virtual

Forward the reading of an array of unsigned long elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedShort()

virtual void RWSynchronizedDataInputStreamImp::getUnsignedShort ( unsigned short & value)
virtual

Forward reading of a single unsigned short value from the attached source stream.

Parameters
valueThe unsigned short value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUnsignedShorts()

virtual RWSize RWSynchronizedDataInputStreamImp::getUnsignedShorts ( unsigned short * arrayPt,
RWSize count )
virtual

Forward the reading of an array of unsigned short elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getUString()

virtual RWSize RWSynchronizedDataInputStreamImp::getUString ( RWUChar * ustring,
RWSize count )
virtual

Forward the reading of a string of UTF-16 characters from the attached source stream. The function returns the number of UTF-16 characters read.

Parameters
ustringA pointer to the first element of the string. The string must have been pre-allocated to contain at least count unicode characters.
countThe number of unicode character(s) to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getWchar_t()

virtual void RWSynchronizedDataInputStreamImp::getWchar_t ( wchar_t & value)
virtual

Forward reading of a single wchar_t value from the attached source stream.

Parameters
valueThe wchar_t value to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getWchar_ts()

virtual RWSize RWSynchronizedDataInputStreamImp::getWchar_ts ( wchar_t * arrayPt,
RWSize count )
virtual

Forward the reading of an array of wchar_t elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getWCharacter()

virtual void RWSynchronizedDataInputStreamImp::getWCharacter ( wchar_t & value)
virtual

Forward the reading of a wide character from the attached source stream.

Parameters
valueThe wide character to be read from the attached source stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ getWString()

virtual RWSize RWSynchronizedDataInputStreamImp::getWString ( wchar_t * wstring,
RWSize count )
virtual

Forward the reading of a string of wide characters from the attached source stream. The function returns the number of wide characters read.

Parameters
wstringA pointer to the first element of the string. The string must have been pre-allocated to contain at least count wide characters.
countThe number of wide character(s) to be read from the stream.

Reimplemented from RWFilteredDataInputStreamImp.

◆ isBad()

virtual bool RWSynchronizedDataInputStreamImp::isBad ( ) const
virtual

If the stream is in bad state, then this function returns true, otherwise it returns false. Throws no exceptions.

Reimplemented from RWFilteredDataInputStreamImp.

◆ isEof()

virtual bool RWSynchronizedDataInputStreamImp::isEof ( ) const
virtual

If no data can be obtained from the input sequence, this function returns true, otherwise it returns false. Throws no exceptions.

Reimplemented from RWFilteredDataInputStreamImp.

◆ isFail()

virtual bool RWSynchronizedDataInputStreamImp::isFail ( ) const
virtual

If the stream is in fail state, then this function returns true, otherwise it returns false. Throws no exceptions.

Reimplemented from RWFilteredDataInputStreamImp.

◆ isGood()

virtual bool RWSynchronizedDataInputStreamImp::isGood ( ) const
virtual

If the stream is in fail or bad state, then this function returns false, otherwise it returns true. Throws no exceptions.

Reimplemented from RWFilteredDataInputStreamImp.

◆ make()

static RWDataInputStream RWSynchronizedDataInputStreamImp::make ( const RWDataInputStream & sourceStream)
inlinestatic

Constructs an RWSynchronizedDataInputStreamImp instance that uses sourceStream as its source of data, and returns a handle to it. Throws no exceptions.

Parameters
sourceStreamThe output stream that will serve as the source of data.

◆ release()

virtual void RWSynchronizedDataInputStreamImp::release ( )
virtual

Releases the stream's internal synchronization mechanism.

Reimplemented from RWDataInputStreamImp.

◆ skip()

virtual RWSize RWSynchronizedDataInputStreamImp::skip ( RWSize numUnits)
virtual

Skips numUnits bytes from the input sequence if possible. The function returns the actual number of bytes skipped, which can be any value between 0 and numUnits.

Parameters
numUnitsThe number of bytes to be skipped.

Reimplemented from RWFilteredDataInputStreamImp.

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