Public Member Functions | Protected Attributes | List of all members
XmlRpc::XmlRpcServerMethod Class Referenceabstract

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

#include <XmlRpcServerMethod.h>

Inheritance diagram for XmlRpc::XmlRpcServerMethod:
Inheritance graph
[legend]

Public Member Functions

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

Protected Attributes

std::string _name
 
XmlRpcServer_server
 

Detailed Description

Abstract class representing a single RPC method.

Definition at line 26 of file XmlRpcServerMethod.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 8 of file XmlRpcServerMethod.cpp.

XmlRpc::XmlRpcServerMethod::~XmlRpcServerMethod ( )
virtual

Destructor.

Definition at line 15 of file XmlRpcServerMethod.cpp.

Member Function Documentation

virtual void XmlRpc::XmlRpcServerMethod::execute ( XmlRpcValue params,
XmlRpcValue result 
)
pure virtual
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, Hello, and Hello.

Definition at line 41 of file XmlRpcServerMethod.h.

std::string& XmlRpc::XmlRpcServerMethod::name ( )
inline

Returns the name of the method.

Definition at line 34 of file XmlRpcServerMethod.h.

Member Data Documentation

std::string XmlRpc::XmlRpcServerMethod::_name
protected

Definition at line 44 of file XmlRpcServerMethod.h.

XmlRpcServer* XmlRpc::XmlRpcServerMethod::_server
protected

Definition at line 45 of file XmlRpcServerMethod.h.


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


xmlrpcpp
Author(s): Chris Morley, Konstantin Pilipchuk, Morgan Quigley
autogenerated on Sun Aug 26 2018 03:03:28