MethodHelp Class Reference

Inheritance diagram for MethodHelp:

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 ()
Public Member Functions inherited from XmlRpc::XmlRpcServerMethod
	XmlRpcServerMethod (std::string const &name, XmlRpcServer *server=0)
	Constructor.
virtual	~XmlRpcServerMethod ()
	Destructor.
std::string &	name ()
	Returns the name of the method.

Additional Inherited Members
Protected Attributes inherited from XmlRpc::XmlRpcServerMethod
std::string	_name
XmlRpcServer *	_server

Detailed Description

Definition at line 182 of file XmlRpcServer.cpp.

Constructor & Destructor Documentation

MethodHelp()

MethodHelp::MethodHelp ( XmlRpcServer * s )

inline

Definition at line 184 of file XmlRpcServer.cpp.

: XmlRpcServerMethod( METHOD_HELP, s ) {}

Member Function Documentation

execute()

void MethodHelp::execute ( XmlRpcValue & params, XmlRpcValue & result )

inlinevirtual

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

Implements XmlRpc::XmlRpcServerMethod.

Definition at line 186 of file XmlRpcServer.cpp.

                                                           {
    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();
  }

help()

std::string MethodHelp::help ( )

inlinevirtual

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

Reimplemented from XmlRpc::XmlRpcServerMethod.

Definition at line 196 of file XmlRpcServer.cpp.

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

---

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

• XmlRpcServer.cpp