MethodHelp Class Reference

Inheritance diagram for MethodHelp:

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 ()
std::string &	name ()
	Returns the name of the method.
Protected Attributes
std::string	_name
XmlRpcServer *	_server

---

Detailed Description

Definition at line 222 of file XmlRpcServer.cpp.

---

Constructor & Destructor Documentation

MethodHelp::MethodHelp

(

XmlRpcServer *

s

)

[inline]

Definition at line 225 of file XmlRpcServer.cpp.

: 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 227 of file XmlRpcServer.cpp.

References XmlRpc::XmlRpcServerMethod::help(), METHOD_HELP(), and XmlRpc::XmlRpcValue::TypeString.

  {
    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 239 of file XmlRpcServer.cpp.

References deljobs::string.

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

Definition at line 32 of file XmlRpcServerMethod.h.

References XmlRpc::XmlRpcServerMethod::_name.

Referenced by XmlRpc::XmlRpcServer::addMethod(), and XmlRpc::XmlRpcServer::removeMethod().

{ return _name; }

---

Member Data Documentation

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

Definition at line 42 of file XmlRpcServerMethod.h.

Referenced by XmlRpc::XmlRpcServerMethod::name(), and XmlRpc::XmlRpcServerMethod::XmlRpcServerMethod().

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

Definition at line 43 of file XmlRpcServerMethod.h.

Referenced by XmlRpc::XmlRpcServerMethod::XmlRpcServerMethod(), and XmlRpc::XmlRpcServerMethod::~XmlRpcServerMethod().

---