iodrivers_base::FDStream Class Reference

#include <IOStream.hpp>

Inheritance diagram for iodrivers_base::FDStream:

Public Member Functions
	FDStream (int fd, bool auto_close)
virtual	~FDStream ()
virtual void	waitRead (base::Time const &timeout)
virtual void	waitWrite (base::Time const &timeout)
virtual size_t	read (uint8_t *buffer, size_t buffer_size)
virtual size_t	write (uint8_t const *buffer, size_t buffer_size)
virtual void	clear ()
bool	setNonBlockingFlag (int fd)
virtual int	getFileDescriptor () const
Public Member Functions inherited from iodrivers_base::IOStream
virtual	~IOStream ()

Static Public Attributes
static const int	INVALID_FD = -1

Protected Attributes
int	m_fd

Detailed Description

Implementation of IOStream for file descriptors

Constructor & Destructor Documentation

FDStream()

FDStream::FDStream	(	int	fd,
		bool	auto_close
	)

~FDStream()

FDStream::~FDStream ( )

virtual

Member Function Documentation

clear()

void FDStream::clear ( )

virtual

Implements iodrivers_base::IOStream.

getFileDescriptor()

int FDStream::getFileDescriptor ( ) const

virtual

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

The default implementation returns INVALID_FD

Reimplemented from iodrivers_base::IOStream.

read()

size_t FDStream::read ( uint8_t *  buffer, size_t  buffer_size  )

virtual

Implements iodrivers_base::IOStream.

Reimplemented in iodrivers_base::UDPServerStream.

setNonBlockingFlag()

bool FDStream::setNonBlockingFlag

(

int

fd

)

Sets the NONBLOCK flag on the given file descriptor and returns true if the file descriptor was in blocking mode

waitRead()

void FDStream::waitRead ( base::Time const &  timeout )

virtual

Implements iodrivers_base::IOStream.

waitWrite()

void FDStream::waitWrite ( base::Time const &  timeout )

virtual

Implements iodrivers_base::IOStream.

write()

size_t FDStream::write ( uint8_t const *  buffer, size_t  buffer_size  )

virtual

Implements iodrivers_base::IOStream.

Reimplemented in iodrivers_base::UDPServerStream.

Member Data Documentation

INVALID_FD

const int iodrivers_base::FDStream::INVALID_FD = -1

static

m_fd

int iodrivers_base::FDStream::m_fd

protected

---

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

• /build/rock-master-18.09-drivers-iodrivers-base-0.20170901/src/IOStream.hpp
• /build/rock-master-18.09-drivers-iodrivers-base-0.20170901/src/IOStream.cpp