ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/ApiVersion_8h_source.html
bthomee 7ca054b7d3 deploy: 3b810c305a
2025-11-10 09:36:27 -08:00

262 lines
40 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ApiVersion.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_8d04e3c0b58cad28d7755ed462d1b6c0.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ApiVersion.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_PROTOCOL_APIVERSION_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_PROTOCOL_APIVERSION_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/beast/core/SemanticVersion.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/beast/utility/instrumentation.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/json/json_value.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/protocol/jss.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a>&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a>&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="foldopen" id="foldopen00036" data-start="{" data-end="}">
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html"> 36</a></span><span class="keyword">namespace </span>RPC {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">template</span> &lt;<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Version&gt;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a47dbdaa21d9c40b369424e671ccd7e20"> 39</a></span><span class="keyword">constexpr</span> <span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integral_constant.html">std::integral_constant&lt;unsigned, Version&gt;</a> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a47dbdaa21d9c40b369424e671ccd7e20">apiVersion</a> = {};</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#ac444ee3babf6fcf2604699ee4ae2e777"> 41</a></span><span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ac444ee3babf6fcf2604699ee4ae2e777">apiInvalidVersion</a> = apiVersion&lt;0&gt;;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6"> 42</a></span><span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">apiMinimumSupportedVersion</a> = apiVersion&lt;1&gt;;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32"> 43</a></span><span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">apiMaximumSupportedVersion</a> = apiVersion&lt;2&gt;;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a9e992ce4d974403f94f4daf62aa18761"> 44</a></span><span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a9e992ce4d974403f94f4daf62aa18761">apiVersionIfUnspecified</a> = apiVersion&lt;1&gt;;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a626a04a639c6df49e8de0d9d8b569bf3"> 45</a></span><span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a626a04a639c6df49e8de0d9d8b569bf3">apiCommandLineVersion</a> =</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> apiVersion&lt;1&gt;; <span class="comment">// TODO Bump to 2 later</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a63c1a4ab8820cf80f6f0e49ca041e9a0"> 47</a></span><span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a63c1a4ab8820cf80f6f0e49ca041e9a0">apiBetaVersion</a> = apiVersion&lt;3&gt;;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09"> 48</a></span><span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">apiMaximumValidVersion</a> = <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a63c1a4ab8820cf80f6f0e49ca041e9a0">apiBetaVersion</a>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="keyword">static_assert</span>(<a class="code hl_variable" href="namespaceripple_1_1RPC.html#ac444ee3babf6fcf2604699ee4ae2e777">apiInvalidVersion</a> &lt; <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">apiMinimumSupportedVersion</a>);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="keyword">static_assert</span>(</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a9e992ce4d974403f94f4daf62aa18761">apiVersionIfUnspecified</a> &gt;= <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">apiMinimumSupportedVersion</a> &amp;&amp;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a9e992ce4d974403f94f4daf62aa18761">apiVersionIfUnspecified</a> &lt;= <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">apiMaximumSupportedVersion</a>);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keyword">static_assert</span>(</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a626a04a639c6df49e8de0d9d8b569bf3">apiCommandLineVersion</a> &gt;= <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">apiMinimumSupportedVersion</a> &amp;&amp;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a626a04a639c6df49e8de0d9d8b569bf3">apiCommandLineVersion</a> &lt;= <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">apiMaximumSupportedVersion</a>);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="keyword">static_assert</span>(<a class="code hl_variable" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">apiMaximumSupportedVersion</a> &gt;= <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">apiMinimumSupportedVersion</a>);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="keyword">static_assert</span>(<a class="code hl_variable" href="namespaceripple_1_1RPC.html#a63c1a4ab8820cf80f6f0e49ca041e9a0">apiBetaVersion</a> &gt;= <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">apiMaximumSupportedVersion</a>);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword">static_assert</span>(<a class="code hl_variable" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">apiMaximumValidVersion</a> &gt;= <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">apiMaximumSupportedVersion</a>);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> JsonObject&gt;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00063" data-start="{" data-end="}">
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a22d5b7097ef2a30d9b968b82ecb6c991"> 63</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#a22d5b7097ef2a30d9b968b82ecb6c991">setVersion</a>(JsonObject&amp; parent, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a47dbdaa21d9c40b369424e671ccd7e20">apiVersion</a>, <span class="keywordtype">bool</span> betaEnabled)</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>{</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> XRPL_ASSERT(</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a47dbdaa21d9c40b369424e671ccd7e20">apiVersion</a> != <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ac444ee3babf6fcf2604699ee4ae2e777">apiInvalidVersion</a>,</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="stringliteral">&quot;ripple::RPC::setVersion : input is valid&quot;</span>);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">auto</span>&amp; retObj = addObject(parent, jss::version);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="namespaceripple_1_1RPC.html#a47dbdaa21d9c40b369424e671ccd7e20">apiVersion</a> == <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a9e992ce4d974403f94f4daf62aa18761">apiVersionIfUnspecified</a>)</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> {</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// API version numbers used in API version 1</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">static</span> <a class="code hl_class" href="classbeast_1_1SemanticVersion.html">beast::SemanticVersion</a> <span class="keyword">const</span> firstVersion{<span class="stringliteral">&quot;1.0.0&quot;</span>};</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">static</span> <a class="code hl_class" href="classbeast_1_1SemanticVersion.html">beast::SemanticVersion</a> <span class="keyword">const</span> goodVersion{<span class="stringliteral">&quot;1.0.0&quot;</span>};</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">static</span> <a class="code hl_class" href="classbeast_1_1SemanticVersion.html">beast::SemanticVersion</a> <span class="keyword">const</span> lastVersion{<span class="stringliteral">&quot;1.0.0&quot;</span>};</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> retObj[jss::first] = firstVersion.<a class="code hl_function" href="classbeast_1_1SemanticVersion.html#aab2063f8b5f916d56d34c81bad003ec3">print</a>();</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> retObj[jss::good] = goodVersion.print();</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> retObj[jss::last] = lastVersion.print();</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> {</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> retObj[jss::first] = <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">apiMinimumSupportedVersion</a>.value;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> retObj[jss::last] =</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> betaEnabled ? <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a63c1a4ab8820cf80f6f0e49ca041e9a0">apiBetaVersion</a> : <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">apiMaximumSupportedVersion</a>;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> }</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>}</div>
</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span></div>
<div class="foldopen" id="foldopen00104" data-start="{" data-end="}">
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#ad8fbfe3fd4651227fd4df999f60921d6"> 104</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#ad8fbfe3fd4651227fd4df999f60921d6">getAPIVersionNumber</a>(<a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span>&amp; jv, <span class="keywordtype">bool</span> betaEnabled)</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>{</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">static</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span> minVersion(<a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">RPC::apiMinimumSupportedVersion</a>);</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span> maxVersion(</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> betaEnabled ? <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a63c1a4ab8820cf80f6f0e49ca041e9a0">RPC::apiBetaVersion</a> : <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">RPC::apiMaximumSupportedVersion</a>);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keywordflow">if</span> (jv.<a class="code hl_function" href="classJson_1_1Value.html#a8cf96c0f2a552051fcfc78ffee60e037">isObject</a>())</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> {</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keywordflow">if</span> (jv.<a class="code hl_function" href="classJson_1_1Value.html#abfa90c81f6aee7877bd5fb4c8445994f">isMember</a>(jss::api_version))</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> {</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">auto</span> <span class="keyword">const</span> specifiedVersion = jv[jss::api_version];</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordflow">if</span> (!specifiedVersion.isInt() &amp;&amp; !specifiedVersion.isUInt())</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> {</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ac444ee3babf6fcf2604699ee4ae2e777">RPC::apiInvalidVersion</a>;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> }</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keyword">auto</span> <span class="keyword">const</span> specifiedVersionInt = specifiedVersion.<a class="code hl_function" href="classJson_1_1Value.html#a614d635bc248a592593feb322cd15ab8">asInt</a>();</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordflow">if</span> (specifiedVersionInt &lt; minVersion ||</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> specifiedVersionInt &gt; maxVersion)</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> {</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ac444ee3babf6fcf2604699ee4ae2e777">RPC::apiInvalidVersion</a>;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> }</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="keywordflow">return</span> specifiedVersionInt;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> }</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> }</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a9e992ce4d974403f94f4daf62aa18761">RPC::apiVersionIfUnspecified</a>;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span>}</div>
</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span>} <span class="comment">// namespace RPC</span></div>
</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="keyword">template</span> &lt;<span class="keywordtype">unsigned</span> minVer, <span class="keywordtype">unsigned</span> maxVer, <span class="keyword">typename</span> Fn, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00136" data-start="{" data-end="}">
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="namespaceripple.html#afa35799caaa5a9f071b8bf4dfb1ed766"> 136</a></span><a class="code hl_function" href="namespaceripple.html#afa35799caaa5a9f071b8bf4dfb1ed766">forApiVersions</a>(Fn <span class="keyword">const</span>&amp; fn, Args&amp;&amp;... args)</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">requires</span> <span class="comment">//</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> (maxVer &gt;= minVer) &amp;&amp; <span class="comment">//</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> (minVer &gt;= <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">RPC::apiMinimumSupportedVersion</a>) &amp;&amp; <span class="comment">//</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> (<a class="code hl_variable" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">RPC::apiMaximumValidVersion</a> &gt;= maxVer) &amp;&amp; <span class="keyword">requires</span> {</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> fn(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integral_constant.html">std::integral_constant&lt;unsigned int, minVer&gt;</a>{},</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward&lt;Args&gt;</a>(args)...);</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> fn(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integral_constant.html">std::integral_constant&lt;unsigned int, maxVer&gt;</a>{},</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward&lt;Args&gt;</a>(args)...);</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> }</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span>{</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> size = maxVer + 1 - minVer;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> [&amp;]&lt;<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>... offset&gt;(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/integer_sequence.html">std::index_sequence</a>&lt;offset...&gt;) {</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> (((void)fn(</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integral_constant.html">std::integral_constant&lt;unsigned int, minVer + offset&gt;</a>{},</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward&lt;Args&gt;</a>(args)...)),</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> ...);</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> }(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/integer_sequence.html">std::make_index_sequence&lt;size&gt;</a>{});</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span>}</div>
</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> </div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Fn, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00158" data-start="{" data-end="}">
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="namespaceripple.html#a9f8b4ebe6b42066b9e39967ed80daf79"> 158</a></span><a class="code hl_function" href="namespaceripple.html#a9f8b4ebe6b42066b9e39967ed80daf79">forAllApiVersions</a>(Fn <span class="keyword">const</span>&amp; fn, Args&amp;&amp;... args)</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <span class="keyword">requires</span> <span class="keyword">requires</span> {</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> <a class="code hl_function" href="namespaceripple.html#afa35799caaa5a9f071b8bf4dfb1ed766">forApiVersions</a>&lt;</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">RPC::apiMinimumSupportedVersion</a>,</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">RPC::apiMaximumValidVersion</a>&gt;(fn, <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward&lt;Args&gt;</a>(args)...);</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> }</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span>{</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <a class="code hl_function" href="namespaceripple.html#afa35799caaa5a9f071b8bf4dfb1ed766">forApiVersions</a>&lt;</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">RPC::apiMinimumSupportedVersion</a>,</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">RPC::apiMaximumValidVersion</a>&gt;(fn, <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward&lt;Args&gt;</a>(args)...);</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span>}</div>
</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00130">json_value.h:131</a></div></div>
<div class="ttc" id="aclassJson_1_1Value_html_a614d635bc248a592593feb322cd15ab8"><div class="ttname"><a href="classJson_1_1Value.html#a614d635bc248a592593feb322cd15ab8">Json::Value::asInt</a></div><div class="ttdeci">Int asInt() const</div><div class="ttdef"><b>Definition</b> <a href="json__value_8cpp_source.html#l00507">json_value.cpp:507</a></div></div>
<div class="ttc" id="aclassJson_1_1Value_html_a8cf96c0f2a552051fcfc78ffee60e037"><div class="ttname"><a href="classJson_1_1Value.html#a8cf96c0f2a552051fcfc78ffee60e037">Json::Value::isObject</a></div><div class="ttdeci">bool isObject() const</div><div class="ttdef"><b>Definition</b> <a href="json__value_8cpp_source.html#l01127">json_value.cpp:1127</a></div></div>
<div class="ttc" id="aclassJson_1_1Value_html_abfa90c81f6aee7877bd5fb4c8445994f"><div class="ttname"><a href="classJson_1_1Value.html#abfa90c81f6aee7877bd5fb4c8445994f">Json::Value::isMember</a></div><div class="ttdeci">bool isMember(char const *key) const</div><div class="ttdoc">Return true if the object has a member named key.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8cpp_source.html#l01030">json_value.cpp:1030</a></div></div>
<div class="ttc" id="aclassbeast_1_1SemanticVersion_html"><div class="ttname"><a href="classbeast_1_1SemanticVersion.html">beast::SemanticVersion</a></div><div class="ttdoc">A Semantic Version number.</div><div class="ttdef"><b>Definition</b> <a href="SemanticVersion_8h_source.html#l00016">SemanticVersion.h:17</a></div></div>
<div class="ttc" id="aclassbeast_1_1SemanticVersion_html_aab2063f8b5f916d56d34c81bad003ec3"><div class="ttname"><a href="classbeast_1_1SemanticVersion.html#aab2063f8b5f916d56d34c81bad003ec3">beast::SemanticVersion::print</a></div><div class="ttdeci">std::string print() const</div><div class="ttdoc">Produce a string from semantic version components.</div><div class="ttdef"><b>Definition</b> <a href="SemanticVersion_8cpp_source.html#l00221">SemanticVersion.cpp:221</a></div></div>
<div class="ttc" id="ainteger_sequence_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/integer_sequence.html">std::index_sequence</a></div></div>
<div class="ttc" id="aintegral_constant_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integral_constant.html">std::integral_constant</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a22d5b7097ef2a30d9b968b82ecb6c991"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a22d5b7097ef2a30d9b968b82ecb6c991">ripple::RPC::setVersion</a></div><div class="ttdeci">void setVersion(JsonObject &amp;parent, unsigned int apiVersion, bool betaEnabled)</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00063">ApiVersion.h:63</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a2b3ccf6ba58d8b93038397557338bc32"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a2b3ccf6ba58d8b93038397557338bc32">ripple::RPC::apiMaximumSupportedVersion</a></div><div class="ttdeci">static constexpr auto apiMaximumSupportedVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00043">ApiVersion.h:43</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a47dbdaa21d9c40b369424e671ccd7e20"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a47dbdaa21d9c40b369424e671ccd7e20">ripple::RPC::apiVersion</a></div><div class="ttdeci">static constexpr std::integral_constant&lt; unsigned, Version &gt; apiVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00039">ApiVersion.h:39</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a5cef6660176a48dd32d433358f579f09"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">ripple::RPC::apiMaximumValidVersion</a></div><div class="ttdeci">static constexpr auto apiMaximumValidVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00048">ApiVersion.h:48</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a626a04a639c6df49e8de0d9d8b569bf3"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a626a04a639c6df49e8de0d9d8b569bf3">ripple::RPC::apiCommandLineVersion</a></div><div class="ttdeci">static constexpr auto apiCommandLineVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00045">ApiVersion.h:45</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a63c1a4ab8820cf80f6f0e49ca041e9a0"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a63c1a4ab8820cf80f6f0e49ca041e9a0">ripple::RPC::apiBetaVersion</a></div><div class="ttdeci">static constexpr auto apiBetaVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00047">ApiVersion.h:47</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a9e992ce4d974403f94f4daf62aa18761"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a9e992ce4d974403f94f4daf62aa18761">ripple::RPC::apiVersionIfUnspecified</a></div><div class="ttdeci">static constexpr auto apiVersionIfUnspecified</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00044">ApiVersion.h:44</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_ac444ee3babf6fcf2604699ee4ae2e777"><div class="ttname"><a href="namespaceripple_1_1RPC.html#ac444ee3babf6fcf2604699ee4ae2e777">ripple::RPC::apiInvalidVersion</a></div><div class="ttdeci">static constexpr auto apiInvalidVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00041">ApiVersion.h:41</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_ad8fbfe3fd4651227fd4df999f60921d6"><div class="ttname"><a href="namespaceripple_1_1RPC.html#ad8fbfe3fd4651227fd4df999f60921d6">ripple::RPC::getAPIVersionNumber</a></div><div class="ttdeci">unsigned int getAPIVersionNumber(Json::Value const &amp;jv, bool betaEnabled)</div><div class="ttdoc">Retrieve the api version number from the json value.</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00104">ApiVersion.h:104</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_ad9e8e104e82c67f071a254fa6849afe6"><div class="ttname"><a href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">ripple::RPC::apiMinimumSupportedVersion</a></div><div class="ttdeci">static constexpr auto apiMinimumSupportedVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00042">ApiVersion.h:42</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a9f8b4ebe6b42066b9e39967ed80daf79"><div class="ttname"><a href="namespaceripple.html#a9f8b4ebe6b42066b9e39967ed80daf79">ripple::forAllApiVersions</a></div><div class="ttdeci">void forAllApiVersions(Fn const &amp;fn, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00158">ApiVersion.h:158</a></div></div>
<div class="ttc" id="anamespaceripple_html_afa35799caaa5a9f071b8bf4dfb1ed766"><div class="ttname"><a href="namespaceripple.html#afa35799caaa5a9f071b8bf4dfb1ed766">ripple::forApiVersions</a></div><div class="ttdeci">void forApiVersions(Fn const &amp;fn, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00136">ApiVersion.h:136</a></div></div>
<div class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
<div class="ttc" id="atype_traits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a></div></div>
<div class="ttc" id="autility_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink