Public Member Functions | Protected Attributes | List of all members
XmlRpc::XmlRpcServerMethod Class Referenceabstract

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

#include <XmlRpcServerMethod.h>

Inheritance diagram for XmlRpc::XmlRpcServerMethod:
Inheritance graph

Public Member Functions

virtual void execute (XmlRpcValue &params, XmlRpcValue &result)=0
 Execute the method. Subclasses must provide a definition for this method. More...
virtual std::string help ()
std::string & name ()
 Returns the name of the method. More...
 XmlRpcServerMethod (std::string const &name, XmlRpcServer *server=0)
 Constructor. More...
virtual ~XmlRpcServerMethod ()
 Destructor. More...

Protected Attributes

std::string _name

Detailed Description

Abstract class representing a single RPC method.

Definition at line 26 of file XmlRpcServerMethod.h.

Constructor & Destructor Documentation

◆ XmlRpcServerMethod()

XmlRpcServerMethod::XmlRpcServerMethod ( std::string const &  name,
XmlRpcServer server = 0 


Definition at line 8 of file XmlRpcServerMethod.cpp.

◆ ~XmlRpcServerMethod()

XmlRpcServerMethod::~XmlRpcServerMethod ( )


Definition at line 15 of file XmlRpcServerMethod.cpp.

Member Function Documentation

◆ execute()

virtual void XmlRpc::XmlRpcServerMethod::execute ( XmlRpcValue params,
XmlRpcValue result 
pure virtual

◆ help()

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

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

Reimplemented in MethodHelp, and ListMethods.

Definition at line 41 of file XmlRpcServerMethod.h.

◆ name()

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

Returns the name of the method.

Definition at line 34 of file XmlRpcServerMethod.h.

Member Data Documentation

◆ _name

std::string XmlRpc::XmlRpcServerMethod::_name

Definition at line 44 of file XmlRpcServerMethod.h.

◆ _server

XmlRpcServer* XmlRpc::XmlRpcServerMethod::_server

Definition at line 45 of file XmlRpcServerMethod.h.

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

Author(s): Chris Morley, Konstantin Pilipchuk, Morgan Quigley, Austin Hendrix, Dirk Thomas , Jacob Perron
autogenerated on Thu Nov 23 2023 04:01:41