Entry.h

#pragma once
 
#include <xrpl/basics/DecayingSample.h>
#include <xrpl/beast/clock/abstract_clock.h>
#include <xrpl/beast/core/List.h>
#include <xrpl/protocol/PublicKey.h>
#include <xrpl/resource/detail/Key.h>
#include <xrpl/resource/detail/Tuning.h>
 
#include <chrono>
#include <optional>
#include <ostream>
#include <string>
 
namespace xrpl::resource {
 
using ClockType = beast::AbstractClock<std::chrono::steady_clock>;
 
// An entry in the table
// VFALCO DEPRECATED using boost::intrusive list
struct Entry : public beast::List<Entry>::Node
{
    Entry() = delete;

    explicit Entry(ClockType::time_point const now)
        : refcount(0), localBalance(now), remoteBalance(0)
    {
    }
 
    [[nodiscard]] std::string
    toString() const
    {
        return getFingerprint(key->address, publicKey);
    }

    [[nodiscard]] bool
    isUnlimited() const
    {
        return key->kind == Kind::Unlimited;
    }
 
    // Balance including remote contributions
    int
    balance(ClockType::time_point const now)
    {
        return localBalance.value(now) + remoteBalance;
    }
 
    // Add a charge and return normalized balance
    // including contributions from imports.
    int
    add(int charge, ClockType::time_point const now)
    {
        return localBalance.add(charge, now) + remoteBalance;
    }
 
    // The public key of the peer
    std::optional<PublicKey> publicKey;
 
    // Back pointer to the map key (bit of a hack here)
    Key const* key{};
 
    // Number of Consumer references
    int refcount;
 
    // Exponentially decaying balance of resource consumption
    DecayingSample<kDecayWindowSeconds, ClockType> localBalance;
 
    // Normalized balance contribution from imports
    int remoteBalance;
 
    // Time of the last warning
    ClockType::time_point lastWarningTime;
 
    // For inactive entries, time after which this entry will be erased
    ClockType::time_point whenExpires;
};
 
inline std::ostream&
operator<<(std::ostream& os, Entry const& v)
{
    os << v.toString();
    return os;
}
 
}  // namespace xrpl::resource