RPCServer::Method Struct Reference

Contains all information on a registered RPC method, including the signature of the method. More...

#include <rpc/RPCServer.h>

Inheritance diagram for RPCServer::Method:

Public Member Functions
	Method (const RPCSignature &signature, const std::string &comment)
	Method (const RPCSignature &signature, const std::string &comment, const ParameterDescriptions &parameterDescriptions)
template<typename Backend >
void	addInvoker (TRPCInvoker< Backend > *invoker)
	adds a new invoker that processes the method for a certain backend More...
template<typename Reflector >
void	reflect (Reflector &r)
template<typename Stream >
void	reflect (ConcreteBinarySerializer< Stream, 0 > &r)
template<typename Stream >
void	reflect (ConcreteBinaryDeserializer< Stream, 0 > &r)
template<typename Reflector >
void	reflectBinaryV0 (Reflector &r)
bool	operator< (const MethodInfo &rhs) const
bool	operator== (const MethodInfo &rhs) const
std::string	extendedSignature () const
std::string	parameterDescriptions (const std::string &prefix="") const
std::string	sampleParametersSet (bool formatted=false) const

Public Attributes
std::map< int, boost::shared_ptr< RPCInvoker > >	invokers
	stores corresponding RPCInvoker for each backend type More...
RPCSignature	signature
	The signature of the method (including its name) More...
std::string	comment
	User comments and description. More...
ParameterDescriptions	parameterDesc
	User info on method parameters. More...
bool	parameterSamplesDefault
	Sample parameter values. More...
std::list< json::Value >	parameterSamples

Detailed Description

Contains all information on a registered RPC method, including the signature of the method.

Moreover a set of invokers are stored, where each invoker is responsible for one RPC backend type.

Constructor & Destructor Documentation

Method() [1/2]

Method ( const RPCSignature &  signature, const std::string &  comment  )

inline

Method() [2/2]

Method ( const RPCSignature &  signature, const std::string &  comment, const ParameterDescriptions &  parameterDescriptions  )

inline

Member Function Documentation

addInvoker()

void addInvoker ( TRPCInvoker< Backend > *  invoker )

inline

adds a new invoker that processes the method for a certain backend

reflect() [1/3]

void reflect ( Reflector &  r )

inlineinherited

reflect() [2/3]

void reflect ( ConcreteBinarySerializer< Stream, 0 > &  r )

inlineinherited

reflect() [3/3]

void reflect ( ConcreteBinaryDeserializer< Stream, 0 > &  r )

inlineinherited

reflectBinaryV0()

void reflectBinaryV0 ( Reflector &  r )

inlineinherited

operator<()

bool operator< ( const MethodInfo &  rhs ) const

inlineinherited

operator==()

bool operator== ( const MethodInfo &  rhs ) const

inlineinherited

extendedSignature()

std::string extendedSignature ( ) const

inherited

parameterDescriptions()

std::string parameterDescriptions ( const std::string &  prefix = "" ) const

inherited

Parameters

prefix

Prefix that is output on the beginning of each line (usable e.g. for indentation)

sampleParametersSet()

std::string sampleParametersSet ( bool  formatted = false ) const

inherited

Member Data Documentation

invokers

std::map<int, boost::shared_ptr<RPCInvoker> > invokers

stores corresponding RPCInvoker for each backend type

signature

RPCSignature signature

inherited

The signature of the method (including its name)

comment

std::string comment

inherited

User comments and description.

parameterDesc

ParameterDescriptions parameterDesc

inherited

User info on method parameters.

parameterSamplesDefault

bool parameterSamplesDefault

inherited

Sample parameter values.

parameterSamples

std::list<json::Value> parameterSamples

inherited

---

The documentation for this struct was generated from the following file:

• base/include/rpc/RPCServer.h