Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
etlng::ExtractorInterface Struct Referenceabstract

An interface for the Extractor. More...

#include <ExtractorInterface.hpp>

Inheritance diagram for etlng::ExtractorInterface:

Public Member Functions

virtual std::optional< model::LedgerDataextractLedgerWithDiff (uint32_t seq)=0
 Extract diff data for a particular ledger.
 
virtual std::optional< model::LedgerDataextractLedgerOnly (uint32_t seq)=0
 Extract data for a particular ledger.
 

Detailed Description

An interface for the Extractor.

Member Function Documentation

◆ extractLedgerOnly()

virtual std::optional< model::LedgerData > etlng::ExtractorInterface::extractLedgerOnly ( uint32_t seq)
nodiscardpure virtual

Extract data for a particular ledger.

Parameters
seqsequence of the ledger to extract
Returns
Ledger header and transaction+metadata blobs if available

Implemented in etlng::impl::Extractor.

◆ extractLedgerWithDiff()

virtual std::optional< model::LedgerData > etlng::ExtractorInterface::extractLedgerWithDiff ( uint32_t seq)
nodiscardpure virtual

Extract diff data for a particular ledger.

Parameters
seqsequence of the ledger to extract
Returns
Ledger data diff between sequence and parent if available

Implemented in etlng::impl::Extractor.


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