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

The ledger_range command returns the index number of the earliest and latest ledgers that the server has. More...

#include <LedgerRange.hpp>

Classes

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

Public Types

using Result = HandlerReturnType<Output>
 

Public Member Functions

 LedgerRangeHandler (std::shared_ptr< BackendInterface > const &sharedPtrBackend)
 Construct a new LedgerRangeHandler object.
 
Result process (Context const &ctx) const
 Process the LedgerRange command.
 

Friends

void tag_invoke (boost::json::value_from_tag, boost::json::value &jv, LedgerRangeHandler::Output const &output)
 Convert the Output to a JSON object.
 

Detailed Description

The ledger_range command returns the index number of the earliest and latest ledgers that the server has.

Not documented in the official rippled API docs.

Constructor & Destructor Documentation

◆ LedgerRangeHandler()

rpc::LedgerRangeHandler::LedgerRangeHandler ( std::shared_ptr< BackendInterface > const & sharedPtrBackend)
inline

Construct a new LedgerRangeHandler object.

Parameters
sharedPtrBackendThe backend to use

Member Function Documentation

◆ process()

LedgerRangeHandler::Result rpc::LedgerRangeHandler::process ( Context const & ctx) const

Process the LedgerRange command.

Parameters
ctxThe context of the request
Returns
The result of the operation

Friends And Related Symbol Documentation

◆ tag_invoke

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

Convert the Output to a JSON object.

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

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