inputStream Class Reference

#include <inputStream.hpp>

Inheritance diagram for inputStream:

Collaboration diagram for inputStream:

Public Member Functions
virtual bool	eof () const =0
virtual void	reset ()=0
virtual size_t	read (byte_t *const data, const size_t count)=0
virtual size_t	skip (const size_t count)=0
Public Member Functions inherited from stream
virtual	~stream ()
virtual size_t	getBlockSize ()

Additional Inherited Members
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

Simple input stream.

Member Function Documentation

eof()

virtual bool eof ( ) const

pure virtual

Test for end of stream (no more data to read).

Returns

true if we have reached the end of stream, false otherwise

Implemented in dotFilteredInputStream, stopSequenceFilteredInputStream< COUNT >, inputStreamAdapter, inputStreamByteBufferAdapter, inputStreamSocketAdapter, inputStreamStringAdapter, inputStreamStringProxyAdapter, parserInputStreamAdapter, and seekableInputStreamRegionAdapter.

Referenced by IMAPFolder::addMessage(), and dotFilteredInputStream::eof().

read()

virtual size_t read ( byte_t *const  data, const size_t  count  )

pure virtual

Read data from the stream.

Parameters

data	will receive the data read
count	maximum number of bytes to read

Returns

number of bytes read

Implemented in stopSequenceFilteredInputStream< COUNT >, dotFilteredInputStream, stopSequenceFilteredInputStream< COUNT >, stopSequenceFilteredInputStream< COUNT >, inputStreamAdapter, inputStreamByteBufferAdapter, inputStreamSocketAdapter, inputStreamStringAdapter, inputStreamStringProxyAdapter, parserInputStreamAdapter, and seekableInputStreamRegionAdapter.

Referenced by IMAPFolder::addMessage(), and dotFilteredInputStream::read().

reset()

virtual void reset ( )

pure virtual

Set the read pointer to the beginning of the stream.

Warning

WARNING: this may not work for all stream types.

Implemented in dotFilteredInputStream, stopSequenceFilteredInputStream< COUNT >, inputStreamAdapter, inputStreamByteBufferAdapter, inputStreamSocketAdapter, inputStreamStringAdapter, inputStreamStringProxyAdapter, parserInputStreamAdapter, and seekableInputStreamRegionAdapter.

Referenced by dotFilteredInputStream::reset().

skip()

virtual size_t skip ( const size_t  count )

pure virtual

Skip a number of bytes.

Parameters

count

maximum number of bytes to ignore

Returns

number of bytes skipped

Implemented in dotFilteredInputStream, inputStreamAdapter, inputStreamByteBufferAdapter, inputStreamSocketAdapter, inputStreamStringAdapter, inputStreamStringProxyAdapter, parserInputStreamAdapter, seekableInputStreamRegionAdapter, and stopSequenceFilteredInputStream< COUNT >.

---

The documentation for this class was generated from the following file:

• inputStream.hpp