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

Public Member Functions
	XmlRpcDispatch ()
	Constructor.
	~XmlRpcDispatch ()
void	addSource (XmlRpcSource *source, unsigned eventMask)
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)
void	exit ()
	Exit from work routine.
void	clear ()
	Clear all sources from the monitored sources list. Sources are closed.

Protected Types
typedef std::list< MonitoredSource >	SourceList

Protected Member Functions
double	getTime ()

Protected Attributes
SourceList	_sources
double	_endTime
bool	_doClear
bool	_inWork

Detailed Description

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

Definition at line 22 of file XmlRpcDispatch.h.

Member Typedef Documentation

SourceList

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

protected

Definition at line 74 of file XmlRpcDispatch.h.

Member Enumeration Documentation

EventType

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 29 of file XmlRpcDispatch.h.

                   {
      ReadableEvent = 1,    //!< data available to read
      WritableEvent = 2,    //!< connected/data can be written without blocking
      Exception     = 4     //!< uh oh
    };

Constructor & Destructor Documentation

XmlRpcDispatch()

XmlRpcDispatch::XmlRpcDispatch

(

)

Constructor.

Definition at line 26 of file XmlRpcDispatch.cpp.

{
  _endTime = -1.0;
  _doClear = false;
  _inWork = false;
}

~XmlRpcDispatch()

XmlRpcDispatch::~XmlRpcDispatch

(

)

Definition at line 34 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.

Parameters

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

See also

EventType

Definition at line 41 of file XmlRpcDispatch.cpp.

{
  _sources.push_back(MonitoredSource(source, mask));
}

Referenced by XmlRpc::XmlRpcServer::acceptConnection(), XmlRpc::XmlRpcServer::bindAndListen(), and XmlRpc::XmlRpcClient::setupConnection().

clear()

void XmlRpcDispatch::clear

(

)

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

Definition at line 180 of file XmlRpcDispatch.cpp.

{
  if (_inWork)
    _doClear = true;  // Finish reporting current events before clearing
  else
  {
    SourceList closeList = _sources;
    _sources.clear();
    for (SourceList::iterator it=closeList.begin(); it!=closeList.end(); ++it)
      it->getSource()->close();
  }
}

Referenced by XmlRpc::XmlRpcServer::shutdown().

exit()

void XmlRpcDispatch::exit

(

)

Exit from work routine.

Definition at line 173 of file XmlRpcDispatch.cpp.

{
  _endTime = 0.0;   // Return from work asap
}

Referenced by XmlRpc::XmlRpcClient::close(), and XmlRpc::XmlRpcServer::exit().

getTime()

double XmlRpcDispatch::getTime ( )

protected

Definition at line 195 of file XmlRpcDispatch.cpp.

{
#ifdef USE_FTIME
  struct timeb  tbuff;
 
  ftime(&tbuff);
  return ((double) tbuff.time + ((double)tbuff.millitm / 1000.0) +
      ((double) tbuff.timezone * 60));
#else
  struct timeval    tv;
  struct timezone   tz;
 
  gettimeofday(&tv, &tz);
  return (tv.tv_sec + tv.tv_usec / 1000000.0);
#endif /* USE_FTIME */
}

Referenced by work().

removeSource()

void XmlRpcDispatch::removeSource

(

XmlRpcSource *

source

)

Stop monitoring this source.

Parameters

source

The source to stop monitoring

Definition at line 48 of file XmlRpcDispatch.cpp.

{
  for (SourceList::iterator it=_sources.begin(); it!=_sources.end(); ++it)
    if (it->getSource() == source)
    {
      _sources.erase(it);
      break;
    }
}

Referenced by XmlRpc::XmlRpcClient::close(), XmlRpc::XmlRpcServer::removeConnection(), and XmlRpc::XmlRpcClient::setupConnection().

setSourceEvents()

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.

{
  for (SourceList::iterator it=_sources.begin(); it!=_sources.end(); ++it)
    if (it->getSource() == source)
    {
      it->getMask() = eventMask;
      break;
    }
}

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

{
  // Compute end time
  _endTime = (timeout < 0.0) ? -1.0 : (getTime() + timeout);
  _doClear = false;
  _inWork = true;
 
  // Only work while there is something to monitor
  while (_sources.size() > 0) {
 
    // Construct the sets of descriptors we are interested in
    fd_set inFd, outFd, excFd;
      FD_ZERO(&inFd);
      FD_ZERO(&outFd);
      FD_ZERO(&excFd);
 
    int maxFd = -1;     // Not used on windows
    SourceList::iterator it;
    for (it=_sources.begin(); it!=_sources.end(); ++it) {
      int fd = it->getSource()->getfd();
      if (it->getMask() & ReadableEvent) FD_SET(fd, &inFd);
      if (it->getMask() & WritableEvent) FD_SET(fd, &outFd);
      if (it->getMask() & Exception)     FD_SET(fd, &excFd);
      if (it->getMask() && fd > maxFd)   maxFd = fd;
    }
 
    // Check for events
    int nEvents;
    if (timeout < 0.0)
      nEvents = select(maxFd+1, &inFd, &outFd, &excFd, NULL);
    else 
    {
      struct timeval tv;
      tv.tv_sec = (int)floor(timeout);
      tv.tv_usec = ((int)floor(1000000.0 * (timeout-floor(timeout)))) % 1000000;
      nEvents = select(maxFd+1, &inFd, &outFd, &excFd, &tv);
    }
 
    if (nEvents < 0)
    {
      XmlRpcUtil::error("Error in XmlRpcDispatch::work: error in select (%d).", nEvents);
      _inWork = false;
      return;
    }
 
    // Process events
    for (it=_sources.begin(); it != _sources.end(); )
    {
      SourceList::iterator thisIt = it++;
      XmlRpcSource* src = thisIt->getSource();
      int fd = src->getfd();
      unsigned newMask = (unsigned) -1;
      if (fd <= maxFd) {
        // If you select on multiple event types this could be ambiguous
        if (FD_ISSET(fd, &inFd))
          newMask &= src->handleEvent(ReadableEvent);
        if (FD_ISSET(fd, &outFd))
          newMask &= src->handleEvent(WritableEvent);
        if (FD_ISSET(fd, &excFd))
          newMask &= src->handleEvent(Exception);
 
        if ( ! newMask) {
          _sources.erase(thisIt);  // Stop monitoring this one
          if ( ! src->getKeepOpen())
            src->close();
        } else if (newMask != (unsigned) -1) {
          thisIt->getMask() = newMask;
        }
      }
    }
 
    // Check whether to clear all sources
    if (_doClear)
    {
      SourceList closeList = _sources;
      _sources.clear();
      for (SourceList::iterator it=closeList.begin(); it!=closeList.end(); ++it) {
    XmlRpcSource *src = it->getSource();
        src->close();
      }
 
      _doClear = false;
    }
 
    // Check whether end time has passed
    if (0 <= _endTime && getTime() > _endTime){
      std::cout<< "XmlRpc :  time out when connect to database  " << std::endl;//yzhang debug
      break;
    }
  }
 
  _inWork = false;
}

Referenced by XmlRpc::XmlRpcClient::execute(), and XmlRpc::XmlRpcServer::work().

Member Data Documentation

_doClear

bool XmlRpc::XmlRpcDispatch::_doClear

protected

Definition at line 82 of file XmlRpcDispatch.h.

Referenced by clear(), work(), and XmlRpcDispatch().

_endTime

double XmlRpc::XmlRpcDispatch::_endTime

protected

Definition at line 80 of file XmlRpcDispatch.h.

Referenced by exit(), work(), and XmlRpcDispatch().

_inWork

bool XmlRpc::XmlRpcDispatch::_inWork

protected

Definition at line 83 of file XmlRpcDispatch.h.

Referenced by clear(), work(), and XmlRpcDispatch().

_sources

SourceList XmlRpc::XmlRpcDispatch::_sources

protected

Definition at line 77 of file XmlRpcDispatch.h.

Referenced by addSource(), clear(), removeSource(), setSourceEvents(), and work().

---

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

• XmlRpcDispatch.h
• XmlRpcDispatch.cpp