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

Retrieve information about the public ledger. More...

#include <Ledger.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

 LedgerHandler (std::shared_ptr< BackendInterface > const &sharedPtrBackend, std::shared_ptr< data::AmendmentCenterInterface const > amendmentCenter)
 Construct a new LedgerHandler object.
Result process (Input const &input, Context const &ctx) const
 Process the Ledger 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, LedgerHandler::Output const &output)
 Convert the Output 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

Retrieve information about the public ledger.

For more details see: https://xrpl.org/ledger.html

Constructor & Destructor Documentation

◆ LedgerHandler()

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

Construct a new LedgerHandler object.

Parameters
sharedPtrBackendThe backend to use
amendmentCenterThe amendmentCenter to use

Member Function Documentation

◆ process()

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

Process the Ledger command.

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

◆ spec()

RpcSpecConstRef rpc::LedgerHandler::spec ( uint32_t apiVersion)
inlinestatic

Returns the API specification for the command.

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

◆ tag_invoke [1/2]

void tag_invoke ( boost::json::value_from_tag ,
boost::json::value & jv,
LedgerHandler::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/2]

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:
  • /__w/clio/clio/src/rpc/handlers/Ledger.hpp
  • /__w/clio/clio/src/rpc/handlers/Ledger.cpp