SourcePro C++ 13.0 |
SourcePro® C++ API Reference Guide |
Product Documentation: SourcePro C++ Documentation Home |
Abstract base class for all narrow character input stream implementation classes. More...
#include <rw/stream/RWCharInputStreamImp.h>
Public Member Functions | |
virtual | ~RWCharInputStreamImp () |
virtual RWCharInputStream | acquire () |
virtual char | read ()=0 |
virtual RWSize | read (char *charArray, RWSize numChars)=0 |
virtual void | readStringUntil (RWCString &string, char delim)=0 |
virtual RWSize | readUntil (char *charArray, RWSize maxSize, char delim)=0 |
virtual void | release () |
Public Member Functions inherited from RWInputStreamImp | |
virtual | ~RWInputStreamImp () |
virtual RWSize | available () const =0 |
virtual bool | isEof () const =0 |
virtual RWSize | skip (RWSize numUnits)=0 |
Public Member Functions inherited from RWStreamImp | |
virtual | ~RWStreamImp () |
virtual void | close ()=0 |
virtual bool | isBad () const =0 |
virtual bool | isFail () const =0 |
virtual bool | isGood () const =0 |
Protected Member Functions | |
RWCharInputStreamImp () | |
Protected Member Functions inherited from RWInputStreamImp | |
RWInputStreamImp () | |
Protected Member Functions inherited from RWStreamImp | |
RWStreamImp () | |
Protected Member Functions inherited from RWBodyBase | |
RWBodyBase (void) | |
RWBodyBase (RWStaticCtor) | |
RWBodyBase (const RWBodyBase &second) | |
virtual | ~RWBodyBase (void) |
RWBodyBase & | operator= (const RWBodyBase &second) |
Protected Member Functions inherited from RWTCountingBody< RWMutexLock > | |
~RWTCountingBody (void) | |
unsigned | addReference (void) |
unsigned | references (void) const |
unsigned | removeReference (void) |
RWTCountingBody (unsigned initCount=0) | |
RWTCountingBody (RWStaticCtor) | |
RWTCountingBody (const RWTCountingBody< RWMutexLock > &second) | |
RWTCountingBody< RWMutexLock > & | operator= (const RWTCountingBody< RWMutexLock > &second) |
Additional Inherited Members |
Abstract base class for all the narrow character input stream implementation classes. Implements the body idiom from the handle-body pattern.
|
inlinevirtual |
Destructor.
|
inlineprotected |
Constructor.
|
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 input operation after acquiring the synchronization mechanism.
Reimplemented in RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >.
|
pure virtual |
Reads a single narrow character from the stream.
Implemented in RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWCharFromStreambufInputStreamImp, and RWFilteredCharInputStreamImp.
Reads an array of narrow characters from the stream. The array must be pre-allocated to contain at least numChars elements. The function returns the actual number of narrow characters read from the stream.
charArray | A pointer to the first element of the array. |
numChars | The number of narrow characters to be read from the stream. |
Implemented in RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWCharFromStreambufInputStreamImp, and RWFilteredCharInputStreamImp.
|
pure virtual |
Reads narrow character(s) from the attached source stream until the last character read is equal to delim, or the end of the input sequence is reached. The narrow character(s) read are stored in a narrow string object.
string | A string object receiving the narrow character(s) extracted from the stream. |
delim | The narrow character used as a delimiter. |
Implemented in RWBufferedCharInputStreamImp, RWCharFromStreambufInputStreamImp, RWFilteredCharInputStreamImp, and RWSynchronizedCharInputStreamImp.
|
pure virtual |
Reads narrow character(s) from the attached source stream until the last narrow character read is equal to delim, or maxSize narrow character(s) have been read, or the end of the input sequence is reached. The narrow character(s) read are stored in charArray. The function returns the actual number of narrow character(s) read from the stream.
charArray | A pointer to the array receiving the narrow character(s) extracted from the stream. |
maxSize | The maximum number of narrow character(s) to be read. |
delim | The narrow character value used as a delimiter. |
Implemented in RWCharFromStreambufInputStreamImp, RWFilteredCharInputStreamImp, and RWSynchronizedCharInputStreamImp.
|
inlinevirtual |
Releases the synchronization mechanism provided by a stream concrete implementation.
Reimplemented in RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >.
Copyright © 2014 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.