LoadBalancerInterface.hpp

Go to the documentation of this file.

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2024, the clio developers.
 
    Permission to use, copy, modify, and 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.
*/
//==============================================================================

#pragma once
 
#include "etl/ETLState.hpp"
#include "etl/InitialLoadObserverInterface.hpp"
#include "rpc/Errors.hpp"
 
#include <boost/asio/spawn.hpp>
#include <boost/json/object.hpp>
#include <boost/json/value.hpp>
#include <org/xrpl/rpc/v1/ledger.pb.h>
#include <xrpl/proto/org/xrpl/rpc/v1/get_ledger.pb.h>
 
#include <chrono>
#include <cstdint>
#include <expected>
#include <optional>
#include <string>
#include <vector>
 
namespace etl {

enum class InitialLedgerLoadError {
    Cancelled, /*< Indicating the initial load got cancelled by user */
    Errored,   /*< Indicating some error happened during initial ledger load */
};

using InitialLedgerLoadResult = std::expected<std::vector<std::string>, InitialLedgerLoadError>;

class LoadBalancerInterface {
public:
    using RawLedgerObjectType = org::xrpl::rpc::v1::RawLedgerObject;
    using GetLedgerResponseType = org::xrpl::rpc::v1::GetLedgerResponse;
    using OptionalGetLedgerResponseType = std::optional<GetLedgerResponseType>;
 
    virtual ~LoadBalancerInterface() = default;

    [[nodiscard]] virtual InitialLedgerLoadResult
    loadInitialLedger(
        uint32_t sequence,
        InitialLoadObserverInterface& loader,
        std::chrono::steady_clock::duration retryAfter = std::chrono::seconds{2}
    ) = 0;

    [[nodiscard]] virtual OptionalGetLedgerResponseType
    fetchLedger(
        uint32_t ledgerSequence,
        bool getObjects,
        bool getObjectNeighbors,
        std::chrono::steady_clock::duration retryAfter = std::chrono::seconds{2}
    ) = 0;

    [[nodiscard]] virtual boost::json::value
    toJson() const = 0;

    [[nodiscard]] virtual std::expected<boost::json::object, rpc::CombinedError>
    forwardToRippled(
        boost::json::object const& request,
        std::optional<std::string> const& clientIp,
        bool isAdmin,
        boost::asio::yield_context yield
    ) = 0;

    [[nodiscard]] virtual std::optional<ETLState>
    getETLState() noexcept = 0;

    virtual void
    stop(boost::asio::yield_context yield) = 0;
};
 
}  // namespace etl