xrpl::InboundLedgers Class Reference

Manages the lifetime of inbound ledgers. More...

#include <InboundLedgers.h>

Inheritance diagram for xrpl::InboundLedgers:

Public Types
using	clock_type = beast::AbstractClock<std::chrono::steady_clock>

Public Member Functions
virtual	~InboundLedgers ()=default
virtual std::shared_ptr< Ledger const >	acquire (uint256 const &hash, std::uint32_t seq, InboundLedger::Reason)=0
virtual void	acquireAsync (uint256 const &hash, std::uint32_t seq, InboundLedger::Reason reason)=0
virtual std::shared_ptr< InboundLedger >	find (LedgerHash const &hash)=0
virtual bool	gotLedgerData (LedgerHash const &ledgerHash, std::shared_ptr< Peer >, std::shared_ptr< protocol::TMLedgerData >)=0
virtual void	gotStaleData (std::shared_ptr< protocol::TMLedgerData > packet)=0
virtual void	logFailure (uint256 const &h, std::uint32_t seq)=0
virtual bool	isFailure (uint256 const &h)=0
virtual void	clearFailures ()=0
virtual json::Value	getInfo ()=0
virtual std::size_t	fetchRate ()=0
	Returns the rate of historical ledger fetches per minute.
virtual void	onLedgerFetched ()=0
	Called when a complete ledger is obtained.
virtual void	gotFetchPack ()=0
virtual void	sweep ()=0
virtual void	stop ()=0
virtual std::size_t	cacheSize ()=0

Detailed Description

Manages the lifetime of inbound ledgers.

See also

InboundLedger

Definition at line 13 of file InboundLedgers.h.

Member Typedef Documentation

clock_type

using xrpl::InboundLedgers::clock_type = beast::AbstractClock<std::chrono::steady_clock>

Definition at line 16 of file InboundLedgers.h.

Constructor & Destructor Documentation

~InboundLedgers()

virtual xrpl::InboundLedgers::~InboundLedgers ( )

virtualdefault

Member Function Documentation

acquire()

virtual std::shared_ptr< Ledger const > xrpl::InboundLedgers::acquire ( uint256 const & hash, std::uint32_t seq, InboundLedger::Reason  )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

acquireAsync()

virtual void xrpl::InboundLedgers::acquireAsync ( uint256 const & hash, std::uint32_t seq, InboundLedger::Reason reason )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

find()

virtual std::shared_ptr< InboundLedger > xrpl::InboundLedgers::find ( LedgerHash const & hash )

pure virtual

Implemented in xrpl::test::MagicInboundLedgers.

gotLedgerData()

virtual bool xrpl::InboundLedgers::gotLedgerData ( LedgerHash const & ledgerHash, std::shared_ptr< Peer > , std::shared_ptr< protocol::TMLedgerData >  )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

gotStaleData()

virtual void xrpl::InboundLedgers::gotStaleData ( std::shared_ptr< protocol::TMLedgerData > packet )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

logFailure()

virtual void xrpl::InboundLedgers::logFailure ( uint256 const & h, std::uint32_t seq )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

isFailure()

virtual bool xrpl::InboundLedgers::isFailure ( uint256 const & h )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

clearFailures()

virtual void xrpl::InboundLedgers::clearFailures ( )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

getInfo()

virtual json::Value xrpl::InboundLedgers::getInfo ( )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

fetchRate()

virtual std::size_t xrpl::InboundLedgers::fetchRate ( )

pure virtual

Returns the rate of historical ledger fetches per minute.

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

onLedgerFetched()

virtual void xrpl::InboundLedgers::onLedgerFetched ( )

pure virtual

Called when a complete ledger is obtained.

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

gotFetchPack()

virtual void xrpl::InboundLedgers::gotFetchPack ( )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

sweep()

virtual void xrpl::InboundLedgers::sweep ( )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

stop()

virtual void xrpl::InboundLedgers::stop ( )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.

cacheSize()

virtual std::size_t xrpl::InboundLedgers::cacheSize ( )

pure virtual

Implemented in xrpl::InboundLedgersImp, and xrpl::test::MagicInboundLedgers.