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

MethodHelp Class Reference

Inheritance diagram for MethodHelp:

XmlRpc::XmlRpcServerMethod List of all members.

Public Member Functions

void execute (XmlRpcValue &params, XmlRpcValue &result)
 Execute the method. Subclasses must provide a definition for this method.
std::string help ()
 MethodHelp (XmlRpcServer *s)
std::string & name ()
 Returns the name of the method.

Protected Attributes

std::string _name
XmlRpcServer * _server

Constructor & Destructor Documentation

MethodHelp::MethodHelp XmlRpcServer s  )  [inline]
 

00225 : XmlRpcServerMethod(METHOD_HELP, s) {}


Member Function Documentation

void MethodHelp::execute XmlRpcValue params,
XmlRpcValue result
[inline, virtual]
 

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

Implements XmlRpc::XmlRpcServerMethod.

00228   {
00229     if (params[0].getType() != XmlRpcValue::TypeString)
00230       throw XmlRpcException(METHOD_HELP + ": Invalid argument type");
00231 
00232     XmlRpcServerMethod* m = _server->findMethod(params[0]);
00233     if ( ! m)
00234       throw XmlRpcException(METHOD_HELP + ": Unknown method name");
00235 
00236     result = m->help();
00237   }

std::string MethodHelp::help  )  [inline, virtual]
 

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

Reimplemented from XmlRpc::XmlRpcServerMethod.

00239 { return std::string("Retrieve the help string for a named method"); }

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

Returns the name of the method.

00032 { return _name; }


Member Data Documentation

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

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


The documentation for this class was generated from the following file:
Generated on Wed Feb 2 16:32:01 2011 for BOSS6.5.5 by  doxygen 1.3.9.1