A class that asynchronously reads from a file descriptor. More...

#include <unix-fd-reader.h>

Inheritance diagram for ns3::FdReader:

Classes
struct	Data
	A structure representing data read. More...

Public Member Functions
void	Start (int fd, Callback< void, uint8_t *, ssize_t > readCallback)

void	Stop (void)

Public Member Functions inherited from ns3::SimpleRefCount< FdReader >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Protected Member Functions
virtual FdReader::Data	DoRead (void)=0
	The read implementation. More...

Protected Attributes
int	m_fd
	The file descriptor to read from. More...

Private Member Functions
void	DestroyEvent (void)

void	Run (void)

Private Attributes
EventId	m_destroyEvent

int	m_evpipe [2]

Callback< void, uint8_t *, ssize_t >	m_readCallback

Ptr< SystemThread >	m_readThread

bool	m_stop

Additional Inherited Members
Static Public Member Functions inherited from ns3::SimpleRefCount< FdReader >
static void	Cleanup (void)

Detailed Description

A class that asynchronously reads from a file descriptor.

This class can be used to start a system thread that reads from a given file descriptor and invokes a given callback when data is received. This class handles thread management automatically but the DoRead() method must be implemented by a subclass.

Definition at line 40 of file unix-fd-reader.h.

Member Function Documentation

virtual FdReader::Data ns3::FdReader::DoRead ( void )

protectedpure virtual

The read implementation.

The value of m_len returned controls further processing. The callback function is only invoked when m_len is positive; any data read is not processed when m_len is negative; reading stops when m_len is zero.

The management of memory associated with m_buf must be compatible with the read callback.