mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
97 lines
3.3 KiB
C++
97 lines
3.3 KiB
C++
#ifndef XRPL_PROTOCOL_APIVERSION_H_INCLUDED
|
|
#define XRPL_PROTOCOL_APIVERSION_H_INCLUDED
|
|
|
|
#include <type_traits>
|
|
#include <utility>
|
|
|
|
namespace ripple {
|
|
|
|
/**
|
|
* API version numbers used in later API versions
|
|
*
|
|
* Requests with a version number in the range
|
|
* [apiMinimumSupportedVersion, apiMaximumSupportedVersion]
|
|
* are supported.
|
|
*
|
|
* If [beta_rpc_api] is enabled in config, the version numbers
|
|
* in the range [apiMinimumSupportedVersion, apiBetaVersion]
|
|
* are supported.
|
|
*
|
|
* Network Requests without explicit version numbers use
|
|
* apiVersionIfUnspecified. apiVersionIfUnspecified is 1,
|
|
* because all the RPC requests with a version >= 2 must
|
|
* explicitly specify the version in the requests.
|
|
* Note that apiVersionIfUnspecified will be lower than
|
|
* apiMinimumSupportedVersion when we stop supporting API
|
|
* version 1.
|
|
*
|
|
* Command line Requests use apiCommandLineVersion.
|
|
*/
|
|
|
|
namespace RPC {
|
|
|
|
template <unsigned int Version>
|
|
constexpr static std::integral_constant<unsigned, Version> apiVersion = {};
|
|
|
|
constexpr static auto apiInvalidVersion = apiVersion<0>;
|
|
constexpr static auto apiMinimumSupportedVersion = apiVersion<1>;
|
|
constexpr static auto apiMaximumSupportedVersion = apiVersion<2>;
|
|
constexpr static auto apiVersionIfUnspecified = apiVersion<1>;
|
|
constexpr static auto apiCommandLineVersion =
|
|
apiVersion<1>; // TODO Bump to 2 later
|
|
constexpr static auto apiBetaVersion = apiVersion<3>;
|
|
constexpr static auto apiMaximumValidVersion = apiBetaVersion;
|
|
|
|
static_assert(apiInvalidVersion < apiMinimumSupportedVersion);
|
|
static_assert(
|
|
apiVersionIfUnspecified >= apiMinimumSupportedVersion &&
|
|
apiVersionIfUnspecified <= apiMaximumSupportedVersion);
|
|
static_assert(
|
|
apiCommandLineVersion >= apiMinimumSupportedVersion &&
|
|
apiCommandLineVersion <= apiMaximumSupportedVersion);
|
|
static_assert(apiMaximumSupportedVersion >= apiMinimumSupportedVersion);
|
|
static_assert(apiBetaVersion >= apiMaximumSupportedVersion);
|
|
static_assert(apiMaximumValidVersion >= apiMaximumSupportedVersion);
|
|
|
|
} // namespace RPC
|
|
|
|
template <unsigned minVer, unsigned maxVer, typename Fn, typename... Args>
|
|
void
|
|
forApiVersions(Fn const& fn, Args&&... args)
|
|
requires //
|
|
(maxVer >= minVer) && //
|
|
(minVer >= RPC::apiMinimumSupportedVersion) && //
|
|
(RPC::apiMaximumValidVersion >= maxVer) && requires {
|
|
fn(std::integral_constant<unsigned int, minVer>{},
|
|
std::forward<Args>(args)...);
|
|
fn(std::integral_constant<unsigned int, maxVer>{},
|
|
std::forward<Args>(args)...);
|
|
}
|
|
{
|
|
constexpr auto size = maxVer + 1 - minVer;
|
|
[&]<std::size_t... offset>(std::index_sequence<offset...>) {
|
|
(((void)fn(
|
|
std::integral_constant<unsigned int, minVer + offset>{},
|
|
std::forward<Args>(args)...)),
|
|
...);
|
|
}(std::make_index_sequence<size>{});
|
|
}
|
|
|
|
template <typename Fn, typename... Args>
|
|
void
|
|
forAllApiVersions(Fn const& fn, Args&&... args)
|
|
requires requires {
|
|
forApiVersions<
|
|
RPC::apiMinimumSupportedVersion,
|
|
RPC::apiMaximumValidVersion>(fn, std::forward<Args>(args)...);
|
|
}
|
|
{
|
|
forApiVersions<
|
|
RPC::apiMinimumSupportedVersion,
|
|
RPC::apiMaximumValidVersion>(fn, std::forward<Args>(args)...);
|
|
}
|
|
|
|
} // namespace ripple
|
|
|
|
#endif
|