Backend.h

#pragma once
 
#include <xrpl/basics/base_uint.h>
#include <xrpl/basics/contract.h>
#include <xrpl/nodestore/NodeObject.h>
#include <xrpl/nodestore/Types.h>
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <optional>
#include <stdexcept>
#include <string>
 
namespace xrpl::node_store {

class Backend
{
public:
    virtual ~Backend() = default;

    virtual std::string
    getName() = 0;

    [[nodiscard]] virtual std::optional<std::size_t>
    getBlockSize() const
    {
        return std::nullopt;
    }

    virtual void
    open(bool createIfMissing = true) = 0;

    virtual bool
    isOpen() = 0;

    virtual void
    open(bool createIfMissing, uint64_t appType, uint64_t uid, uint64_t salt)
    {
        Throw<std::runtime_error>(
            "Deterministic appType/uid/salt not supported by backend " + getName());
    }

    virtual void
    close() = 0;

    virtual Status
    fetch(uint256 const& hash, std::shared_ptr<NodeObject>* pObject) = 0;

    virtual void
    store(std::shared_ptr<NodeObject> const& object) = 0;

    virtual void
    storeBatch(Batch const& batch) = 0;
 
    virtual void
    sync() = 0;

    virtual void
    forEach(std::function<void(std::shared_ptr<NodeObject>)> f) = 0;

    virtual int
    getWriteLoad() = 0;

    virtual void
    setDeletePath() = 0;

    virtual void
    verify()
    {
    }

    [[nodiscard]] virtual int
    fdRequired() const = 0;
};
 
}  // namespace xrpl::node_store