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>

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
	BookOffersHandler (std::shared_ptr< BackendInterface > const &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 Member Functions
static RpcSpecConstRef	spec (uint32_t apiVersion)
	Returns the API specification for the command.

Static Public Attributes
static constexpr auto	kLIMIT_MIN = 1
static constexpr auto	kLIMIT_MAX = 100
static constexpr auto	kLIMIT_DEFAULT = 60

Friends
void	tag_invoke (boost::json::value_from_tag, boost::json::value &jv, BookOffersHandler::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

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 > const & 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

Process the BookOffers command.

Parameters

input	The input data for the command
ctx	The context of the request

Returns

The result of the operation

spec()

RpcSpecConstRef rpc::BookOffersHandler::spec ( uint32_t apiVersion )

inlinestatic

Returns the API specification for the command.

Parameters

apiVersion

The api version to return the spec for

Returns

The spec for the given apiVersion

Friends And Related Symbol Documentation

tag_invoke [1/2]

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

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

jv	The 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/BookOffers.hpp
• /__w/clio/clio/src/rpc/handlers/BookOffers.cpp