Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::FeatureHandler Class Reference

Contains common functionality for handling the server_info command. More...

#include <Feature.hpp>

Classes

struct  Input
 A struct to hold the input data for the command. More...
 
struct  Output
 A struct to hold the output data of the command. More...
 

Public Types

using Result = HandlerReturnType<Output>
 

Public Member Functions

 FeatureHandler (std::shared_ptr< BackendInterface > const &backend, std::shared_ptr< data::AmendmentCenterInterface const > const &amendmentCenter)
 Construct a new FeatureHandler object.
 
Result process (Input input, Context const &ctx) const
 Process the Feature command.
 

Static Public Member Functions

static RpcSpecConstRef spec (uint32_t apiVersion)
 Returns the API specification for the command.
 

Friends

void tag_invoke (boost::json::value_from_tag, boost::json::value &jv, FeatureHandler::Output const &output)
 Convert the Output to a JSON object.
 
void tag_invoke (boost::json::value_from_tag, boost::json::value &jv, Output::Feature const &feature)
 Convert the Feature to a JSON object.
 
Input tag_invoke (boost::json::value_to_tag< Input >, boost::json::value const &jv)
 Convert a JSON object to Input type.
 

Detailed Description

Contains common functionality for handling the server_info command.

Constructor & Destructor Documentation

◆ FeatureHandler()

rpc::FeatureHandler::FeatureHandler ( std::shared_ptr< BackendInterface > const & backend,
std::shared_ptr< data::AmendmentCenterInterface const > const & amendmentCenter )
inline

Construct a new FeatureHandler object.

Parameters
backendThe backend to use
amendmentCenterThe amendment center to use

Member Function Documentation

◆ process()

FeatureHandler::Result rpc::FeatureHandler::process ( FeatureHandler::Input input,
Context const & ctx ) const

Process the Feature command.

Parameters
inputThe input data for the command
ctxThe context of the request
Returns
The result of the operation

◆ spec()

RpcSpecConstRef rpc::FeatureHandler::spec ( uint32_t apiVersion)
static

Returns the API specification for the command.

Parameters
apiVersionThe api version to return the spec for
Returns
The spec for the given apiVersion

Friends And Related Symbol Documentation

◆ tag_invoke [1/3]

void tag_invoke ( boost::json::value_from_tag ,
boost::json::value & jv,
FeatureHandler::Output const & output )
friend

Convert the Output to a JSON object.

Parameters
[out]jvThe JSON object to convert to
outputThe output to convert

◆ tag_invoke [2/3]

void tag_invoke ( boost::json::value_from_tag ,
boost::json::value & jv,
Output::Feature const & feature )
friend

Convert the Feature to a JSON object.

Parameters
[out]jvThe JSON object to convert to
featureThe feature to convert

◆ tag_invoke [3/3]

Input tag_invoke ( boost::json::value_to_tag< Input > ,
boost::json::value const & jv )
friend

Convert a JSON object to Input type.

Parameters
jvThe JSON object to convert
Returns
Input parsed from the JSON object

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