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

The account_offers method retrieves a list of offers made by a given account. More...

#include <AccountOffers.hpp>

Inheritance diagram for rpc::AccountOffersHandler:
Collaboration diagram for rpc::AccountOffersHandler:

Classes

struct  Offer
 A struct to hold data for one offer response. More...
struct  Output
 A struct to hold the output data of the command. More...

Public Types

using Result = HandlerReturnType<Output>

Public Member Functions

 AccountOffersHandler (std::shared_ptr< BackendInterface > sharedPtrBackend)
 Construct a new AccountOffersHandler object.
Result process (Input const &input, Context const &ctx) const
 Process the AccountOffers command.

Static Public Attributes

static constexpr auto kLimitMin = rpc::spec::handlers::account_offers::kLimitMin
static constexpr auto kLimitMax = rpc::spec::handlers::account_offers::kLimitMax
static constexpr auto kLimitDefault = rpc::spec::handlers::account_offers::kLimitDefault

Friends

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

Detailed Description

The account_offers method retrieves a list of offers made by a given account.

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

Constructor & Destructor Documentation

◆ AccountOffersHandler()

rpc::AccountOffersHandler::AccountOffersHandler ( std::shared_ptr< BackendInterface > sharedPtrBackend)
inline

Construct a new AccountOffersHandler object.

Parameters
sharedPtrBackendThe backend to use

Member Function Documentation

◆ process()

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

Process the AccountOffers command.

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

◆ tag_invoke [1/2]

void tag_invoke ( boost::json::value_from_tag ,
boost::json::value & jv,
AccountOffersHandler::Offer const & offer )
friend

Convert the Offer to a JSON object.

Parameters
[out]jvThe JSON object to convert to
offerThe offer to convert

◆ tag_invoke [2/2]

void tag_invoke ( boost::json::value_from_tag ,
boost::json::value & jv,
AccountOffersHandler::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:
  • /__w/clio/clio/src/rpc/handlers/AccountOffers.hpp
  • /__w/clio/clio/src/rpc/handlers/AccountOffers.cpp