Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
ExtractorInterface.hpp
1//------------------------------------------------------------------------------
2/*
3 This file is part of clio: https://github.com/XRPLF/clio
4 Copyright (c) 2024, the clio developers.
5
6 Permission to use, copy, modify, and distribute this software for any
7 purpose with or without fee is hereby granted, provided that the above
8 copyright notice and this permission notice appear in all copies.
9
10 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17*/
18//==============================================================================
19
20#pragma once
21
22#include "etlng/Models.hpp"
23
24#include <cstdint>
25#include <optional>
26
27namespace etlng {
28
33 virtual ~ExtractorInterface() = default;
34
41 [[nodiscard]] virtual std::optional<model::LedgerData>
42 extractLedgerWithDiff(uint32_t seq) = 0;
43
50 [[nodiscard]] virtual std::optional<model::LedgerData>
51 extractLedgerOnly(uint32_t seq) = 0;
52};
53
54} // namespace etlng
An interface for the Extractor.
Definition ExtractorInterface.hpp:32
virtual std::optional< model::LedgerData > extractLedgerWithDiff(uint32_t seq)=0
Extract diff data for a particular ledger.
virtual std::optional< model::LedgerData > extractLedgerOnly(uint32_t seq)=0
Extract data for a particular ledger.