XmlRpc::XmlRpcServerMethod Class Reference

Abstract class representing a single RPC method. More...

#include <XmlRpcServerMethod.h>

Inheritance diagram for XmlRpc::XmlRpcServerMethod:

Public Member Functions
	XmlRpcServerMethod (std::string const &name, XmlRpcServer *server=0)
	Constructor.
virtual	~XmlRpcServerMethod ()
	Destructor.
std::string &	getName ()
	Returns the name of the method.
virtual void	execute (XmlRpcValue &params, XmlRpcValue &result)=0
	Execute the method. Subclasses must provide a definition for this method.
virtual std::string	help ()
	Returns a help string for the method.

Protected Attributes
std::string	_name
XmlRpcServer *	_server

Detailed Description

Abstract class representing a single RPC method.

Definition at line 30 of file XmlRpcServerMethod.h.

Constructor & Destructor Documentation

XmlRpc::XmlRpcServerMethod::XmlRpcServerMethod	(	std::string const &	name,
		XmlRpcServer *	server = 0
	)

Constructor.

Definition at line 13 of file XmlRpcServerMethod.cc.

  {
    _name = name;
    _server = server;
    if (_server) _server->addMethod(this);
  }

XmlRpc::XmlRpcServerMethod::~XmlRpcServerMethod ( )

virtual

Destructor.

Definition at line 20 of file XmlRpcServerMethod.cc.

  {
    if (_server) _server->removeMethod(this);
  }

Member Function Documentation

virtual void XmlRpc::XmlRpcServerMethod::execute ( XmlRpcValue &  params, XmlRpcValue &  result  )

pure virtual

Execute the method. Subclasses must provide a definition for this method.

Implemented in MethodHelp, ListMethods, JoinOverlay, DumpDht, Get, Put, Lookup, LocalLookup, P2pnsResolve, and P2pnsRegister.

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

std::string& XmlRpc::XmlRpcServerMethod::getName ( )

inline

Returns the name of the method.

Definition at line 38 of file XmlRpcServerMethod.h.

Referenced by XmlRpc::XmlRpcServer::addMethod(), and XmlRpc::XmlRpcServer::removeMethod().

{ return _name; }

virtual std::string XmlRpc::XmlRpcServerMethod::help ( )

inlinevirtual

Returns a help string for the method.

Subclasses should define this method if introspection is being used.

Reimplemented in MethodHelp, ListMethods, JoinOverlay, DumpDht, Get, Put, Lookup, LocalLookup, P2pnsResolve, and P2pnsRegister.

Definition at line 45 of file XmlRpcServerMethod.h.

Referenced by MethodHelp::execute().

{ return std::string(); }

Member Data Documentation

std::string XmlRpc::XmlRpcServerMethod::_name

protected

Definition at line 48 of file XmlRpcServerMethod.h.

Referenced by getName(), and XmlRpcServerMethod().

XmlRpcServer* XmlRpc::XmlRpcServerMethod::_server

protected

Definition at line 49 of file XmlRpcServerMethod.h.

Referenced by XmlRpcServerMethod(), and ~XmlRpcServerMethod().

---

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

• XmlRpcServerMethod.h
• XmlRpcServerMethod.cc