etl::LedgerFetcherInterface Struct Reference

An interface for LedgerFetcher. More...

#include <LedgerFetcherInterface.hpp>

Public Types
using	GetLedgerResponseType = org::xrpl::rpc::v1::GetLedgerResponse
using	OptionalGetLedgerResponseType = std::optional<GetLedgerResponseType>

Public Member Functions
virtual OptionalGetLedgerResponseType	fetchData (uint32_t seq)=0
	Extract data for a particular ledger from an ETL source.
virtual OptionalGetLedgerResponseType	fetchDataAndDiff (uint32_t seq)=0
	Extract diff data for a particular ledger from an ETL source.

Detailed Description

An interface for LedgerFetcher.

Member Function Documentation

fetchData()

virtual OptionalGetLedgerResponseType etl::LedgerFetcherInterface::fetchData ( uint32_t seq )

nodiscardpure virtual

Extract data for a particular ledger from an ETL source.

This function continously tries to extract the specified ledger (using all available ETL sources) until the extraction succeeds, or the server shuts down.

Parameters

seq	sequence of the ledger to extract

Returns

Ledger header and transaction+metadata blobs; Empty optional if the server is shutting down

fetchDataAndDiff()

virtual OptionalGetLedgerResponseType etl::LedgerFetcherInterface::fetchDataAndDiff ( uint32_t seq )

nodiscardpure virtual

Extract diff data for a particular ledger from an ETL source.

This function continously tries to extract the specified ledger (using all available ETL sources) until the extraction succeeds, or the server shuts down.

Parameters

seq	sequence of the ledger to extract

Returns

Ledger data diff between sequance and parent; Empty optional if the server is shutting down

---

The documentation for this struct was generated from the following file:

• /__w/clio/clio/src/etl/LedgerFetcherInterface.hpp