Classes | Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
XmlRpc::XmlRpcDispatch Class Reference

#include <XmlRpcDispatch.h>


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< MonitoredSourceSourceList

Public Member Functions

void addSource (XmlRpcSource *source, unsigned eventMask)
void clear ()
 Clear all sources from the monitored sources list. Sources are closed. More...
void exit ()
 Exit from work routine. More...
double getTime ()
void removeSource (XmlRpcSource *source)
void setSourceEvents (XmlRpcSource *source, unsigned eventMask)
 Modify the types of events to watch for on this source. More...
void work (double msTime)
 XmlRpcDispatch ()
 Constructor. More...
 ~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 25 of file XmlRpcDispatch.h.

Member Typedef Documentation

◆ SourceList

Definition at line 75 of file XmlRpcDispatch.h.

Member Enumeration Documentation

◆ EventType

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


data available to read


connected/data can be written without blocking


out-of-band data has arrived

Definition at line 32 of file XmlRpcDispatch.h.

Constructor & Destructor Documentation

◆ XmlRpcDispatch()

XmlRpcDispatch::XmlRpcDispatch ( )


Definition at line 81 of file XmlRpcDispatch.cpp.

◆ ~XmlRpcDispatch()

XmlRpcDispatch::~XmlRpcDispatch ( )

Definition at line 89 of file XmlRpcDispatch.cpp.

Member Function Documentation

◆ addSource()

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.

sourceThe source to monitor
eventMaskWhich event types to watch for.
See also

Definition at line 96 of file XmlRpcDispatch.cpp.

◆ clear()

void XmlRpcDispatch::clear ( )

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

Definition at line 260 of file XmlRpcDispatch.cpp.

◆ exit()

void XmlRpcDispatch::exit ( )

Exit from work routine.

Definition at line 253 of file XmlRpcDispatch.cpp.

◆ getTime()

double XmlRpcDispatch::getTime ( )

Definition at line 275 of file XmlRpcDispatch.cpp.

◆ removeSource()

void XmlRpcDispatch::removeSource ( XmlRpcSource source)

Stop monitoring this source.

sourceThe source to stop monitoring

Definition at line 103 of file XmlRpcDispatch.cpp.

◆ setSourceEvents()

void XmlRpcDispatch::setSourceEvents ( XmlRpcSource source,
unsigned  eventMask 

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

Definition at line 116 of file XmlRpcDispatch.cpp.

◆ work()

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 130 of file XmlRpcDispatch.cpp.

Member Data Documentation

◆ _doClear

bool XmlRpc::XmlRpcDispatch::_doClear

Definition at line 84 of file XmlRpcDispatch.h.

◆ _endTime

double XmlRpc::XmlRpcDispatch::_endTime

Definition at line 82 of file XmlRpcDispatch.h.

◆ _inWork

bool XmlRpc::XmlRpcDispatch::_inWork

Definition at line 85 of file XmlRpcDispatch.h.

◆ _sources

SourceList XmlRpc::XmlRpcDispatch::_sources

Definition at line 78 of file XmlRpcDispatch.h.

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

Author(s): Chris Morley, Konstantin Pilipchuk, Morgan Quigley, Austin Hendrix, Dirk Thomas , Jacob Perron
autogenerated on Thu Nov 23 2023 04:01:41