XmlRpc::XmlRpcServer Class Reference

A class to handle XML RPC requests. More...

#include <XmlRpcServer.h>

Inheritance diagram for XmlRpc::XmlRpcServer:

Public Member Functions
	XmlRpcServer ()
	Create a server object.
virtual	~XmlRpcServer ()
	Destructor.
void	enableIntrospection (bool enabled=true)
	Specify whether introspection is enabled or not. Default is not enabled.
void	addMethod (XmlRpcServerMethod *method)
	Add a command to the RPC server.
void	removeMethod (XmlRpcServerMethod *method)
	Remove a command from the RPC server.
void	removeMethod (const std::string &methodName)
	Remove a command from the RPC server by name.
XmlRpcServerMethod *	findMethod (const std::string &name) const
	Look up a method by name.
bool	bindAndListen (int port, int backlog=5)
void	work (double msTime)
	Process client requests for the specified time.
void	exit ()
	Temporarily stop processing client requests and exit the work() method.
void	shutdown ()
	Close all connections with clients and the socket file descriptor.
void	listMethods (XmlRpcValue &result)
	Introspection support.
virtual unsigned	handleEvent (unsigned eventType)
	Handle client connection requests.
virtual void	removeConnection (XmlRpcServerConnection *)
	Remove a connection from the dispatcher.
Public Member Functions inherited from XmlRpc::XmlRpcSource
	XmlRpcSource (int fd=-1, bool deleteOnClose=false)
virtual	~XmlRpcSource ()
	Destructor.
int	getfd () const
	Return the file descriptor being monitored.
void	setfd (int fd)
	Specify the file descriptor to monitor.
bool	getKeepOpen () const
	Return whether the file descriptor should be kept open if it is no longer monitored.
void	setKeepOpen (bool b=true)
	Specify whether the file descriptor should be kept open if it is no longer monitored.
virtual void	close ()

Protected Types
typedef std::map< std::string, XmlRpcServerMethod * >	MethodMap

Protected Member Functions
virtual void	acceptConnection ()
	Accept a client connection request.
virtual XmlRpcServerConnection *	createConnection (int socket)
	Create a new connection object for processing requests from a specific client.

Protected Attributes
bool	_introspectionEnabled
XmlRpcDispatch	_disp
MethodMap	_methods
XmlRpcServerMethod *	_listMethods
XmlRpcServerMethod *	_methodHelp

Detailed Description

A class to handle XML RPC requests.

Definition at line 31 of file XmlRpcServer.h.

Member Typedef Documentation

MethodMap

typedef std::map<std::string, XmlRpcServerMethod*> XmlRpc::XmlRpcServer::MethodMap

protected

Definition at line 91 of file XmlRpcServer.h.

Constructor & Destructor Documentation

XmlRpcServer()

XmlRpcServer::XmlRpcServer

(

)

Create a server object.

Definition at line 11 of file XmlRpcServer.cpp.

                           {
  _introspectionEnabled = false;
  _listMethods          = 0;
  _methodHelp           = 0;
}

~XmlRpcServer()

XmlRpcServer::~XmlRpcServer ( )

virtual

Destructor.

Definition at line 17 of file XmlRpcServer.cpp.

                            {
  this->shutdown();
  _methods.clear();
  delete _listMethods;
  delete _methodHelp;
}

Member Function Documentation

acceptConnection()

void XmlRpcServer::acceptConnection ( )

protectedvirtual

Accept a client connection request.

Definition at line 124 of file XmlRpcServer.cpp.

                                    {
  int s = XmlRpcSocket::accept( this->getfd() );
  XmlRpcUtil::log( 2, "XmlRpcServer::acceptConnection: socket %d", s );
  if ( s < 0 )
  {
    // this->close();
    XmlRpcUtil::error( "XmlRpcServer::acceptConnection: Could not accept connection (%s).",
                       XmlRpcSocket::getErrorMsg().c_str() );
  }
  else if ( !XmlRpcSocket::setNonBlocking( s ) )
  {
    XmlRpcSocket::close( s );
    XmlRpcUtil::error( "XmlRpcServer::acceptConnection: Could not set socket to non-blocking "
                       "input mode (%s).",
                       XmlRpcSocket::getErrorMsg().c_str() );
  }
  else // Notify the dispatcher to listen for input on this source when we are in work()
  {
    XmlRpcUtil::log( 2, "XmlRpcServer::acceptConnection: creating a connection" );
    _disp.addSource( this->createConnection( s ), XmlRpcDispatch::ReadableEvent );
  }
}

Referenced by handleEvent().

addMethod()

void XmlRpcServer::addMethod

(

XmlRpcServerMethod *

method

)

Add a command to the RPC server.

Definition at line 25 of file XmlRpcServer.cpp.

                                                         {
  _methods[method->name()] = method;
}

Referenced by enableIntrospection().

bindAndListen()

bool XmlRpcServer::bindAndListen	(	int	port,
		int	backlog = 5 )

Create a socket, bind to the specified port, and set it in listen mode to make it available for clients.

Definition at line 50 of file XmlRpcServer.cpp.

                                                          {
  int fd = XmlRpcSocket::socket();
  if ( fd < 0 )
  {
    XmlRpcUtil::error( "XmlRpcServer::bindAndListen: Could not create socket (%s).",
                       XmlRpcSocket::getErrorMsg().c_str() );
    return false;
  }
 
  this->setfd( fd );
 
  // Don't block on reads/writes
  if ( !XmlRpcSocket::setNonBlocking( fd ) )
  {
    this->close();
    XmlRpcUtil::error(
        "XmlRpcServer::bindAndListen: Could not set socket to non-blocking input mode (%s).",
        XmlRpcSocket::getErrorMsg().c_str() );
    return false;
  }
 
  // Allow this port to be re-bound immediately so server re-starts are not delayed
  if ( !XmlRpcSocket::setReuseAddr( fd ) )
  {
    this->close();
    XmlRpcUtil::error(
        "XmlRpcServer::bindAndListen: Could not set SO_REUSEADDR socket option (%s).",
        XmlRpcSocket::getErrorMsg().c_str() );
    return false;
  }
 
  // Bind to the specified port on the default interface
  if ( !XmlRpcSocket::bind( fd, port ) )
  {
    this->close();
    XmlRpcUtil::error( "XmlRpcServer::bindAndListen: Could not bind to specified port (%s).",
                       XmlRpcSocket::getErrorMsg().c_str() );
    return false;
  }
 
  // Set in listening mode
  if ( !XmlRpcSocket::listen( fd, backlog ) )
  {
    this->close();
    XmlRpcUtil::error(
        "XmlRpcServer::bindAndListen: Could not set socket in listening mode (%s).",
        XmlRpcSocket::getErrorMsg().c_str() );
    return false;
  }
 
  XmlRpcUtil::log( 2, "XmlRpcServer::bindAndListen: server listening on port %d fd %d", port,
                   fd );
 
  // Notify the dispatcher to listen on this source when we are in work()
  _disp.addSource( this, XmlRpcDispatch::ReadableEvent );
 
  return true;
}

createConnection()

XmlRpcServerConnection * XmlRpcServer::createConnection ( int socket )

protectedvirtual

Create a new connection object for processing requests from a specific client.

Definition at line 148 of file XmlRpcServer.cpp.

                                                              {
  // Specify that the connection object be deleted when it is closed
  return new XmlRpcServerConnection( s, this, true );
}

Referenced by acceptConnection().

enableIntrospection()

void XmlRpcServer::enableIntrospection

(

bool

enabled = true

)

Specify whether introspection is enabled or not. Default is not enabled.

Definition at line 200 of file XmlRpcServer.cpp.

                                                     {
  if ( _introspectionEnabled == enabled ) return;
 
  _introspectionEnabled = enabled;
 
  if ( enabled )
  {
    if ( !_listMethods )
    {
      _listMethods = new ListMethods( this );
      _methodHelp  = new MethodHelp( this );
    }
    else
    {
      addMethod( _listMethods );
      addMethod( _methodHelp );
    }
  }
  else
  {
    removeMethod( LIST_METHODS );
    removeMethod( METHOD_HELP );
  }
}

exit()

void XmlRpcServer::exit

(

)

Temporarily stop processing client requests and exit the work() method.

Definition at line 156 of file XmlRpcServer.cpp.

{ _disp.exit(); }

findMethod()

XmlRpcServerMethod * XmlRpcServer::findMethod

(

const std::string &

name

)

const

Look up a method by name.

Definition at line 42 of file XmlRpcServer.cpp.

                                                                          {
  MethodMap::const_iterator i = _methods.find( name );
  if ( i == _methods.end() ) return 0;
  return i->second;
}

handleEvent()

unsigned XmlRpcServer::handleEvent ( unsigned eventType )

virtual

Handle client connection requests.

Implements XmlRpc::XmlRpcSource.

Definition at line 117 of file XmlRpcServer.cpp.

                                                  {
  acceptConnection();
  return XmlRpcDispatch::ReadableEvent; // Continue to monitor this fd
}

listMethods()

void XmlRpcServer::listMethods

(

XmlRpcValue &

result

)

Introspection support.

Definition at line 225 of file XmlRpcServer.cpp.

                                                    {
  int i = 0;
  result.setSize( _methods.size() + 1 );
  for ( MethodMap::iterator it = _methods.begin(); it != _methods.end(); ++it )
    result[i++] = it->first;
 
  // Multicall support is built into XmlRpcServerConnection
  result[i] = MULTICALL;
}

removeConnection()

void XmlRpcServer::removeConnection ( XmlRpcServerConnection * sc )

virtual

Remove a connection from the dispatcher.

Definition at line 153 of file XmlRpcServer.cpp.

{ _disp.removeSource( sc ); }

removeMethod() [1/2]

void XmlRpcServer::removeMethod

(

const std::string &

methodName

)

Remove a command from the RPC server by name.

Definition at line 36 of file XmlRpcServer.cpp.

                                                             {
  MethodMap::iterator i = _methods.find( methodName );
  if ( i != _methods.end() ) _methods.erase( i );
}

removeMethod() [2/2]

void XmlRpcServer::removeMethod

(

XmlRpcServerMethod *

method

)

Remove a command from the RPC server.

Definition at line 30 of file XmlRpcServer.cpp.

                                                            {
  MethodMap::iterator i = _methods.find( method->name() );
  if ( i != _methods.end() ) _methods.erase( i );
}

Referenced by enableIntrospection().

shutdown()

void XmlRpcServer::shutdown

(

)

Close all connections with clients and the socket file descriptor.

Definition at line 159 of file XmlRpcServer.cpp.

                            {
  // This closes and destroys all connections as well as closing this socket
  _disp.clear();
}

Referenced by ~XmlRpcServer().

work()

void XmlRpcServer::work

(

double

msTime

)

Process client requests for the specified time.

Definition at line 110 of file XmlRpcServer.cpp.

                                       {
  XmlRpcUtil::log( 2, "XmlRpcServer::work: waiting for a connection" );
  _disp.work( msTime );
}

Member Data Documentation

_disp

XmlRpcDispatch XmlRpc::XmlRpcServer::_disp

protected

Definition at line 88 of file XmlRpcServer.h.

Referenced by acceptConnection(), bindAndListen(), exit(), removeConnection(), shutdown(), and work().

_introspectionEnabled

bool XmlRpc::XmlRpcServer::_introspectionEnabled

protected

Definition at line 85 of file XmlRpcServer.h.

Referenced by enableIntrospection(), and XmlRpcServer().

_listMethods

XmlRpcServerMethod* XmlRpc::XmlRpcServer::_listMethods

protected

Definition at line 95 of file XmlRpcServer.h.

Referenced by enableIntrospection(), XmlRpcServer(), and ~XmlRpcServer().

_methodHelp

XmlRpcServerMethod* XmlRpc::XmlRpcServer::_methodHelp

protected

Definition at line 96 of file XmlRpcServer.h.

Referenced by enableIntrospection(), XmlRpcServer(), and ~XmlRpcServer().

_methods

MethodMap XmlRpc::XmlRpcServer::_methods

protected

Definition at line 92 of file XmlRpcServer.h.

Referenced by addMethod(), findMethod(), listMethods(), removeMethod(), removeMethod(), and ~XmlRpcServer().

---

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

• XmlRpcServer.h
• XmlRpcServer.cpp