VMime
inputStreamSocketAdapter Class Reference

#include <inputStreamSocketAdapter.hpp>

Inheritance diagram for inputStreamSocketAdapter:
Collaboration diagram for inputStreamSocketAdapter:

Public Member Functions

 inputStreamSocketAdapter (net::socket &sok)
bool eof () const
void reset ()
size_t read (byte_t *const data, const size_t count)
size_t skip (const size_t count)
size_t getBlockSize ()
Public Member Functions inherited from stream
virtual ~stream ()

Additional Inherited Members

Protected Member Functions inherited from object
 object ()
 object (const object &)
objectoperator= (const object &)
virtual ~object ()

Detailed Description

An input stream that is connected to a socket.

Constructor & Destructor Documentation

◆ inputStreamSocketAdapter()

inputStreamSocketAdapter ( net::socket & sok)

Member Function Documentation

◆ eof()

bool eof ( ) const
virtual

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

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

Implements inputStream.

◆ getBlockSize()

size_t getBlockSize ( )
virtual

Return the preferred maximum block size when reading from or writing to this stream.

Returns
block size, in bytes

Reimplemented from stream.

◆ read()

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

Read data from the stream.

Parameters
datawill receive the data read
countmaximum number of bytes to read
Returns
number of bytes read

Implements inputStream.

References vmime::count().

◆ reset()

void reset ( )
virtual

Set the read pointer to the beginning of the stream.

Warning
WARNING: this may not work for all stream types.

Implements inputStream.

◆ skip()

size_t skip ( const size_t count)
virtual

Skip a number of bytes.

Parameters
countmaximum number of bytes to ignore
Returns
number of bytes skipped

Implements inputStream.


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