RWByteInputStreamImp

Module:  Advanced Tools   Package:  Streams

RWByteInputStreamImp  RWInputStreamImp  RWStreamImp  RWBodyBase

• Local Index
• Header File
• Description
• Protected Constructor
• Public Destructor
• Public Member Functions

Members

acquire() read()

readUntil() release()

RWByteInputStreamImp() ~RWByteInputStreamImp()

#include <rw/stream/RWByteInputStreamImp.h>

Abstract base class for all the binary input stream implementation classes. Implements the body idiom from the handle-body pattern.

RWByteInputStreamImp();

Constructor.

virtual 
~RWByteInputStreamImp();

Destructor.

virtual RWByteInputStream 
acquire();

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 input operation after acquiring the synchronization mechanism.

virtual RWByte 
read() =0;

Reads a single byte from the stream.

virtual RWSize 
read(RWByte* byteArray, RWSize numBytes) =0;

Reads an array of bytes from the stream. The array must be pre-allocated to contain at list of numBytes elements. The function returns the actual number of bytes read from the stream.

Parameter List

byteArray	A pointer to the first element of the array.
numBytes	The number of bytes to be read from the stream.

virtual RWSize 
readUntil(RWByte* byteArray, RWSize maxSize, RWByte delim) =0;

Reads bytes from the stream until the last byte read is equal to delim, or maxSize bytes have been read, or the end of the input sequence is reached. The bytes read are stored in byteArray. The function returns the actual number of bytes read from the stream.

Parameter List

byteArray	A pointer to the array receiving the bytes extracted from the stream.
maxSize	The maximum number of bytes to be read.
delim	The byte value used as a delimiter.

virtual void 
release();

Releases the synchronization mechanism provided by a stream concrete implementation.

© Copyright 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.
Contact Rogue Wave about documentation or support issues.