Files
xahaud/src/ripple/app/ledger/InboundLedgers.h
2021-06-01 15:36:28 -07:00

97 lines
2.8 KiB
C++

//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2012, 2013 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#ifndef RIPPLE_APP_LEDGER_INBOUNDLEDGERS_H_INCLUDED
#define RIPPLE_APP_LEDGER_INBOUNDLEDGERS_H_INCLUDED
#include <ripple/app/ledger/InboundLedger.h>
#include <ripple/protocol/RippleLedgerHash.h>
#include <memory>
namespace ripple {
/** Manages the lifetime of inbound ledgers.
@see InboundLedger
*/
class InboundLedgers
{
public:
using clock_type = beast::abstract_clock<std::chrono::steady_clock>;
virtual ~InboundLedgers() = default;
// VFALCO TODO Should this be called findOrAdd ?
//
virtual std::shared_ptr<Ledger const>
acquire(uint256 const& hash, std::uint32_t seq, InboundLedger::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;
/** Returns the rate of historical ledger fetches per minute. */
virtual std::size_t
fetchRate() = 0;
/** Called when a complete ledger is obtained. */
virtual void
onLedgerFetched() = 0;
virtual void
gotFetchPack() = 0;
virtual void
sweep() = 0;
virtual void
stop() = 0;
};
std::unique_ptr<InboundLedgers>
make_InboundLedgers(
Application& app,
InboundLedgers::clock_type& clock,
beast::insight::Collector::ptr const& collector);
} // namespace ripple
#endif