rpc::NFTOffersHandlerBase Class Reference

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

#include <NFTOffersCommon.hpp>

Inheritance diagram for rpc::NFTOffersHandlerBase:

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
	NFTOffersHandlerBase (std::shared_ptr< BackendInterface > const &sharedPtrBackend)
	Construct a new NFTOffersHandlerBase object.

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 = 50
static constexpr auto	kLIMIT_MAX = 500
static constexpr auto	kLIMIT_DEFAULT = 250

Protected Member Functions
Result	iterateOfferDirectory (Input input, ripple::uint256 const &tokenID, ripple::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.
Input	tag_invoke (boost::json::value_to_tag< Input >, boost::json::value const &jv)
	Convert a JSON object to Input type.

Detailed Description

Contains common functionality for handling the nft_offers command.

Constructor & Destructor Documentation

NFTOffersHandlerBase()

rpc::NFTOffersHandlerBase::NFTOffersHandlerBase ( std::shared_ptr< BackendInterface > const & sharedPtrBackend )

inline

Construct a new NFTOffersHandlerBase object.

Parameters

sharedPtrBackend

The backend to use

Member Function Documentation

iterateOfferDirectory()

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

protected

Iterate the NFT offer directory.

Parameters

input	The input data for the command
tokenID	The tokenID of the NFT
directory	The directory to iterate
yield	The coroutine context

Returns

The result of the iteration

spec()

static RpcSpecConstRef rpc::NFTOffersHandlerBase::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, NFTOffersHandlerBase::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/NFTOffersCommon.hpp
• /__w/clio/clio/src/rpc/handlers/NFTOffersCommon.cpp