mermaid::support::io::StreamReader Class Reference

StreamReader class. More...

#include <StreamReader.hpp>

Collaboration diagram for mermaid::support::io::StreamReader:

[legend]

List of all members.

Public Member Functions
virtual void	doRead ()
	Executes a read operation.
virtual int	getFileDescriptor () const
	File descriptor getter.
virtual void	onRead (size_t bytesRead, size_t requestedBytesRead, const char *data, bool success)
	This method will be called by StreamHandler each time a read event occurs.
virtual void	open (ACE_Handler *streamHandler, ACE_Proactor *proactor)
	Opens the device for reading.
	StreamReader (Device *device)
	Constructor.
virtual	~StreamReader ()
	Destructor.

---

Detailed Description

StreamReader class.

The class which ultimately executes the read operations

Author:

Joao Carreira

Definition at line 45 of file StreamReader.hpp.

---

Constructor & Destructor Documentation

StreamReader::StreamReader

(

Device *

device

)

Constructor.

Parameters:

device

The device on which the read operations will be executed

Author:

Joao Carreira

Definition at line 40 of file StreamReader.cpp.

StreamReader::~StreamReader

(

)

[virtual]

Destructor.

Author:

Joao Carreira

Definition at line 35 of file StreamReader.cpp.

---

Member Function Documentation

void StreamReader::doRead

(

)

[virtual]

Executes a read operation.

Author:

Joao Carreira

Definition at line 57 of file StreamReader.cpp.

virtual int mermaid::support::io::StreamReader::getFileDescriptor

(

)

const [inline, virtual]

File descriptor getter.

Returns:

The file descriptor

Author:

Joao Carreira

Definition at line 90 of file StreamReader.hpp.

void StreamReader::onRead	(	size_t	bytesRead,
		size_t	requestedBytesRead,
		const char *	data,
		bool	success
	)			[virtual]

This method will be called by StreamHandler each time a read event occurs.

Parameters:

	bytesRead	The number of bytes read
	requestedBytesRead	The number of bytes requested to be read
	data	The data read from the device
	success	TRUE if the read operation was successful, FALSE otherwise

Author:

Joao Carreira

Definition at line 44 of file StreamReader.cpp.

void StreamReader::open	(	ACE_Handler *	streamHandler,
		ACE_Proactor *	proactor
	)			[virtual]

Opens the device for reading.

Parameters:

	streamHandler	The StreamHandler which handles io results
	proactor	The proactor instance which will be "in charge" of this StreamReader

Author:

Joao Carreira

Definition at line 50 of file StreamReader.cpp.