rpc::AccountChannelsHandler Class Reference

The account_channels method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. All information retrieved is relative to a particular version of the ledger. More...

#include <AccountChannels.hpp>

Inheritance diagram for rpc::AccountChannelsHandler:

Collaboration diagram for rpc::AccountChannelsHandler:

Classes
struct	ChannelResponse
	A struct to hold data for one channel response. More...
struct	Output
	A struct to hold the output data of the command. More...

Public Types
using	Result = HandlerReturnType<Output>

Public Member Functions
	AccountChannelsHandler (std::shared_ptr< BackendInterface > sharedPtrBackend)
	Construct a new AccountChannelsHandler object.
Result	process (Input const &input, Context const &ctx) const
	Process the AccountChannels command.

Static Public Attributes
static constexpr auto	kLimitMin = rpc::spec::handlers::account_channels::kLimitMin
static constexpr auto	kLimitMax = rpc::spec::handlers::account_channels::kLimitMax
static constexpr auto	kLimitDefault = rpc::spec::handlers::account_channels::kLimitDefault

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

Detailed Description

The account_channels method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. All information retrieved is relative to a particular version of the ledger.

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

Constructor & Destructor Documentation

AccountChannelsHandler()

rpc::AccountChannelsHandler::AccountChannelsHandler ( std::shared_ptr< BackendInterface > sharedPtrBackend )

inline

Construct a new AccountChannelsHandler object.

Parameters

sharedPtrBackend

The backend to use

Member Function Documentation

process()

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

nodiscard

Process the AccountChannels command.

Parameters

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

Returns

The result of the operation

Friends And Related Symbol Documentation

tag_invoke [1/2]

void tag_invoke ( boost::json::value_from_tag , boost::json::value & jv, AccountChannelsHandler::ChannelResponse const & channel )

friend

Convert the ChannelResponse to a JSON object.

Parameters

[out]	jv	The JSON object to convert to
	channel	The channel response to convert

tag_invoke [2/2]

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

---

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

• /__w/clio/clio/src/rpc/handlers/AccountChannels.hpp
• /__w/clio/clio/src/rpc/handlers/AccountChannels.cpp