XmlRpc::XmlRpcDispatch Class Reference

#include <XmlRpcDispatch.h>

Classes
struct	MonitoredSource
Public Types
enum	EventType { ReadableEvent = 1, WritableEvent = 2, Exception = 4 }
	Values indicating the type of events a source is interested in. More...
typedef std::list < MonitoredSource >	SourceList
Public Member Functions
void	addSource (XmlRpcSource *source, unsigned eventMask)
void	clear ()
	Clear all sources from the monitored sources list. Sources are closed.
void	exit ()
	Exit from work routine.
double	getTime ()
void	removeSource (XmlRpcSource *source)
void	setSourceEvents (XmlRpcSource *source, unsigned eventMask)
	Modify the types of events to watch for on this source.
void	work (double msTime)
	XmlRpcDispatch ()
	Constructor.
	~XmlRpcDispatch ()
Public Attributes
SourceList	_sources
Protected Attributes
bool	_doClear
double	_endTime
bool	_inWork

Detailed Description

An object which monitors file descriptors for events and performs callbacks when interesting events happen.

Definition at line 24 of file XmlRpcDispatch.h.

Member Typedef Documentation

typedef std::list< MonitoredSource > XmlRpc::XmlRpcDispatch::SourceList

Definition at line 74 of file XmlRpcDispatch.h.

Member Enumeration Documentation

enum XmlRpc::XmlRpcDispatch::EventType

Values indicating the type of events a source is interested in.

Enumerator:

ReadableEvent	data available to read
WritableEvent	connected/data can be written without blocking
Exception	uh oh

Definition at line 31 of file XmlRpcDispatch.h.

Constructor & Destructor Documentation

XmlRpcDispatch::XmlRpcDispatch ( )

Constructor.

Definition at line 26 of file XmlRpcDispatch.cpp.

XmlRpcDispatch::~XmlRpcDispatch ( )

Definition at line 34 of file XmlRpcDispatch.cpp.

Member Function Documentation

void XmlRpcDispatch::addSource	(	XmlRpcSource *	source,
		unsigned	eventMask
	)

Monitor this source for the event types specified by the event mask and call its event handler when any of the events occur.

Parameters:

	source	The source to monitor
	eventMask	Which event types to watch for.

See also:: EventType

Definition at line 41 of file XmlRpcDispatch.cpp.

void XmlRpcDispatch::clear ( )

Clear all sources from the monitored sources list. Sources are closed.

Definition at line 193 of file XmlRpcDispatch.cpp.

void XmlRpcDispatch::exit ( )

Exit from work routine.

Definition at line 186 of file XmlRpcDispatch.cpp.

double XmlRpcDispatch::getTime ( )

Definition at line 208 of file XmlRpcDispatch.cpp.

void XmlRpcDispatch::removeSource ( XmlRpcSource * source )

Stop monitoring this source.

Parameters:

source

The source to stop monitoring

Definition at line 48 of file XmlRpcDispatch.cpp.

void XmlRpcDispatch::setSourceEvents	(	XmlRpcSource *	source,
		unsigned	eventMask
	)

Modify the types of events to watch for on this source.

Definition at line 61 of file XmlRpcDispatch.cpp.

void XmlRpcDispatch::work ( double msTime )

Watch current set of sources and process events for the specified duration (in ms, -1 implies wait forever, or until exit is called)

Definition at line 75 of file XmlRpcDispatch.cpp.

Member Data Documentation

bool XmlRpc::XmlRpcDispatch::_doClear [protected]

Definition at line 83 of file XmlRpcDispatch.h.

double XmlRpc::XmlRpcDispatch::_endTime [protected]

Definition at line 81 of file XmlRpcDispatch.h.

bool XmlRpc::XmlRpcDispatch::_inWork [protected]

Definition at line 84 of file XmlRpcDispatch.h.

SourceList XmlRpc::XmlRpcDispatch::_sources

Definition at line 77 of file XmlRpcDispatch.h.

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

XmlRpc::XmlRpcDispatch Class Reference

Classes

Public Types

Public Member Functions