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

#include <XmlRpcServerMethod.h>

Inheritance diagram for XmlRpc::XmlRpcServerMethod:

Public Member Functions
	XmlRpcServerMethod (std::string const &name, XmlRpcServer *server=0)
	Constructor.

virtual	~XmlRpcServerMethod ()
	Destructor.

std::string &	name ()
	Returns the name of the method.

virtual void	execute (XmlRpcValue &params, XmlRpcValue &result)=0
	Execute the method. Subclasses must provide a definition for this method.

virtual std::string	help ()

Protected Attributes
std::string	_name

XmlRpcServer *	_server

Detailed Description

Abstract class representing a single RPC method.

Definition at line 24 of file XmlRpcServerMethod.h.

Constructor & Destructor Documentation

◆ XmlRpcServerMethod()

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

Constructor.

Definition at line 8 of file XmlRpcServerMethod.cpp.

  {
    _name = name;
    _server = server;
    if (_server) _server->addMethod(this);
  }

◆ ~XmlRpcServerMethod()

XmlRpc::XmlRpcServerMethod::~XmlRpcServerMethod ( )

virtual

Destructor.

Definition at line 15 of file XmlRpcServerMethod.cpp.

  {
    if (_server) _server->removeMethod(this);
  }

Member Function Documentation

◆ execute()

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.

Referenced by XmlRpc::XmlRpcServerConnection::executeMethod().

◆ help()

virtual std::string XmlRpc::XmlRpcServerMethod::help ( )

inlinevirtual

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

Reimplemented in ListMethods, MethodHelp, and Hello.

Definition at line 39 of file XmlRpcServerMethod.h.

39{ return std::string(); }

Referenced by MethodHelp::execute().

◆ name()

std::string & XmlRpc::XmlRpcServerMethod::name ( )

inline

Returns the name of the method.

Definition at line 32 of file XmlRpcServerMethod.h.

32{ return _name; }

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

Member Data Documentation

◆ _name

std::string XmlRpc::XmlRpcServerMethod::_name

protected

Definition at line 42 of file XmlRpcServerMethod.h.

Referenced by name(), and XmlRpcServerMethod().

◆ _server

XmlRpcServer* XmlRpc::XmlRpcServerMethod::_server