rpc::BookOffersHandler Class Reference

The book_offers method retrieves a list of Offers between two currencies, also known as an order book. More...

#include <BookOffers.hpp>

Inheritance diagram for rpc::BookOffersHandler:

Collaboration diagram for rpc::BookOffersHandler:

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

Public Types
using	Result = HandlerReturnType<Output>

Public Member Functions
	BookOffersHandler (std::shared_ptr< BackendInterface > sharedPtrBackend, std::shared_ptr< data::AmendmentCenterInterface const > const &amendmentCenter)
	Construct a new BookOffersHandler object.
Result	process (Input const &input, Context const &ctx) const
	Process the BookOffers command.

Static Public Attributes
static constexpr auto	kLimitMin = rpc::spec::handlers::book_offers::kLimitMin
static constexpr auto	kLimitMax = rpc::spec::handlers::book_offers::kLimitMax
static constexpr auto	kLimitDefault = rpc::spec::handlers::book_offers::kLimitDefault

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

Detailed Description

The book_offers method retrieves a list of Offers between two currencies, also known as an order book.

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

Constructor & Destructor Documentation

BookOffersHandler()

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

inline

Construct a new BookOffersHandler object.

Parameters

sharedPtrBackend	The backend to use
amendmentCenter	The amendmentCenter to use

Member Function Documentation

process()

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

nodiscard

Process the BookOffers 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, BookOffersHandler::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/BookOffers.hpp
• /__w/clio/clio/src/rpc/handlers/BookOffers.cpp