Public Member Functions

MethodHelp Class Reference

Inheritance diagram for MethodHelp:
XmlRpc::XmlRpcServerMethod

List of all members.

Public Member Functions

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

Detailed Description

Definition at line 262 of file XmlRpcServer.cc.

Constructor & Destructor Documentation

MethodHelp::MethodHelp ( XmlRpcServer *  s  )  [inline]

Definition at line 265 of file XmlRpcServer.cc.

: 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.

Definition at line 267 of file XmlRpcServer.cc.

  {
    if (params[0].getType() != XmlRpcValue::TypeString)
      throw XmlRpcException(METHOD_HELP + ": Invalid argument type");

    XmlRpcServerMethod* m = _server->findMethod(params[0]);
    if ( ! m)
      throw XmlRpcException(METHOD_HELP + ": Unknown method name");

    result = m->help();
  }

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.

Definition at line 279 of file XmlRpcServer.cc.

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

The documentation for this class was generated from the following file:
Generated on Wed Nov 3 2010 14:40:51 for OverSim by  doxygen 1.7.1