Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

XmlRpc::XmlRpcServerMethod Class Reference

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

#include <XmlRpcServerMethod.h>

Inheritance diagram for XmlRpc::XmlRpcServerMethod:

ArrayOfStructsTest CountTheEntities EasyStructTest EchoStructTest Hello HelloName ListMethods ManyTypesTest MethodHelp ModerateSizeArrayCheck NestedStructTest SimpleStructReturnTest Sum TestBase64 List of all members.

Public Member Functions

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

Protected Attributes

std::string _name
XmlRpcServer * _server

Detailed Description

Abstract class representing a single RPC method.

Constructor & Destructor Documentation

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

Constructor. 

00009   {
00010     _name = name;
00011     _server = server;
00012     if (_server) _server->addMethod(this);
00013   }

XmlRpc::XmlRpcServerMethod::~XmlRpcServerMethod (   )  [virtual]
 

Destructor. 

00016   {
00017     if (_server) _server->removeMethod(this);
00018   }

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 ListMethods, MethodHelp, Hello, HelloName, Sum, TestBase64, ArrayOfStructsTest, CountTheEntities, EasyStructTest, EchoStructTest, ManyTypesTest, ModerateSizeArrayCheck, NestedStructTest, and SimpleStructReturnTest.

virtual std::string XmlRpc::XmlRpcServerMethod::help (   )  [inline, virtual]
 

Returns a help string for the method. Subclasses should define this method if introspection is being used.

Reimplemented in ListMethods, MethodHelp, and Hello.

00039 { return std::string(); }

std::string& XmlRpc::XmlRpcServerMethod::name (  void   )  [inline]
 

Returns the name of the method. 

00032 { return _name; }

Member Data Documentation

std::string XmlRpc::XmlRpcServerMethod::_name [protected]
 

XmlRpcServer* XmlRpc::XmlRpcServerMethod::_server [protected]
 

The documentation for this class was generated from the following files:
Generated on Wed Feb 2 19:25:33 2011 for BOSS6.5.5 by  doxygen 1.3.9.1