XmlRpcServerMethod.h

Go to the documentation of this file.

#ifndef _XMLRPCSERVERMETHOD_H_
#define _XMLRPCSERVERMETHOD_H_
//
// XmlRpc++ Copyright (c) 2002-2003 by Chris Morley
//
#if defined(_MSC_VER)
# pragma warning(disable:4786)    // identifier was truncated in debug info
#endif

#include "XmlRpcDecl.h"

#ifndef MAKEDEPEND
# include <string>
#endif

namespace XmlRpc {

  // Representation of a parameter or result value
  class XmlRpcValue;

  // The XmlRpcServer processes client requests to call RPCs
  class XmlRpcServer;

  class XMLRPCPP_DECL XmlRpcServerMethod {
  public:
    XmlRpcServerMethod(std::string const& name, XmlRpcServer* server = 0);
    virtual ~XmlRpcServerMethod();

    std::string& name() { return _name; }

    virtual void execute(XmlRpcValue& params, XmlRpcValue& result) = 0;

    virtual std::string help() { return std::string(); }

  protected:
    std::string _name;
    XmlRpcServer* _server;
  };
} // namespace XmlRpc

#endif // _XMLRPCSERVERMETHOD_H_