xrpl::test::PeerStub Class Reference

A Peer whose every method is a no-op returning a default. More...

#include <PeerStub.h>

Inheritance diagram for xrpl::test::PeerStub:

Collaboration diagram for xrpl::test::PeerStub:

Public Member Functions
	PeerStub (ID id=0)
	~PeerStub () override=default
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
void	charge (resource::Charge const &, std::string 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
bool	hasLedger (UInt256 const &, std::uint32_t) const override
void	ledgerRange (std::uint32_t &, std::uint32_t &) const override
bool	hasTxSet (UInt256 const &) 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

Private Attributes
ID const	id_
PublicKey const	nodePublicKey_
std::string const	fingerprint_

Detailed Description

A Peer whose every method is a no-op returning a default.

Derive from this and override only the methods a test cares about. Adding a method to Peer then costs one stub here, not one per double.

The id and the node public key are real, because the code under test routes and deduplicates on both.

Definition at line 30 of file PeerStub.h.

Constructor & Destructor Documentation

PeerStub()

xrpl::test::PeerStub::PeerStub ( ID id = 0 )

explicit

Parameters

id	The connection id reported by id().

Definition at line 36 of file PeerStub.h.

~PeerStub()

xrpl::test::PeerStub::~PeerStub ( )

overridedefault

Member Function Documentation

send()

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

override

Definition at line 44 of file PeerStub.h.

getRemoteAddress()

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

nodiscardoverride

Definition at line 49 of file PeerStub.h.

sendTxQueue()

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

override

Definition at line 55 of file PeerStub.h.

addTxQueue()

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

override

Definition at line 60 of file PeerStub.h.

removeTxQueue()

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

override

Definition at line 65 of file PeerStub.h.

charge()

void xrpl::test::PeerStub::charge ( resource::Charge const & , std::string const &  )

override

Definition at line 70 of file PeerStub.h.

id()

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

nodiscardoverride

Definition at line 75 of file PeerStub.h.

cluster()

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

nodiscardoverride

Definition at line 81 of file PeerStub.h.

isHighLatency()

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

nodiscardoverride

Definition at line 87 of file PeerStub.h.

getScore()

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

nodiscardoverride

Definition at line 93 of file PeerStub.h.

getNodePublic()

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

nodiscardoverride

Definition at line 99 of file PeerStub.h.

json()

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

override

Definition at line 105 of file PeerStub.h.

supportsFeature()

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

nodiscardoverride

Definition at line 111 of file PeerStub.h.

publisherListSequence()

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

nodiscardoverride

Definition at line 117 of file PeerStub.h.

setPublisherListSequence()

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

override

Definition at line 123 of file PeerStub.h.

fingerprint()

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

nodiscardoverride

Definition at line 128 of file PeerStub.h.

getClosedLedgerHash()

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

nodiscardoverride

Definition at line 134 of file PeerStub.h.

hasLedger()

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

nodiscardoverride

Definition at line 140 of file PeerStub.h.

ledgerRange()

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

override

Definition at line 146 of file PeerStub.h.

hasTxSet()

bool xrpl::test::PeerStub::hasTxSet ( UInt256 const & ) const

nodiscardoverride

Definition at line 151 of file PeerStub.h.

cycleStatus()

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

override

Definition at line 157 of file PeerStub.h.

hasRange()

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

override

Definition at line 162 of file PeerStub.h.

compressionEnabled()

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

nodiscardoverride

Definition at line 168 of file PeerStub.h.

txReduceRelayEnabled()

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

nodiscardoverride

Definition at line 174 of file PeerStub.h.

Member Data Documentation

id_

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

private

Definition at line 180 of file PeerStub.h.

nodePublicKey_

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

private

Definition at line 181 of file PeerStub.h.

fingerprint_

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

private

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.