#include <LedgerReplayTask.h>

Inheritance diagram for ripple::LedgerReplayTask:

[legend]

Collaboration diagram for ripple::LedgerReplayTask:

[legend]

Classes
class	TaskParameter

Public Member Functions
	LedgerReplayTask (Application &app, InboundLedgers &inboundLedgers, LedgerReplayer &replayer, std::shared_ptr< SkipListAcquire > &skipListAcquirer, TaskParameter &&parameter)
	Constructor.

	~LedgerReplayTask ()

void	init ()
	Start the task.

void	addDelta (std::shared_ptr< LedgerDeltaAcquire > const &delta)
	add a new LedgerDeltaAcquire subtask

TaskParameter const &	getTaskParameter () const

bool	finished () const
	return if the task is finished

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 &sl) override
	Hook called from invokeOnTimer().

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

void	updateSkipList (uint256 const &hash, std::uint32_t seq, std::vector< uint256 > const &sList)
	Update this task (by a SkipListAcquire subtask) when skip list is ready.

void	deltaReady (uint256 const &deltaHash)
	Notify this task (by a LedgerDeltaAcquire subtask) that a delta is ready.

void	trigger (ScopedLockType &sl)
	Trigger another round.

void	tryAdvance (ScopedLockType &sl)
	Try to build more ledgers.

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

Static Private Member Functions
static auto &	getCounter () noexcept

Private Attributes
InboundLedgers &	inboundLedgers_

LedgerReplayer &	replayer_

TaskParameter	parameter_

uint32_t	maxTimeouts_

std::shared_ptr< SkipListAcquire >	skipListAcquirer_

std::shared_ptr< Ledger const >	parent_ = {}

uint32_t	deltaToBuild_ = 0

std::vector< std::shared_ptr< LedgerDeltaAcquire > >	deltas_

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

Friends
class	test::LedgerReplayClient

Detailed Description

Definition at line 39 of file LedgerReplayTask.h.

Member Typedef Documentation

◆ ScopedLockType

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

protectedinherited

Definition at line 83 of file TimeoutCounter.h.

Constructor & Destructor Documentation

◆ LedgerReplayTask()

ripple::LedgerReplayTask::LedgerReplayTask	(	Application &	app,
		InboundLedgers &	inboundLedgers,
		LedgerReplayer &	replayer,
		std::shared_ptr< SkipListAcquire > &	skipListAcquirer,
		TaskParameter &&	parameter
	)

Constructor.

Parameters

app	Application reference
inboundLedgers	InboundLedgers reference
replayer	LedgerReplayer reference
skipListAcquirer	shared_ptr of SkipListAcquire subtask, to make sure it will not be destroyed.
parameter	parameter of the task

Definition at line 88 of file LedgerReplayTask.cpp.

◆ ~LedgerReplayTask()

ripple::LedgerReplayTask::~LedgerReplayTask ( )

Definition at line 114 of file LedgerReplayTask.cpp.

Member Function Documentation

◆ init()

void ripple::LedgerReplayTask::init ( )

Start the task.

Definition at line 120 of file LedgerReplayTask.cpp.

◆ addDelta()

void ripple::LedgerReplayTask::addDelta ( std::shared_ptr< LedgerDeltaAcquire > const & delta )

add a new LedgerDeltaAcquire subtask

Parameters

delta the new LedgerDeltaAcquire subtask

Note: the LedgerDeltaAcquire subtasks must be added in order

Definition at line 278 of file LedgerReplayTask.cpp.

◆ getTaskParameter()

TaskParameter const & ripple::LedgerReplayTask::getTaskParameter ( ) const

Definition at line 122 of file LedgerReplayTask.h.

◆ finished()

bool ripple::LedgerReplayTask::finished ( ) const

return if the task is finished

Definition at line 308 of file LedgerReplayTask.cpp.

◆ onTimer()

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

overrideprivatevirtual

Hook called from invokeOnTimer().

Implements ripple::TimeoutCounter.

Definition at line 256 of file LedgerReplayTask.cpp.

◆ pmDowncast()

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

overrideprivatevirtual

Return a weak pointer to this.

Implements ripple::TimeoutCounter.

Definition at line 272 of file LedgerReplayTask.cpp.

◆ updateSkipList()

void ripple::LedgerReplayTask::updateSkipList	(	uint256 const &	hash,
		std::uint32_t	seq,
		std::vector< uint256 > const &	sList
	)

private

Update this task (by a SkipListAcquire subtask) when skip list is ready.

Parameters

hash	hash of the ledger that has the skip list
seq	sequence number of the ledger that has the skip list
sList	skip list

Definition at line 232 of file LedgerReplayTask.cpp.

◆ deltaReady()

void ripple::LedgerReplayTask::deltaReady ( uint256 const & deltaHash )

private

Notify this task (by a LedgerDeltaAcquire subtask) that a delta is ready.

Parameters

deltaHash ledger hash of the delta

Definition at line 178 of file LedgerReplayTask.cpp.

◆ trigger()

void ripple::LedgerReplayTask::trigger ( ScopedLockType & sl )

private

Trigger another round.

Parameters

sl	lock. this function must be called with the lock

Definition at line 150 of file LedgerReplayTask.cpp.

◆ tryAdvance()

void ripple::LedgerReplayTask::tryAdvance ( ScopedLockType & sl )

private

Try to build more ledgers.

Parameters

sl	lock. this function must be called with the lock

Definition at line 188 of file LedgerReplayTask.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 118 of file TimeoutCounter.cpp.

◆ setTimer()

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

protectedinherited

Schedule a call to queueJob() after mTimerInterval.

Definition at line 50 of file TimeoutCounter.cpp.

◆ queueJob()

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

protectedinherited

Queue a job to call invokeOnTimer().

Definition at line 69 of file TimeoutCounter.cpp.

◆ isDone()

bool ripple::TimeoutCounter::isDone ( ) const

protectedinherited

Definition at line 118 of file TimeoutCounter.h.

◆ invokeOnTimer()

void ripple::TimeoutCounter::invokeOnTimer ( )

privateinherited

Calls onTimer() if in the right state.

Only called by queueJob().

Definition at line 93 of file TimeoutCounter.cpp.

◆ getCounter()

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

staticprivatenoexceptinherited

Definition at line 129 of file CountedObject.h.

Friends And Related Symbol Documentation

◆ test::LedgerReplayClient

friend class test::LedgerReplayClient

friend

Definition at line 180 of file LedgerReplayTask.h.

Member Data Documentation

◆ inboundLedgers_

InboundLedgers& ripple::LedgerReplayTask::inboundLedgers_

private

Definition at line 171 of file LedgerReplayTask.h.

◆ replayer_

LedgerReplayer& ripple::LedgerReplayTask::replayer_

private

Definition at line 172 of file LedgerReplayTask.h.

◆ parameter_

TaskParameter ripple::LedgerReplayTask::parameter_

private

Definition at line 173 of file LedgerReplayTask.h.

◆ maxTimeouts_

uint32_t ripple::LedgerReplayTask::maxTimeouts_

private

Definition at line 174 of file LedgerReplayTask.h.

◆ skipListAcquirer_

std::shared_ptr<SkipListAcquire> ripple::LedgerReplayTask::skipListAcquirer_

private

Definition at line 175 of file LedgerReplayTask.h.

◆ parent_

std::shared_ptr<Ledger const> ripple::LedgerReplayTask::parent_ = {}

private

Definition at line 176 of file LedgerReplayTask.h.

◆ deltaToBuild_

uint32_t ripple::LedgerReplayTask::deltaToBuild_ = 0

private

Definition at line 177 of file LedgerReplayTask.h.

◆ deltas_

std::vector<std::shared_ptr<LedgerDeltaAcquire> > ripple::LedgerReplayTask::deltas_

private

Definition at line 178 of file LedgerReplayTask.h.

◆ app_

Application& ripple::TimeoutCounter::app_

protectedinherited

Definition at line 125 of file TimeoutCounter.h.

◆ journal_

beast::Journal ripple::TimeoutCounter::journal_

protectedinherited

Definition at line 126 of file TimeoutCounter.h.

◆ mtx_

std::recursive_mutex ripple::TimeoutCounter::mtx_

mutableprotectedinherited

Definition at line 127 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 131 of file TimeoutCounter.h.

◆ timeouts_

int ripple::TimeoutCounter::timeouts_

protectedinherited

Definition at line 132 of file TimeoutCounter.h.

◆ complete_

bool ripple::TimeoutCounter::complete_

protectedinherited

Definition at line 133 of file TimeoutCounter.h.

◆ failed_

bool ripple::TimeoutCounter::failed_

protectedinherited

Definition at line 134 of file TimeoutCounter.h.

◆ progress_

bool ripple::TimeoutCounter::progress_

protectedinherited

Whether forward progress has been made.

Definition at line 136 of file TimeoutCounter.h.

◆ timerInterval_

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

protectedinherited

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

Definition at line 138 of file TimeoutCounter.h.

◆ queueJobParameter_

QueueJobParameter ripple::TimeoutCounter::queueJobParameter_

protectedinherited

Definition at line 140 of file TimeoutCounter.h.

◆ timer_

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

privateinherited

Definition at line 149 of file TimeoutCounter.h.

Classes

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

◆ ScopedLockType

Constructor & Destructor Documentation

◆ LedgerReplayTask()

◆ ~LedgerReplayTask()

Member Function Documentation

◆ init()

◆ addDelta()

◆ getTaskParameter()

◆ finished()

◆ onTimer()

◆ pmDowncast()

◆ updateSkipList()

◆ deltaReady()

◆ trigger()

◆ tryAdvance()

◆ cancel()

◆ setTimer()

◆ queueJob()

◆ isDone()

◆ invokeOnTimer()

◆ getCounter()

Friends And Related Symbol Documentation

◆ test::LedgerReplayClient

Member Data Documentation

◆ inboundLedgers_

◆ replayer_

◆ parameter_

◆ maxTimeouts_

◆ skipListAcquirer_

◆ parent_

◆ deltaToBuild_

◆ deltas_

◆ app_

◆ journal_

◆ mtx_

◆ hash_

◆ timeouts_

◆ complete_

◆ failed_

◆ progress_

◆ timerInterval_

◆ queueJobParameter_

◆ timer_