InboundLedgers.h

#pragma once
 
#include <xrpld/app/ledger/InboundLedger.h>
#include <xrpld/app/main/Application.h>
#include <xrpld/overlay/Peer.h>
 
#include <xrpl/basics/base_uint.h>
#include <xrpl/beast/clock/abstract_clock.h>
#include <xrpl/beast/insight/Collector.h>
#include <xrpl/json/json_value.h>
#include <xrpl/ledger/Ledger.h>
#include <xrpl/protocol/RippleLedgerHash.h>
 
#include <xrpl.pb.h>
 
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <memory>
 
namespace xrpl {

class InboundLedgers
{
public:
    using ClockType = beast::AbstractClock<std::chrono::steady_clock>;
 
    virtual ~InboundLedgers() = default;
 
    // Callers should use this if they possibly need an authoritative
    // response immediately.
    virtual std::shared_ptr<Ledger const>
    acquire(UInt256 const& hash, std::uint32_t seq, InboundLedger::Reason) = 0;
 
    // Callers should use this if they are known to be executing on the Job
    // Queue. TODO review whether all callers of acquire() can use this
    // instead. Inbound ledger acquisition is asynchronous anyway.
    virtual void
    acquireAsync(UInt256 const& hash, std::uint32_t seq, InboundLedger::Reason reason) = 0;
 
    virtual std::shared_ptr<InboundLedger>
    find(LedgerHash const& hash) = 0;
 
    // VFALCO TODO Remove the dependency on the Peer object.
    //
    virtual bool
    gotLedgerData(
        LedgerHash const& ledgerHash,
        std::shared_ptr<Peer>,
        std::shared_ptr<protocol::TMLedgerData>) = 0;
 
    virtual void
    gotStaleData(std::shared_ptr<protocol::TMLedgerData> packet) = 0;
 
    virtual void
    logFailure(UInt256 const& h, std::uint32_t seq) = 0;
 
    virtual bool
    isFailure(UInt256 const& h) = 0;
 
    virtual void
    clearFailures() = 0;
 
    virtual json::Value
    getInfo() = 0;

    virtual std::size_t
    fetchRate() = 0;

    virtual void
    onLedgerFetched() = 0;
 
    virtual void
    gotFetchPack() = 0;
    virtual void
    sweep() = 0;
 
    virtual void
    stop() = 0;
 
    virtual std::size_t
    cacheSize() = 0;
};
 
std::unique_ptr<InboundLedgers>
makeInboundLedgers(
    Application& app,
    InboundLedgers::ClockType& clock,
    beast::insight::Collector::Ptr const& collector);
 
}  // namespace xrpl