Handles the download and import of one or more shard archives. More...

Inheritance diagram for ripple::RPC::ShardArchiveHandler:

Collaboration diagram for ripple::RPC::ShardArchiveHandler:

[legend]

Public Types
using	TimerOpCounter = ClosureCounter< void, boost::system::error_code const & >

Public Member Functions
	ShardArchiveHandler (Application &app, Stoppable &parent)

virtual	~ShardArchiveHandler ()=default

bool	init ()

bool	add (std::uint32_t shardIndex, std::pair< parsedURL, std::string > &&url)

bool	start ()
	Starts downloading and importing archives. More...

void	release ()

RootStoppable &	getRoot ()

void	setParent (Stoppable &parent)
	Set the parent of this Stoppable. More...

bool	isStopping () const
	Returns `true` if the stoppable should stop. More...

bool	isStopped () const
	Returns `true` if the requested stop has completed. More...

bool	areChildrenStopped () const
	Returns `true` if all children have stopped. More...

JobCounter &	jobCounter ()

bool	alertable_sleep_until (std::chrono::system_clock::time_point const &t)
	Sleep or wake up on stop. More...

Static Public Member Functions
static boost::filesystem::path	getDownloadDirectory (Config const &config)

static std::unique_ptr< ShardArchiveHandler >	makeShardArchiveHandler (Application &app, Stoppable &parent)

static std::unique_ptr< ShardArchiveHandler >	tryMakeRecoveryHandler (Application &app, Stoppable &parent)

Protected Member Functions
void	stopped ()
	Called by derived classes to indicate that the stoppable has stopped. More...

Private Types
using	Children = beast::LockFreeStack< Child >

Private Member Functions
	ShardArchiveHandler ()=delete

	ShardArchiveHandler (ShardArchiveHandler const &)=delete

ShardArchiveHandler &	operator= (ShardArchiveHandler &&)=delete

ShardArchiveHandler &	operator= (ShardArchiveHandler const &)=delete

bool	initFromDB (std::lock_guard< std::mutex > const &)

void	onStop () override
	Override called when the stop notification is issued. More...

bool	add (std::uint32_t shardIndex, parsedURL &&url, std::lock_guard< std::mutex > const &)
	Add an archive to be downloaded and imported. More...

bool	next (std::lock_guard< std::mutex > const &l)

void	complete (boost::filesystem::path dstPath)

void	process (boost::filesystem::path const &dstPath)

void	remove (std::lock_guard< std::mutex > const &)

void	doRelease (std::lock_guard< std::mutex > const &)

bool	onClosureFailed (std::string const &errorMsg, std::lock_guard< std::mutex > const &lock)

bool	removeAndProceed (std::lock_guard< std::mutex > const &lock)

virtual void	onPrepare ()
	Override called during preparation. More...

virtual void	onStart ()
	Override called during start. More...

virtual void	onChildrenStopped ()
	Override called when all children have stopped. More...

void	prepareRecursive ()

void	startRecursive ()

void	stopAsyncRecursive (beast::Journal j)

void	stopRecursive (beast::Journal j)

Private Attributes
std::mutex	m_

std::unique_ptr< DatabaseDownloader >	downloader_

std::map< std::uint32_t, parsedURL >	archives_

bool	process_

std::unique_ptr< DatabaseCon >	sqliteDB_

Application &	app_

const beast::Journal	j_

const boost::filesystem::path	downloadDir_

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

JobCounter	jobCounter_

TimerOpCounter	timerCounter_

ShardVerificationScheduler	verificationScheduler_

std::string	m_name

RootStoppable &	m_root

Child	m_child

std::atomic< bool >	m_stopped {false}

std::atomic< bool >	m_childrenStopped {false}

Children	m_children

std::condition_variable	m_cv

std::mutex	m_mut

bool	m_is_stopping = false

bool	hasParent_ {false}

Friends
class	test::ShardArchiveHandler_test

Detailed Description

Handles the download and import of one or more shard archives.

Definition at line 39 of file ShardArchiveHandler.h.

Member Typedef Documentation

◆ TimerOpCounter

using ripple::RPC::ShardArchiveHandler::TimerOpCounter = ClosureCounter<void, boost::system::error_code const&>

Definition at line 43 of file ShardArchiveHandler.h.

◆ Children

using ripple::Stoppable::Children = beast::LockFreeStack<Child>

privateinherited

Definition at line 318 of file Stoppable.h.

Constructor & Destructor Documentation

◆ ShardArchiveHandler() [1/3]

ripple::RPC::ShardArchiveHandler::ShardArchiveHandler	(	Application &	app,
		Stoppable &	parent
	)

Definition at line 71 of file ShardArchiveHandler.cpp.

◆ ~ShardArchiveHandler()

virtual ripple::RPC::ShardArchiveHandler::~ShardArchiveHandler ( )

virtualdefault

◆ ShardArchiveHandler() [2/3]

ripple::RPC::ShardArchiveHandler::ShardArchiveHandler ( )

privatedelete

◆ ShardArchiveHandler() [3/3]

ripple::RPC::ShardArchiveHandler::ShardArchiveHandler ( ShardArchiveHandler const & )

privatedelete

Member Function Documentation

◆ getDownloadDirectory()

boost::filesystem::path ripple::RPC::ShardArchiveHandler::getDownloadDirectory ( Config const & config )

static

Definition at line 37 of file ShardArchiveHandler.cpp.

◆ makeShardArchiveHandler()

std::unique_ptr< ShardArchiveHandler > ripple::RPC::ShardArchiveHandler::makeShardArchiveHandler	(	Application &	app,
		Stoppable &	parent
	)

static

Definition at line 48 of file ShardArchiveHandler.cpp.

◆ tryMakeRecoveryHandler()

std::unique_ptr< ShardArchiveHandler > ripple::RPC::ShardArchiveHandler::tryMakeRecoveryHandler	(	Application &	app,
		Stoppable &	parent
	)

static

Definition at line 56 of file ShardArchiveHandler.cpp.

◆ init()

bool ripple::RPC::ShardArchiveHandler::init ( )

Definition at line 91 of file ShardArchiveHandler.cpp.

◆ add() [1/2]

bool ripple::RPC::ShardArchiveHandler::add	(	std::uint32_t	shardIndex,
		std::pair< parsedURL, std::string > &&	url
	)

Definition at line 217 of file ShardArchiveHandler.cpp.

◆ start()

bool ripple::RPC::ShardArchiveHandler::start ( )

Starts downloading and importing archives.

Definition at line 259 of file ShardArchiveHandler.cpp.

◆ release()

void ripple::RPC::ShardArchiveHandler::release ( )

Definition at line 301 of file ShardArchiveHandler.cpp.

◆ operator=() [1/2]

ShardArchiveHandler& ripple::RPC::ShardArchiveHandler::operator= ( ShardArchiveHandler && )

privatedelete

◆ operator=() [2/2]

ShardArchiveHandler& ripple::RPC::ShardArchiveHandler::operator= ( ShardArchiveHandler const & )

privatedelete

◆ initFromDB()

bool ripple::RPC::ShardArchiveHandler::initFromDB ( std::lock_guard< std::mutex > const & lock )

private

Definition at line 137 of file ShardArchiveHandler.cpp.

◆ onStop()

void ripple::RPC::ShardArchiveHandler::onStop ( )

overrideprivatevirtual

Override called when the stop notification is issued.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation simply calls stopped(). This is applicable when the Stoppable has a trivial stop operation (or no stop operation), and we are merely using the Stoppable API to position it as a dependency of some parent service.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Reimplemented from ripple::Stoppable.

Definition at line 193 of file ShardArchiveHandler.cpp.

◆ add() [2/2]

bool ripple::RPC::ShardArchiveHandler::add	(	std::uint32_t	shardIndex,
		parsedURL &&	url,
		std::lock_guard< std::mutex > const &
	)

private

Add an archive to be downloaded and imported.

Parameters

shardIndex	the index of the shard to be imported.
url	the location of the archive.

Returns: true if successfully added.

Note: Returns false if called while downloading.

Definition at line 235 of file ShardArchiveHandler.cpp.

◆ next()

bool ripple::RPC::ShardArchiveHandler::next ( std::lock_guard< std::mutex > const & l )

private

Definition at line 308 of file ShardArchiveHandler.cpp.

◆ complete()

void ripple::RPC::ShardArchiveHandler::complete ( boost::filesystem::path dstPath )

private

Definition at line 401 of file ShardArchiveHandler.cpp.

◆ process()

void ripple::RPC::ShardArchiveHandler::process ( boost::filesystem::path const & dstPath )

private

Definition at line 482 of file ShardArchiveHandler.cpp.

◆ remove()

void ripple::RPC::ShardArchiveHandler::remove ( std::lock_guard< std::mutex > const & )

private

Definition at line 521 of file ShardArchiveHandler.cpp.

◆ doRelease()

void ripple::RPC::ShardArchiveHandler::doRelease ( std::lock_guard< std::mutex > const & )

private

Definition at line 546 of file ShardArchiveHandler.cpp.

◆ onClosureFailed()

bool ripple::RPC::ShardArchiveHandler::onClosureFailed	(	std::string const &	errorMsg,
		std::lock_guard< std::mutex > const &	lock
	)

private

Definition at line 577 of file ShardArchiveHandler.cpp.

◆ removeAndProceed()

bool ripple::RPC::ShardArchiveHandler::removeAndProceed ( std::lock_guard< std::mutex > const & lock )

private

Definition at line 590 of file ShardArchiveHandler.cpp.

◆ getRoot()

RootStoppable& ripple::Stoppable::getRoot ( )

inherited

Definition at line 213 of file Stoppable.h.

◆ setParent()

void ripple::Stoppable::setParent ( Stoppable & parent )

inherited

Set the parent of this Stoppable.

Note: The Stoppable must not already have a parent. The parent to be set cannot not be stopping. Both roots must match.

Definition at line 43 of file Stoppable.cpp.

◆ isStopping()

bool ripple::Stoppable::isStopping ( ) const

inherited

Returns true if the stoppable should stop.

Definition at line 54 of file Stoppable.cpp.

◆ isStopped()

bool ripple::Stoppable::isStopped ( ) const

inherited

Returns true if the requested stop has completed.

Definition at line 60 of file Stoppable.cpp.

◆ areChildrenStopped()

bool ripple::Stoppable::areChildrenStopped ( ) const

inherited

Returns true if all children have stopped.

Definition at line 66 of file Stoppable.cpp.

◆ jobCounter()

JobCounter & ripple::Stoppable::jobCounter ( )

inherited

Definition at line 436 of file Stoppable.h.

◆ alertable_sleep_until()

bool ripple::Stoppable::alertable_sleep_until ( std::chrono::system_clock::time_point const & t )

inherited

Sleep or wake up on stop.

Returns: true if we are stopping

Definition at line 454 of file Stoppable.h.

◆ stopped()

void ripple::Stoppable::stopped ( )

protectedinherited

Called by derived classes to indicate that the stoppable has stopped.

Definition at line 72 of file Stoppable.cpp.

◆ onPrepare()

void ripple::Stoppable::onPrepare ( )

privatevirtualinherited

Override called during preparation.

Since all other Stoppable objects in the tree have already been constructed, this provides an opportunity to perform initialization which depends on calling into other Stoppable objects. This call is made on the same thread that called prepare(). The default implementation does nothing. Guaranteed to only be called once.

Definition at line 80 of file Stoppable.cpp.

◆ onStart()

void ripple::Stoppable::onStart ( )

privatevirtualinherited

◆ onChildrenStopped()

void ripple::Stoppable::onChildrenStopped ( )

privatevirtualinherited

Override called when all children have stopped.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation does nothing.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Definition at line 96 of file Stoppable.cpp.

◆ prepareRecursive()

void ripple::Stoppable::prepareRecursive ( )

privateinherited

Definition at line 103 of file Stoppable.cpp.

◆ startRecursive()

void ripple::Stoppable::startRecursive ( )

privateinherited

Definition at line 113 of file Stoppable.cpp.

◆ stopAsyncRecursive()

void ripple::Stoppable::stopAsyncRecursive ( beast::Journal j )

privateinherited

Definition at line 123 of file Stoppable.cpp.

◆ stopRecursive()

void ripple::Stoppable::stopRecursive ( beast::Journal j )

privateinherited

Definition at line 134 of file Stoppable.cpp.

Friends And Related Function Documentation

◆ test::ShardArchiveHandler_test

friend class test::ShardArchiveHandler_test

friend

Definition at line 44 of file ShardArchiveHandler.h.

Member Data Documentation

◆ m_

std::mutex ripple::RPC::ShardArchiveHandler::m_

mutableprivate

Definition at line 132 of file ShardArchiveHandler.h.

◆ downloader_

std::unique_ptr<DatabaseDownloader> ripple::RPC::ShardArchiveHandler::downloader_

private

Definition at line 133 of file ShardArchiveHandler.h.

◆ archives_

std::map<std::uint32_t, parsedURL> ripple::RPC::ShardArchiveHandler::archives_

private

Definition at line 134 of file ShardArchiveHandler.h.

◆ process_

bool ripple::RPC::ShardArchiveHandler::process_

private

Definition at line 135 of file ShardArchiveHandler.h.

◆ sqliteDB_

std::unique_ptr<DatabaseCon> ripple::RPC::ShardArchiveHandler::sqliteDB_

private

Definition at line 136 of file ShardArchiveHandler.h.

◆ app_

Application& ripple::RPC::ShardArchiveHandler::app_

private

Definition at line 139 of file ShardArchiveHandler.h.

◆ j_

const beast::Journal ripple::RPC::ShardArchiveHandler::j_

private

Definition at line 140 of file ShardArchiveHandler.h.

◆ downloadDir_

const boost::filesystem::path ripple::RPC::ShardArchiveHandler::downloadDir_

private

Definition at line 141 of file ShardArchiveHandler.h.

◆ timer_

boost::asio::basic_waitable_timer<std::chrono::steady_clock> ripple::RPC::ShardArchiveHandler::timer_

private

Definition at line 142 of file ShardArchiveHandler.h.

◆ jobCounter_

JobCounter ripple::RPC::ShardArchiveHandler::jobCounter_

private

Definition at line 143 of file ShardArchiveHandler.h.

◆ timerCounter_

TimerOpCounter ripple::RPC::ShardArchiveHandler::timerCounter_

private

Definition at line 144 of file ShardArchiveHandler.h.

◆ verificationScheduler_

ShardVerificationScheduler ripple::RPC::ShardArchiveHandler::verificationScheduler_

private

Definition at line 145 of file ShardArchiveHandler.h.

◆ m_name

std::string ripple::Stoppable::m_name

privateinherited

Definition at line 338 of file Stoppable.h.

◆ m_root

RootStoppable& ripple::Stoppable::m_root

privateinherited

Definition at line 339 of file Stoppable.h.

◆ m_child

Child ripple::Stoppable::m_child

privateinherited

Definition at line 340 of file Stoppable.h.

◆ m_stopped

std::atomic<bool> ripple::Stoppable::m_stopped {false}

privateinherited

Definition at line 341 of file Stoppable.h.

◆ m_childrenStopped

std::atomic<bool> ripple::Stoppable::m_childrenStopped {false}

privateinherited

Definition at line 342 of file Stoppable.h.

◆ m_children

Children ripple::Stoppable::m_children

privateinherited

Definition at line 343 of file Stoppable.h.

◆ m_cv

std::condition_variable ripple::Stoppable::m_cv

privateinherited

Definition at line 344 of file Stoppable.h.

◆ m_mut

std::mutex ripple::Stoppable::m_mut

privateinherited

Definition at line 345 of file Stoppable.h.

◆ m_is_stopping

bool ripple::Stoppable::m_is_stopping = false

privateinherited

Definition at line 346 of file Stoppable.h.

◆ hasParent_

bool ripple::Stoppable::hasParent_ {false}

privateinherited

Definition at line 347 of file Stoppable.h.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ TimerOpCounter

◆ Children

Constructor & Destructor Documentation

◆ ShardArchiveHandler() [1/3]

◆ ~ShardArchiveHandler()

◆ ShardArchiveHandler() [2/3]

◆ ShardArchiveHandler() [3/3]

Member Function Documentation

◆ getDownloadDirectory()

◆ makeShardArchiveHandler()

◆ tryMakeRecoveryHandler()

◆ init()

◆ add() [1/2]

◆ start()

◆ release()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ initFromDB()

◆ onStop()

◆ add() [2/2]

◆ next()

◆ complete()

◆ process()

◆ remove()

◆ doRelease()

◆ onClosureFailed()

◆ removeAndProceed()

◆ getRoot()

◆ setParent()

◆ isStopping()

◆ isStopped()

◆ areChildrenStopped()

◆ jobCounter()

◆ alertable_sleep_until()

◆ stopped()

◆ onPrepare()

◆ onStart()

◆ onChildrenStopped()

◆ prepareRecursive()

◆ startRecursive()

◆ stopAsyncRecursive()

◆ stopRecursive()

Friends And Related Function Documentation

◆ test::ShardArchiveHandler_test

Member Data Documentation

◆ m_

◆ downloader_

◆ archives_

◆ process_

◆ sqliteDB_

◆ app_

◆ j_

◆ downloadDir_

◆ timer_

◆ jobCounter_

◆ timerCounter_

◆ verificationScheduler_

◆ m_name

◆ m_root

◆ m_child

◆ m_stopped

◆ m_childrenStopped

◆ m_children

◆ m_cv

◆ m_mut

◆ m_is_stopping

◆ hasParent_