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

#include <unix-fd-reader.h>

Inheritance diagram for ns3::FdReader:

Collaboration diagram for ns3::FdReader:

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

Public Member Functions
	FdReader ()

virtual	~FdReader ()

void	Start (int fd, Callback< void, uint8_t *, ssize_t > readCallback)
	Start a new read thread. More...

void	Stop (void)
	Stop the read thread and reset internal state. More...

Public Member Functions inherited from ns3::SimpleRefCount< FdReader >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

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)
	Noop. More...

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.

Constructor & Destructor Documentation

ns3::FdReader::FdReader ( )

Definition at line 39 of file unix-fd-reader.cc.

References m_evpipe, and NS_LOG_FUNCTION.

ns3::FdReader::~FdReader ( )

virtual

Definition at line 48 of file unix-fd-reader.cc.

References NS_LOG_FUNCTION, and Stop().

Here is the call graph for this function:

Member Function Documentation

void ns3::FdReader::DestroyEvent ( void )

private

Definition at line 106 of file unix-fd-reader.cc.

References NS_LOG_FUNCTION, Stop(), and ns3::SimpleRefCount< FdReader >::Unref().

Referenced by Start().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protectedpure virtual

The read implementation.

Internal:: 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.