rpc::LedgerHandler Class Reference

Retrieve information about the public ledger. More...

#include <Ledger.hpp>

Inheritance diagram for rpc::LedgerHandler:

Collaboration diagram for rpc::LedgerHandler:

Classes
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 > 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.

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

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 > sharedPtrBackend, std::shared_ptr< data::AmendmentCenterInterface const > amendmentCenter )

inline

Construct a new LedgerHandler object.

Parameters

sharedPtrBackend	The backend to use
amendmentCenter	The amendmentCenter to use

Member Function Documentation

process()

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

nodiscard

Process the Ledger command.

Parameters

input	The input data for the command
ctx	The 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, LedgerHandler::Output const & output )

friend

Convert the Output to a JSON object.

Parameters

[out]	jv	The JSON object to convert to
	output	The output to convert

---

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