libhomegear-base  0.7
Base library for Homegear and Homegear family modules.
BaseLib::Rpc::RpcMethod Class Reference

#include <RpcMethod.h>

Classes

struct  ParameterError
 

Public Member Functions

 RpcMethod ()
 
virtual ~RpcMethod ()
 
ParameterError::Enum checkParameters (std::shared_ptr< std::vector< PVariable >> parameters, std::vector< VariableType > types)
 
ParameterError::Enum checkParameters (std::shared_ptr< std::vector< PVariable >> parameters, std::vector< std::vector< VariableType >> types)
 
virtual PVariable invoke (PRpcClientInfo clientInfo, std::shared_ptr< std::vector< PVariable >> parameters)
 
PVariable getError (ParameterError::Enum error)
 
PVariable getSignature ()
 
void addSignature (VariableType returnType, std::vector< VariableType > parameterTypes)
 
PVariable getHelp ()
 
void setHelp (std::string help)
 

Protected Attributes

PVariable _signatures
 
PVariable _help
 

Constructor & Destructor Documentation

§ RpcMethod()

BaseLib::Rpc::RpcMethod::RpcMethod ( )
inline

§ ~RpcMethod()

virtual BaseLib::Rpc::RpcMethod::~RpcMethod ( )
inlinevirtual

Member Function Documentation

§ addSignature()

void BaseLib::Rpc::RpcMethod::addSignature ( VariableType  returnType,
std::vector< VariableType parameterTypes 
)

§ checkParameters() [1/2]

RpcMethod::ParameterError::Enum BaseLib::Rpc::RpcMethod::checkParameters ( std::shared_ptr< std::vector< PVariable >>  parameters,
std::vector< VariableType types 
)

§ checkParameters() [2/2]

RpcMethod::ParameterError::Enum BaseLib::Rpc::RpcMethod::checkParameters ( std::shared_ptr< std::vector< PVariable >>  parameters,
std::vector< std::vector< VariableType >>  types 
)

§ getError()

PVariable BaseLib::Rpc::RpcMethod::getError ( ParameterError::Enum  error)

§ getHelp()

PVariable BaseLib::Rpc::RpcMethod::getHelp ( )
inline

§ getSignature()

PVariable BaseLib::Rpc::RpcMethod::getSignature ( )
inline

§ invoke()

PVariable BaseLib::Rpc::RpcMethod::invoke ( PRpcClientInfo  clientInfo,
std::shared_ptr< std::vector< PVariable >>  parameters 
)
virtual

§ setHelp()

void BaseLib::Rpc::RpcMethod::setHelp ( std::string  help)

Member Data Documentation

§ _help

PVariable BaseLib::Rpc::RpcMethod::_help
protected

§ _signatures

PVariable BaseLib::Rpc::RpcMethod::_signatures
protected

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