Manage the retrieval of a skip list in a ledger from the network. More...

#include <SkipListAcquire.h>

Inheritance diagram for ripple::SkipListAcquire:

[legend]

Collaboration diagram for ripple::SkipListAcquire:

[legend]

Classes
struct	SkipListData

Public Types
using	OnSkipListDataCB = std::function< void(bool successful, uint256 const &hash)>
	A callback used to notify that the SkipList is ready or failed.

Public Member Functions
	SkipListAcquire (Application &app, InboundLedgers &inboundLedgers, uint256 const &ledgerHash, std::unique_ptr< PeerSet > peerSet)
	Constructor.

	~SkipListAcquire () override

void	init (int numPeers)
	Start the SkipListAcquire task.

void	processData (std::uint32_t ledgerSeq, boost::intrusive_ptr< SHAMapItem const > const &item)
	Process the data extracted from a peer's reply.

void	addDataCallback (OnSkipListDataCB &&cb)
	Add a callback that will be called when the skipList is ready or failed.

std::shared_ptr< SkipListData const >	getData () const

virtual void	cancel ()
	Cancel the task by marking it as failed if the task is not done.

T	shared_from_this (T... args)

T	weak_from_this (T... args)

Protected Types
using	ScopedLockType = std::unique_lock< std::recursive_mutex >

Protected Member Functions
void	setTimer (ScopedLockType &)
	Schedule a call to queueJob() after mTimerInterval.

void	queueJob (ScopedLockType &)
	Queue a job to call invokeOnTimer().

bool	isDone () const

Protected Attributes
Application &	app_

beast::Journal	journal_

std::recursive_mutex	mtx_

uint256 const	hash_
	The hash of the object (in practice, always a ledger) we are trying to fetch.

int	timeouts_

bool	complete_

bool	failed_

bool	progress_
	Whether forward progress has been made.

std::chrono::milliseconds	timerInterval_
	The minimum time to wait between calls to execute().

QueueJobParameter	queueJobParameter_

Private Member Functions
void	onTimer (bool progress, ScopedLockType &peerSetLock) override
	Hook called from invokeOnTimer().

std::weak_ptr< TimeoutCounter >	pmDowncast () override
	Return a weak pointer to this.

void	trigger (std::size_t limit, ScopedLockType &sl)
	Trigger another round.

void	retrieveSkipList (std::shared_ptr< Ledger const > const &ledger, ScopedLockType &sl)
	Retrieve the skip list from the ledger.

void	onSkipListAcquired (std::vector< uint256 > const &skipList, std::uint32_t ledgerSeq, ScopedLockType &sl)
	Process the skip list.

void	notify (ScopedLockType &sl)
	Call the OnSkipListDataCB callbacks.

void	invokeOnTimer ()
	Calls onTimer() if in the right state.

Static Private Member Functions
static auto &	getCounter () noexcept

Private Attributes
InboundLedgers &	inboundLedgers_

std::unique_ptr< PeerSet >	peerSet_

std::vector< OnSkipListDataCB >	dataReadyCallbacks_

std::shared_ptr< SkipListData const >	data_

std::uint32_t	noFeaturePeerCount_ = 0

bool	fallBack_ = false

boost::asio::basic_waitable_timer< std::chrono::steady_clock >	timer_

Friends
class	test::LedgerReplayClient

Detailed Description

Manage the retrieval of a skip list in a ledger from the network.

Before asking peers, always check if the local node has the ledger.

Definition at line 22 of file SkipListAcquire.h.

Member Typedef Documentation

◆ OnSkipListDataCB

using ripple::SkipListAcquire::OnSkipListDataCB = std::function<void(bool successful, uint256 const& hash)>

A callback used to notify that the SkipList is ready or failed.

Parameters

successful	if the skipList data was acquired successfully
hash	hash of the ledger that has the skipList

Definition at line 33 of file SkipListAcquire.h.

◆ ScopedLockType

using ripple::TimeoutCounter::ScopedLockType = std::unique_lock<std::recursive_mutex>

protectedinherited

Definition at line 64 of file TimeoutCounter.h.

Constructor & Destructor Documentation

◆ SkipListAcquire()

ripple::SkipListAcquire::SkipListAcquire	(	Application &	app,
		InboundLedgers &	inboundLedgers,
		uint256 const &	ledgerHash,
		std::unique_ptr< PeerSet >	peerSet
	)

Constructor.

Parameters

app	Application reference
inboundLedgers	InboundLedgers reference
ledgerHash	hash of the ledger that has the skip list
peerSet	manage a set of peers that we will ask for the skip list

Definition at line 9 of file SkipListAcquire.cpp.

◆ ~SkipListAcquire()

ripple::SkipListAcquire::~SkipListAcquire ( )

override

Definition at line 28 of file SkipListAcquire.cpp.

Member Function Documentation

◆ init()

void ripple::SkipListAcquire::init ( int numPeers )

Start the SkipListAcquire task.

Parameters

numPeers number of peers to try initially

Definition at line 34 of file SkipListAcquire.cpp.

◆ processData()

void ripple::SkipListAcquire::processData	(	std::uint32_t	ledgerSeq,
		boost::intrusive_ptr< SHAMapItem const > const &	item
	)

Process the data extracted from a peer's reply.

Parameters

ledgerSeq	sequence number of the ledger that has the skip list
item	holder of the skip list

Note: ledgerSeq and item must have been verified against the ledger hash

Definition at line 118 of file SkipListAcquire.cpp.

◆ addDataCallback()

void ripple::SkipListAcquire::addDataCallback ( OnSkipListDataCB && cb )

Add a callback that will be called when the skipList is ready or failed.

Note: the callback will be called once and only once unless this object is destructed before the call.

Definition at line 153 of file SkipListAcquire.cpp.

◆ getData()

std::shared_ptr< SkipListAcquire::SkipListData const > ripple::SkipListAcquire::getData ( ) const

Definition at line 166 of file SkipListAcquire.cpp.

◆ onTimer()

void ripple::SkipListAcquire::onTimer	(	bool	progress,
		ScopedLockType &
	)

overrideprivatevirtual

Hook called from invokeOnTimer().

Implements ripple::TimeoutCounter.

Definition at line 96 of file SkipListAcquire.cpp.

◆ pmDowncast()

std::weak_ptr< TimeoutCounter > ripple::SkipListAcquire::pmDowncast ( )

overrideprivatevirtual

Return a weak pointer to this.

Implements ripple::TimeoutCounter.

Definition at line 112 of file SkipListAcquire.cpp.

◆ trigger()

void ripple::SkipListAcquire::trigger	(	std::size_t	limit,
		ScopedLockType &	sl
	)

private

Trigger another round.

Parameters

limit	number of new peers to send the request
sl	lock. this function must be called with the lock

Definition at line 45 of file SkipListAcquire.cpp.

◆ retrieveSkipList()

void ripple::SkipListAcquire::retrieveSkipList	(	std::shared_ptr< Ledger const > const &	ledger,
		ScopedLockType &	sl
	)

private

Retrieve the skip list from the ledger.

Parameters

ledger	the ledger that has the skip list
sl	lock. this function must be called with the lock

Definition at line 173 of file SkipListAcquire.cpp.

◆ onSkipListAcquired()

void ripple::SkipListAcquire::onSkipListAcquired	(	std::vector< uint256 > const &	skipList,
		std::uint32_t	ledgerSeq,
		ScopedLockType &	sl
	)

private

Process the skip list.

Parameters

skipList	skip list
ledgerSeq	sequence number of the ledger that has the skip list
sl	lock. this function must be called with the lock

Definition at line 195 of file SkipListAcquire.cpp.

◆ notify()

void ripple::SkipListAcquire::notify ( ScopedLockType & sl )

private

Call the OnSkipListDataCB callbacks.

Parameters

sl	lock. this function must be called with the lock

Definition at line 207 of file SkipListAcquire.cpp.

◆ cancel()

void ripple::TimeoutCounter::cancel ( )

virtualinherited

Cancel the task by marking it as failed if the task is not done.

Note: this function does not attempt to cancel the scheduled timer or to remove the queued job if any. When the timer expires or the queued job starts, however, the code will see that the task is done and returns immediately, if it can lock the weak pointer of the task.

Definition at line 99 of file TimeoutCounter.cpp.

◆ setTimer()

void ripple::TimeoutCounter::setTimer ( ScopedLockType & sl )

protectedinherited

Schedule a call to queueJob() after mTimerInterval.

Definition at line 31 of file TimeoutCounter.cpp.

◆ queueJob()

void ripple::TimeoutCounter::queueJob ( ScopedLockType & sl )

protectedinherited

Queue a job to call invokeOnTimer().

Definition at line 50 of file TimeoutCounter.cpp.

◆ isDone()

bool ripple::TimeoutCounter::isDone ( ) const

protectedinherited

Definition at line 99 of file TimeoutCounter.h.

◆ invokeOnTimer()

void ripple::TimeoutCounter::invokeOnTimer ( )

privateinherited

Calls onTimer() if in the right state.

Only called by queueJob().

Definition at line 74 of file TimeoutCounter.cpp.

◆ getCounter()

static auto & ripple::CountedObject< SkipListAcquire >::getCounter ( )

staticprivatenoexceptinherited

Definition at line 110 of file CountedObject.h.

Friends And Related Symbol Documentation

◆ test::LedgerReplayClient

friend class test::LedgerReplayClient

friend

Definition at line 144 of file SkipListAcquire.h.

Member Data Documentation

◆ inboundLedgers_

InboundLedgers& ripple::SkipListAcquire::inboundLedgers_

private

Definition at line 137 of file SkipListAcquire.h.

◆ peerSet_

std::unique_ptr<PeerSet> ripple::SkipListAcquire::peerSet_

private

Definition at line 138 of file SkipListAcquire.h.

◆ dataReadyCallbacks_

std::vector<OnSkipListDataCB> ripple::SkipListAcquire::dataReadyCallbacks_

private

Definition at line 139 of file SkipListAcquire.h.

◆ data_

std::shared_ptr<SkipListData const> ripple::SkipListAcquire::data_

private

Definition at line 140 of file SkipListAcquire.h.

◆ noFeaturePeerCount_

std::uint32_t ripple::SkipListAcquire::noFeaturePeerCount_ = 0

private

Definition at line 141 of file SkipListAcquire.h.

◆ fallBack_

bool ripple::SkipListAcquire::fallBack_ = false

private

Definition at line 142 of file SkipListAcquire.h.

◆ app_

Application& ripple::TimeoutCounter::app_

protectedinherited

Definition at line 106 of file TimeoutCounter.h.

◆ journal_

beast::Journal ripple::TimeoutCounter::journal_

protectedinherited

Definition at line 107 of file TimeoutCounter.h.

◆ mtx_

std::recursive_mutex ripple::TimeoutCounter::mtx_

mutableprotectedinherited

Definition at line 108 of file TimeoutCounter.h.

◆ hash_

uint256 const ripple::TimeoutCounter::hash_

protectedinherited

The hash of the object (in practice, always a ledger) we are trying to fetch.

Definition at line 112 of file TimeoutCounter.h.

◆ timeouts_

int ripple::TimeoutCounter::timeouts_

protectedinherited

Definition at line 113 of file TimeoutCounter.h.

◆ complete_

bool ripple::TimeoutCounter::complete_

protectedinherited

Definition at line 114 of file TimeoutCounter.h.

◆ failed_

bool ripple::TimeoutCounter::failed_

protectedinherited

Definition at line 115 of file TimeoutCounter.h.

◆ progress_

bool ripple::TimeoutCounter::progress_

protectedinherited

Whether forward progress has been made.

Definition at line 117 of file TimeoutCounter.h.

◆ timerInterval_

std::chrono::milliseconds ripple::TimeoutCounter::timerInterval_

protectedinherited

The minimum time to wait between calls to execute().

Definition at line 119 of file TimeoutCounter.h.

◆ queueJobParameter_

QueueJobParameter ripple::TimeoutCounter::queueJobParameter_

protectedinherited

Definition at line 121 of file TimeoutCounter.h.

◆ timer_

boost::asio::basic_waitable_timer<std::chrono::steady_clock> ripple::TimeoutCounter::timer_

privateinherited

Definition at line 130 of file TimeoutCounter.h.

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ OnSkipListDataCB

◆ ScopedLockType

Constructor & Destructor Documentation

◆ SkipListAcquire()

◆ ~SkipListAcquire()

Member Function Documentation

◆ init()

◆ processData()

◆ addDataCallback()

◆ getData()

◆ onTimer()

◆ pmDowncast()

◆ trigger()

◆ retrieveSkipList()

◆ onSkipListAcquired()

◆ notify()

◆ cancel()

◆ setTimer()

◆ queueJob()

◆ isDone()

◆ invokeOnTimer()

◆ getCounter()

Friends And Related Symbol Documentation

◆ test::LedgerReplayClient

Member Data Documentation

◆ inboundLedgers_

◆ peerSet_

◆ dataReadyCallbacks_

◆ data_

◆ noFeaturePeerCount_

◆ fallBack_

◆ app_

◆ journal_

◆ mtx_

◆ hash_

◆ timeouts_

◆ complete_

◆ failed_

◆ progress_

◆ timerInterval_

◆ queueJobParameter_

◆ timer_