CSMonitorFD Class Reference

Class to tie sockets to for monitoring by Csocket at either the Csock or TSockManager. More...

#include <Csocket.h>

Collaboration diagram for CSMonitorFD:

Public Member Functions
	CSMonitorFD ()
virtual	~CSMonitorFD ()
virtual bool	GatherFDsForSelect (std::map< cs_sock_t, short > &miiReadyFds, long &iTimeoutMS)
	called before select, typically you don't need to reimplement this just add sockets via Add and let the default implementation have its way
virtual bool	FDsThatTriggered (const std::map< cs_sock_t, short > &miiReadyFds)
	called when there are fd's belonging to this class that have triggered
virtual bool	CheckFDs (const std::map< cs_sock_t, short > &miiReadyFds)
	gets called to diff miiReadyFds with m_miiMonitorFDs, and calls FDsThatTriggered when appropriate.
void	Add (cs_sock_t iFD, short iMonitorEvents)
	adds a file descriptor to be monitored
void	Remove (cs_sock_t iFD)
	removes this fd from monitoring
void	DisableMonitor ()
	causes this monitor to be removed
bool	IsEnabled () const

Protected Attributes
std::map< cs_sock_t, short >	m_miiMonitorFDs
bool	m_bEnabled

Detailed Description

Class to tie sockets to for monitoring by Csocket at either the Csock or TSockManager.

Constructor & Destructor Documentation

CSMonitorFD()

CSMonitorFD::CSMonitorFD ( )

inline

References m_bEnabled.

~CSMonitorFD()

virtual CSMonitorFD::~CSMonitorFD ( )

inlinevirtual

Member Function Documentation

Add()

void CSMonitorFD::Add ( cs_sock_t iFD, short iMonitorEvents )

inline

adds a file descriptor to be monitored

Parameters

iFD	the file descriptor
iMonitorEvents	bitset of events to monitor for (

See also

CSockManager::ECheckType)

References m_miiMonitorFDs.

CheckFDs()

virtual bool CSMonitorFD::CheckFDs ( const std::map< cs_sock_t, short > & miiReadyFds )

virtual

gets called to diff miiReadyFds with m_miiMonitorFDs, and calls FDsThatTriggered when appropriate.

Typically you don't need to reimplement this.

Parameters

miiReadyFds

the map of all triggered fd's, not just the fd's from this class

Returns

returning false will remove this from monitoring

DisableMonitor()

void CSMonitorFD::DisableMonitor ( )

inline

causes this monitor to be removed

References m_bEnabled.

FDsThatTriggered()

virtual bool CSMonitorFD::FDsThatTriggered ( const std::map< cs_sock_t, short > & miiReadyFds )

inlinevirtual

called when there are fd's belonging to this class that have triggered

Parameters

miiReadyFds

the map of fd's with the bits that triggered them (

See also

CSockManager::ECheckType)

Returns

returning false will remove this from monitoring

GatherFDsForSelect()

virtual bool CSMonitorFD::GatherFDsForSelect ( std::map< cs_sock_t, short > & miiReadyFds, long & iTimeoutMS )

virtual

called before select, typically you don't need to reimplement this just add sockets via Add and let the default implementation have its way

Parameters

miiReadyFds

fill with fd's to monitor and the associated bit to check them for (

See also

CSockManager::ECheckType)

Parameters

iTimeoutMS

the timeout to change to, setting this to -1 (the default)

Returns

returning false will remove this from monitoring. The same effect can be had by setting m_bEnabled to false as it is returned from this

IsEnabled()

bool CSMonitorFD::IsEnabled ( ) const

inline

References m_bEnabled.

Remove()

void CSMonitorFD::Remove ( cs_sock_t iFD )

inline

removes this fd from monitoring

References m_miiMonitorFDs.

Member Data Documentation

m_bEnabled

bool CSMonitorFD::m_bEnabled

protected

Referenced by CSMonitorFD(), DisableMonitor(), and IsEnabled().

m_miiMonitorFDs

std::map< cs_sock_t, short > CSMonitorFD::m_miiMonitorFDs

protected

Referenced by Add(), and Remove().

---

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

• Csocket.h