ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-02-04 05:55:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b9ef07fc10ff9ab5d7eebb9ef057e335fa5786a7
rippled/ProtocolVersion_8h_source.html
bthomee a661b19a31 deploy: 1eb0fdac65
2025-12-11 08:55:10 -08:00

151 lines
16 KiB
HTML
Raw 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: ProtocolVersion.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_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c4f38cd849aa2a8e7280b7c5f705957a.html">overlay</a></li><li class="navelem"><a class="el" href="dir_a79f2d25ef1e73674b335287bd5311a8.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ProtocolVersion.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_OVERLAY_PROTOCOLVERSION_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_OVERLAY_PROTOCOLVERSION_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;boost/beast/core/string.hpp&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a>&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>&gt;</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/utility.html">utility</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/vector.html">vector</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="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="namespacexrpl.html#a0fcee5e8220b150f9bc95f69c707e552"> 19</a></span><span class="keyword">using </span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">ProtocolVersion</a> = <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;std::uint16_t, std::uint16_t&gt;</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">inline</span> <span class="keyword">constexpr</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">ProtocolVersion</a></div>
<div class="foldopen" id="foldopen00022" data-start="{" data-end="}">
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="namespacexrpl.html#a4b90747a90a4a1cd4ba2e50aeb3bc42b"> 22</a></span><a class="code hl_function" href="namespacexrpl.html#a4b90747a90a4a1cd4ba2e50aeb3bc42b">make_protocol</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> major, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> minor)</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>{</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">return</span> {major, minor};</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>}</div>
</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(<a class="code hl_typedef" href="namespacexrpl.html#a0fcee5e8220b150f9bc95f69c707e552">ProtocolVersion</a> <span class="keyword">const</span>&amp; p);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;ProtocolVersion&gt;</a></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><a class="code hl_function" href="namespacexrpl.html#a018197fc6fe4c21c8955506920cc1161">parseProtocolVersions</a>(boost::beast::string_view <span class="keyword">const</span>&amp; s);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;ProtocolVersion&gt;</a></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><a class="code hl_function" href="namespacexrpl.html#a36f066fbcdc7b4da0121d7c5382e6cae">negotiateProtocolVersion</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;ProtocolVersion&gt;</a> <span class="keyword">const</span>&amp; versions);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;ProtocolVersion&gt;</a></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><a class="code hl_function" href="namespacexrpl.html#a36f066fbcdc7b4da0121d7c5382e6cae">negotiateProtocolVersion</a>(boost::beast::string_view <span class="keyword">const</span>&amp; versions);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><a class="code hl_function" href="namespacexrpl.html#acbd810dacedaf3599a1908ffbf0afb49">supportedProtocolVersions</a>();</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><a class="code hl_function" href="namespacexrpl.html#a2899d7e86d2993bba546f762cb6a9979">isProtocolSupported</a>(<a class="code hl_typedef" href="namespacexrpl.html#a0fcee5e8220b150f9bc95f69c707e552">ProtocolVersion</a> <span class="keyword">const</span>&amp; v);</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="comment">// namespace xrpl</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</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="anamespacexrpl_html_a018197fc6fe4c21c8955506920cc1161"><div class="ttname"><a href="namespacexrpl.html#a018197fc6fe4c21c8955506920cc1161">xrpl::parseProtocolVersions</a></div><div class="ttdeci">std::vector&lt; ProtocolVersion &gt; parseProtocolVersions(boost::beast::string_view const &amp;value)</div><div class="ttdoc">Parse a set of protocol versions.</div><div class="ttdef"><b>Definition</b> <a href="ProtocolVersion_8cpp_source.html#l00062">ProtocolVersion.cpp:62</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a0fcee5e8220b150f9bc95f69c707e552"><div class="ttname"><a href="namespacexrpl.html#a0fcee5e8220b150f9bc95f69c707e552">xrpl::ProtocolVersion</a></div><div class="ttdeci">std::pair&lt; std::uint16_t, std::uint16_t &gt; ProtocolVersion</div><div class="ttdoc">Represents a particular version of the peer-to-peer protocol.</div><div class="ttdef"><b>Definition</b> <a href="ProtocolVersion_8h_source.html#l00019">ProtocolVersion.h:19</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a2899d7e86d2993bba546f762cb6a9979"><div class="ttname"><a href="namespacexrpl.html#a2899d7e86d2993bba546f762cb6a9979">xrpl::isProtocolSupported</a></div><div class="ttdeci">bool isProtocolSupported(ProtocolVersion const &amp;v)</div><div class="ttdoc">Determine whether we support a specific protocol version.</div><div class="ttdef"><b>Definition</b> <a href="ProtocolVersion_8cpp_source.html#l00158">ProtocolVersion.cpp:158</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a35ce7572092b98720a52fa343c6f2fa9"><div class="ttname"><a href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">xrpl::to_string</a></div><div class="ttdeci">std::string to_string(base_uint&lt; Bits, Tag &gt; const &amp;a)</div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00611">base_uint.h:611</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a36f066fbcdc7b4da0121d7c5382e6cae"><div class="ttname"><a href="namespacexrpl.html#a36f066fbcdc7b4da0121d7c5382e6cae">xrpl::negotiateProtocolVersion</a></div><div class="ttdeci">std::optional&lt; ProtocolVersion &gt; negotiateProtocolVersion(std::vector&lt; ProtocolVersion &gt; const &amp;versions)</div><div class="ttdoc">Given a list of supported protocol versions, choose the one we prefer.</div><div class="ttdef"><b>Definition</b> <a href="ProtocolVersion_8cpp_source.html#l00109">ProtocolVersion.cpp:109</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a4b90747a90a4a1cd4ba2e50aeb3bc42b"><div class="ttname"><a href="namespacexrpl.html#a4b90747a90a4a1cd4ba2e50aeb3bc42b">xrpl::make_protocol</a></div><div class="ttdeci">constexpr ProtocolVersion make_protocol(std::uint16_t major, std::uint16_t minor)</div><div class="ttdef"><b>Definition</b> <a href="ProtocolVersion_8h_source.html#l00022">ProtocolVersion.h:22</a></div></div>
<div class="ttc" id="anamespacexrpl_html_acbd810dacedaf3599a1908ffbf0afb49"><div class="ttname"><a href="namespacexrpl.html#acbd810dacedaf3599a1908ffbf0afb49">xrpl::supportedProtocolVersions</a></div><div class="ttdeci">std::string const &amp; supportedProtocolVersions()</div><div class="ttdoc">The list of all the protocol versions we support.</div><div class="ttdef"><b>Definition</b> <a href="ProtocolVersion_8cpp_source.html#l00140">ProtocolVersion.cpp:140</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a></div></div>
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a></div></div>
<div class="ttc" id="astring_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/string.html">string</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 class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/vector.html">vector</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