#include <IOStream.hpp>

Inheritance diagram for iodrivers_base::IOStream:

Public Member Functions
virtual	~IOStream ()

virtual void	waitRead (base::Time const &timeout)=0

virtual void	waitWrite (base::Time const &timeout)=0

virtual size_t	read (uint8_t *buffer, size_t buffer_size)=0

virtual size_t	write (uint8_t const *buffer, size_t buffer_size)=0

virtual void	clear ()=0

virtual int	getFileDescriptor () const

Detailed Description

Generic IO handler that allows to wait, read and write to an IO stream

We're not using the default std::iostream interface as it is quite complicated, and the Driver class really needs little

Constructor & Destructor Documentation

IOStream::~IOStream ( )

virtual

virtual void iodrivers_base::IOStream::clear ( )

pure virtual

int IOStream::getFileDescriptor ( ) const

virtual

If this IOStream is attached to a file descriptor, return it. Otherwise, returns INVALID_FD;

The default implementation returns INVALID_FD

virtual size_t iodrivers_base::IOStream::read	(	uint8_t *	buffer,
		size_t	buffer_size
	)

pure virtual

virtual void iodrivers_base::IOStream::waitRead ( base::Time const & timeout )

pure virtual

virtual void iodrivers_base::IOStream::waitWrite ( base::Time const & timeout )

pure virtual

virtual size_t iodrivers_base::IOStream::write	(	uint8_t const *	buffer,
		size_t	buffer_size
	)

pure virtual

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