Contains information on an existing RPC method: the signature of the method, comments, etc. More...
#include <rpc/RPCServer.h>
Inheritance diagram for RPCServer::MethodInfo:
Classes | |
| class | ReflectMethodParamsDocumentation |
Public Member Functions | |
| MethodInfo () | |
| MethodInfo (const RPCSignature &iSignature, const std::string &iComment) | |
| MethodInfo (const RPCSignature &iSignature, const std::string &iComment, const ParameterDescriptions &iParameterDescriptions) | |
| template<typename Reflector > | |
| void | reflect (Reflector &r) |
| template<typename Reflector > | |
| void | reflectBinaryV0 (Reflector &r) |
| template<typename Stream > | |
| void | reflect (ConcreteBinarySerializer< Stream, 0 > &r) |
| template<typename Stream > | |
| void | reflect (ConcreteBinaryDeserializer< Stream, 0 > &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 | |
| 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 information on an existing RPC method: the signature of the method, comments, etc.
Constructor & Destructor Documentation
◆ MethodInfo() [1/3]
|
inline |
◆ MethodInfo() [2/3]
|
inline |
◆ MethodInfo() [3/3]
|
inline |
Member Function Documentation
◆ reflect() [1/3]
|
inline |
◆ reflectBinaryV0()
|
inline |
◆ reflect() [2/3]
|
inline |
◆ reflect() [3/3]
|
inline |
◆ operator<()
|
inline |
◆ operator==()
|
inline |
◆ extendedSignature()
| std::string extendedSignature | ( | ) | const |
◆ parameterDescriptions()
| std::string parameterDescriptions | ( | const std::string & | prefix = "" | ) | const |
- 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 |
Member Data Documentation
◆ signature
| RPCSignature signature |
The signature of the method (including its name)
◆ comment
| std::string comment |
User comments and description.
◆ parameterDesc
| ParameterDescriptions parameterDesc |
User info on method parameters.
◆ parameterSamplesDefault
| bool parameterSamplesDefault |
Sample parameter values.
◆ parameterSamples
| std::list<json::Value> parameterSamples |
The documentation for this struct was generated from the following file:
- base/include/rpc/RPCServer.h
