xrpld
Loading...
Searching...
No Matches
xrpl::test::ChargeRecordingPeer Class Reference

A peer that records what it was charged. More...

#include <AcquireTestHelpers.h>

Inheritance diagram for xrpl::test::ChargeRecordingPeer:
Collaboration diagram for xrpl::test::ChargeRecordingPeer:

Public Member Functions

 ChargeRecordingPeer (bool hasTxSet=true)
void charge (resource::Charge const &fee, std::string const &) override
std::vector< resource::Charge > const & charges () const
bool hasTxSet (UInt256 const &) const override
bool hasLedger (UInt256 const &, std::uint32_t) const override
void send (std::shared_ptr< Message > const &) override
beast::ip::Endpoint getRemoteAddress () const override
void sendTxQueue () override
void addTxQueue (UInt256 const &) override
void removeTxQueue (UInt256 const &) override
ID id () const override
bool cluster () const override
bool isHighLatency () const override
int getScore (bool) const override
PublicKey const & getNodePublic () const override
json::Value json () override
bool supportsFeature (ProtocolFeature) const override
std::optional< std::size_t > publisherListSequence (PublicKey const &) const override
void setPublisherListSequence (PublicKey const &, std::size_t const) override
std::string const & fingerprint () const override
UInt256 getClosedLedgerHash () const override
void ledgerRange (std::uint32_t &, std::uint32_t &) const override
void cycleStatus () override
bool hasRange (std::uint32_t, std::uint32_t) override
bool compressionEnabled () const override
bool txReduceRelayEnabled () const override

Public Attributes

int id
std::set< int > set

Static Private Member Functions

static ID nextId ()
 The next id to hand out, distinct per instance because RequestCountingPeerSet dedups by tracked id and PeerStub's own default is zero for every instance.

Private Attributes

std::vector< resource::Charge > charges_
bool hasTxSet_
ID const id_
PublicKey const nodePublicKey_
std::string const fingerprint_

Detailed Description

A peer that records what it was charged.

Every other method comes from PeerStub.

One instance per packet keeps charges() unambiguous about which packet was charged what.

charges_ is unguarded: charging happens on the packet path, so every charge lands on the thread that fed the packet in.

Definition at line 57 of file AcquireTestHelpers.h.

Constructor & Destructor Documentation

◆ ChargeRecordingPeer()

xrpl::test::ChargeRecordingPeer::ChargeRecordingPeer ( bool hasTxSet = true)
explicit
Parameters
hasTxSetWhat hasTxSet() reports, which is how an acquisition decides whether this peer is worth asking. Defaults to true, so a peer handed straight to takeNodes() needs no argument.

Definition at line 65 of file AcquireTestHelpers.h.

Member Function Documentation

◆ charge()

void xrpl::test::ChargeRecordingPeer::charge ( resource::Charge const & fee,
std::string const &  )
override

Definition at line 70 of file AcquireTestHelpers.h.

◆ charges()

std::vector< resource::Charge > const & xrpl::test::ChargeRecordingPeer::charges ( ) const
nodiscard
Returns
Every fee this peer has been charged, in the order charged.

Definition at line 79 of file AcquireTestHelpers.h.

◆ hasTxSet()

bool xrpl::test::ChargeRecordingPeer::hasTxSet ( UInt256 const & ) const
nodiscardoverride

Definition at line 87 of file AcquireTestHelpers.h.

◆ hasLedger()

bool xrpl::test::ChargeRecordingPeer::hasLedger ( UInt256 const & ,
std::uint32_t  ) const
nodiscardoverride

Definition at line 93 of file AcquireTestHelpers.h.

◆ nextId()

ID xrpl::test::ChargeRecordingPeer::nextId ( )
staticnodiscardprivate

The next id to hand out, distinct per instance because RequestCountingPeerSet dedups by tracked id and PeerStub's own default is zero for every instance.

Returns
The id.

Definition at line 107 of file AcquireTestHelpers.h.

◆ send()

void xrpl::test::PeerStub::send ( std::shared_ptr< Message > const & )
overrideinherited

Definition at line 44 of file PeerStub.h.

◆ getRemoteAddress()

beast::ip::Endpoint xrpl::test::PeerStub::getRemoteAddress ( ) const
nodiscardoverrideinherited

Definition at line 49 of file PeerStub.h.

◆ sendTxQueue()

void xrpl::test::PeerStub::sendTxQueue ( )
overrideinherited

Definition at line 55 of file PeerStub.h.

◆ addTxQueue()

void xrpl::test::PeerStub::addTxQueue ( UInt256 const & )
overrideinherited

Definition at line 60 of file PeerStub.h.

◆ removeTxQueue()

void xrpl::test::PeerStub::removeTxQueue ( UInt256 const & )
overrideinherited

Definition at line 65 of file PeerStub.h.

◆ id()

ID xrpl::test::PeerStub::id ( ) const
nodiscardoverrideinherited

Definition at line 75 of file PeerStub.h.

◆ cluster()

bool xrpl::test::PeerStub::cluster ( ) const
nodiscardoverrideinherited

Definition at line 81 of file PeerStub.h.

◆ isHighLatency()

bool xrpl::test::PeerStub::isHighLatency ( ) const
nodiscardoverrideinherited

Definition at line 87 of file PeerStub.h.

◆ getScore()

int xrpl::test::PeerStub::getScore ( bool ) const
nodiscardoverrideinherited

Definition at line 93 of file PeerStub.h.

◆ getNodePublic()

PublicKey const & xrpl::test::PeerStub::getNodePublic ( ) const
nodiscardoverrideinherited

Definition at line 99 of file PeerStub.h.

◆ json()

json::Value xrpl::test::PeerStub::json ( )
overrideinherited

Definition at line 105 of file PeerStub.h.

◆ supportsFeature()

bool xrpl::test::PeerStub::supportsFeature ( ProtocolFeature ) const
nodiscardoverrideinherited

Definition at line 111 of file PeerStub.h.

◆ publisherListSequence()

std::optional< std::size_t > xrpl::test::PeerStub::publisherListSequence ( PublicKey const & ) const
nodiscardoverrideinherited

Definition at line 117 of file PeerStub.h.

◆ setPublisherListSequence()

void xrpl::test::PeerStub::setPublisherListSequence ( PublicKey const & ,
std::size_t const  )
overrideinherited

Definition at line 123 of file PeerStub.h.

◆ fingerprint()

std::string const & xrpl::test::PeerStub::fingerprint ( ) const
nodiscardoverrideinherited

Definition at line 128 of file PeerStub.h.

◆ getClosedLedgerHash()

UInt256 xrpl::test::PeerStub::getClosedLedgerHash ( ) const
nodiscardoverrideinherited

Definition at line 134 of file PeerStub.h.

◆ ledgerRange()

void xrpl::test::PeerStub::ledgerRange ( std::uint32_t & ,
std::uint32_t &  ) const
overrideinherited

Definition at line 146 of file PeerStub.h.

◆ cycleStatus()

void xrpl::test::PeerStub::cycleStatus ( )
overrideinherited

Definition at line 157 of file PeerStub.h.

◆ hasRange()

bool xrpl::test::PeerStub::hasRange ( std::uint32_t ,
std::uint32_t  )
overrideinherited

Definition at line 162 of file PeerStub.h.

◆ compressionEnabled()

bool xrpl::test::PeerStub::compressionEnabled ( ) const
nodiscardoverrideinherited

Definition at line 168 of file PeerStub.h.

◆ txReduceRelayEnabled()

bool xrpl::test::PeerStub::txReduceRelayEnabled ( ) const
nodiscardoverrideinherited

Definition at line 174 of file PeerStub.h.

Member Data Documentation

◆ charges_

std::vector<resource::Charge> xrpl::test::ChargeRecordingPeer::charges_
private

Definition at line 113 of file AcquireTestHelpers.h.

◆ hasTxSet_

bool xrpl::test::ChargeRecordingPeer::hasTxSet_
private

Definition at line 114 of file AcquireTestHelpers.h.

◆ id_

ID const xrpl::test::PeerStub::id_
privateinherited

Definition at line 180 of file PeerStub.h.

◆ nodePublicKey_

PublicKey const xrpl::test::PeerStub::nodePublicKey_
privateinherited

Definition at line 181 of file PeerStub.h.

◆ fingerprint_

std::string const xrpl::test::PeerStub::fingerprint_
privateinherited

Definition at line 182 of file PeerStub.h.

◆ id

int xrpl::test::Peer::id
inherited

Definition at line 15 of file BasicNetwork.cpp.

◆ set

std::set<int> xrpl::test::Peer::set
inherited

Definition at line 16 of file BasicNetwork.cpp.