xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
xrpld
rpc
handlers
account
AccountChannels.h
1
#pragma once
2
3
#include <xrpld/rpc/Context.h>
4
#include <xrpld/rpc/detail/SpecBridge.hpp>
5
6
#include <xrpl/basics/base_uint.h>
7
#include <xrpl/json/json_value.h>
8
#include <xrpl/ledger/ReadView.h>
9
#include <xrpl/protocol/AccountID.h>
10
#include <xrpl/protocol/STLedgerEntry.h>
11
12
#include <rpcspec/Errors.hpp>
13
#include <rpcspec/handlers/account_channels/Types.hpp>
14
15
#include <
cstdint
>
16
#include <expected>
17
#include <
functional
>
18
#include <
memory
>
19
#include <
optional
>
20
#include <
vector
>
21
22
namespace
xrpl::rpc
{
23
29
class
AccountChannelsHandler
:
public
HandlerFor<::rpc::spec::handlers::account_channels::Input>
30
{
31
public
:
35
struct
Output
36
{
37
std::shared_ptr<ReadView const>
ledger
;
38
AccountID
account
;
39
std::uint32_t
limit
= 0;
40
std::vector<SLE::const_pointer>
channels
;
41
std::optional<uint256>
marker
;
42
std::uint64_t
nextHint
= 0;
43
};
44
50
explicit
AccountChannelsHandler
(
JsonContext
& context);
51
58
[[nodiscard]] std::expected<Output, ::rpc::Status>
59
process
(Input
const
& input)
const
;
60
67
void
68
writeResult
(
json::Value
& value,
Output
const
& output)
const
;
69
70
private
:
71
std::reference_wrapper<JsonContext>
context_
;
72
};
73
74
}
// namespace xrpl::rpc
json::Value
Represents a JSON value.
Definition
json_value.h:121
xrpl::rpc::AccountChannelsHandler::process
std::expected< Output, ::rpc::Status > process(Input const &input) const
Process the request.
Definition
AccountChannels.cpp:77
xrpl::rpc::AccountChannelsHandler::context_
std::reference_wrapper< JsonContext > context_
Definition
AccountChannels.h:71
xrpl::rpc::AccountChannelsHandler::writeResult
void writeResult(json::Value &value, Output const &output) const
Write the output of process() into the response.
Definition
AccountChannels.cpp:174
xrpl::rpc::AccountChannelsHandler::AccountChannelsHandler
AccountChannelsHandler(JsonContext &context)
Construct a handler for a single request.
Definition
AccountChannels.cpp:72
cstdint
functional
std::uint32_t
memory
xrpl::rpc
The api_version numbers this server serves.
Definition
ApiVersion.h:26
xrpl::AccountID
BaseUInt< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
Definition
AccountID.h:34
optional
std::reference_wrapper
std::shared_ptr
xrpl::rpc::AccountChannelsHandler::Output
The data an account_channels request produces, written out by writeResult().
Definition
AccountChannels.h:36
xrpl::rpc::AccountChannelsHandler::Output::ledger
std::shared_ptr< ReadView const > ledger
The ledger the request selected.
Definition
AccountChannels.h:37
xrpl::rpc::AccountChannelsHandler::Output::account
AccountID account
The account whose channels are listed.
Definition
AccountChannels.h:38
xrpl::rpc::AccountChannelsHandler::Output::channels
std::vector< SLE::const_pointer > channels
The channels on this page.
Definition
AccountChannels.h:40
xrpl::rpc::AccountChannelsHandler::Output::marker
std::optional< uint256 > marker
Where the next page starts, if there is one.
Definition
AccountChannels.h:41
xrpl::rpc::AccountChannelsHandler::Output::nextHint
std::uint64_t nextHint
The directory page hint written with the marker.
Definition
AccountChannels.h:42
xrpl::rpc::AccountChannelsHandler::Output::limit
std::uint32_t limit
The limit used; written only with a marker.
Definition
AccountChannels.h:39
xrpl::rpc::JsonContext
Definition
Context.h:41
vector
Generated by
1.17.0