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

The mpt_holders command asks the Clio server for all holders of a particular MPTokenIssuance. More...

#include <MPTHolders.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

 MPTHoldersHandler (std::shared_ptr< BackendInterface > const &sharedPtrBackend)
 Construct a new MPTHoldersHandler object.
 
Result process (Input input, Context const &ctx) const
 Process the MPTHolders 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 = 50
 

Friends

void tag_invoke (boost::json::value_from_tag, boost::json::value &jv, MPTHoldersHandler::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 mpt_holders command asks the Clio server for all holders of a particular MPTokenIssuance.

Constructor & Destructor Documentation

◆ MPTHoldersHandler()

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

Construct a new MPTHoldersHandler object.

Parameters
sharedPtrBackendThe backend to use

Member Function Documentation

◆ process()

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

Process the MPTHolders command.

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

◆ spec()

static RpcSpecConstRef rpc::MPTHoldersHandler::spec ( uint32_t apiVersion)
inlinestatic

Returns the API specification for the command.

Parameters
apiVersionThe 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,
MPTHoldersHandler::Output const & output )
friend

Convert the Output to a JSON object.

Parameters
[out]jvThe JSON object to convert to
outputThe 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
jvThe JSON object to convert
Returns
Input parsed from the JSON object

The documentation for this class was generated from the following files: