mirror of
https://github.com/XRPLF/clio.git
synced 2026-07-26 08:30:24 +00:00
fbdd6d6105
This PR adds an option to limit simultaneous cache loading in a cluster to one node at a time. Fixes #2707
92 lines
3.6 KiB
C++
92 lines
3.6 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of clio: https://github.com/XRPLF/clio
|
|
Copyright (c) 2025, 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 "data/LedgerCacheLoadingState.hpp"
|
|
#include "etl/WriterState.hpp"
|
|
|
|
#include <boost/json/conversion.hpp>
|
|
#include <boost/json/value.hpp>
|
|
#include <boost/uuid/uuid.hpp>
|
|
|
|
#include <chrono>
|
|
#include <memory>
|
|
|
|
namespace cluster {
|
|
|
|
/**
|
|
* @brief Represents a node in the cluster.
|
|
*/
|
|
struct ClioNode {
|
|
/**
|
|
* @brief The format of the time to store in the database.
|
|
*/
|
|
static constexpr char const* kTIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ";
|
|
|
|
/**
|
|
* @brief Database role of a node in the cluster.
|
|
*
|
|
* Roles are used to coordinate which node writes to the database:
|
|
* - ReadOnly: Node is configured to never write (strict read-only mode)
|
|
* - NotWriter: Node can write but is currently not the designated writer
|
|
* - Writer: Node is actively writing to the database
|
|
* - Fallback: Node is using the fallback writer decision mechanism
|
|
*
|
|
* When any node in the cluster is in Fallback mode, the entire cluster switches
|
|
* from the cluster communication mechanism to the slower but more reliable
|
|
* database-based conflict detection mechanism.
|
|
*/
|
|
enum class DbRole { ReadOnly = 0, NotWriter = 1, Writer = 2, Fallback = 3, MAX = 3 };
|
|
|
|
using Uuid = std::shared_ptr<boost::uuids::uuid>;
|
|
using CUuid = std::shared_ptr<boost::uuids::uuid const>;
|
|
|
|
Uuid uuid; ///< The UUID of the node.
|
|
std::chrono::system_clock::time_point
|
|
updateTime; ///< The time the data about the node was last updated.
|
|
DbRole dbRole; ///< The database role of the node
|
|
bool etlStarted; ///< Whether the ETL monitor has started on this node
|
|
bool cacheIsFull; ///< Whether the ledger cache is fully loaded on this node
|
|
bool cacheIsCurrentlyLoading; ///< Whether this node is currently loading the ledger cache
|
|
|
|
/**
|
|
* @brief Create a ClioNode from writer state and cache loading state.
|
|
*
|
|
* @param uuid The UUID of the node
|
|
* @param writerState The writer state to determine the node's database role
|
|
* @param cacheLoadingState The cache loading state to determine if cache is being loaded
|
|
* @return A ClioNode with the current time and role derived from writerState
|
|
*/
|
|
static ClioNode
|
|
from(
|
|
Uuid uuid,
|
|
etl::WriterStateInterface const& writerState,
|
|
data::LedgerCacheLoadingStateInterface const& cacheLoadingState
|
|
);
|
|
};
|
|
|
|
void
|
|
tag_invoke(boost::json::value_from_tag, boost::json::value& jv, ClioNode const& node);
|
|
|
|
ClioNode
|
|
tag_invoke(boost::json::value_to_tag<ClioNode>, boost::json::value const& jv);
|
|
|
|
} // namespace cluster
|