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

Contains common functionality for handling the nft_offers command. More...

#include <NFTOffersCommon.hpp>

Inheritance diagram for rpc::NFTOffersHandlerBase:
Collaboration diagram for rpc::NFTOffersHandlerBase:

Classes

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

Public Types

using Result = HandlerReturnType<Output>

Public Member Functions

 NFTOffersHandlerBase (std::shared_ptr< BackendInterface > sharedPtrBackend)
 Construct a new NFTOffersHandlerBase object.

Static Public Attributes

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

Protected Member Functions

Result iterateOfferDirectory (Input input, xrpl::uint256 const &tokenID, xrpl::Keylet const &directory, boost::asio::yield_context yield) const
 Iterate the NFT offer directory.

Friends

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

Detailed Description

Contains common functionality for handling the nft_offers command.

Constructor & Destructor Documentation

◆ NFTOffersHandlerBase()

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

Construct a new NFTOffersHandlerBase object.

Parameters
sharedPtrBackendThe backend to use

Member Function Documentation

◆ iterateOfferDirectory()

NFTOffersHandlerBase::Result rpc::NFTOffersHandlerBase::iterateOfferDirectory ( Input input,
xrpl::uint256 const & tokenID,
xrpl::Keylet const & directory,
boost::asio::yield_context yield ) const
nodiscardprotected

Iterate the NFT offer directory.

Parameters
inputThe input data for the command
tokenIDThe tokenID of the NFT
directoryThe directory to iterate
yieldThe coroutine context
Returns
The result of the iteration

◆ tag_invoke

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