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>

Classes
struct	ChannelResponse
	A struct to hold data for one channel response. More...
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
	AccountChannelsHandler (std::shared_ptr< BackendInterface > const &sharedPtrBackend)
	Construct a new AccountChannelsHandler object.
Result	process (Input input, Context const &ctx) const
	Process the AccountChannels 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 = 10
static constexpr auto	kLIMIT_MAX = 400
static constexpr auto	kLIMIT_DEFAULT = 200

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

inline

Construct a new AccountChannelsHandler object.

Parameters

sharedPtrBackend

The backend to use

Member Function Documentation

process()

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

Process the AccountChannels command.

Parameters

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

Returns

The result of the operation

spec()

static RpcSpecConstRef rpc::AccountChannelsHandler::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/3]

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/3]

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

tag_invoke [3/3]

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/AccountChannels.hpp
• /__w/clio/clio/src/rpc/handlers/AccountChannels.cpp