ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-28 06:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0fbb85bfbcc632ce51cd630a3d5514bd1163a730
rippled/namespaceripple_1_1BuildInfo.html
bthomee 0fbb85bfbc deploy: 11edaa441d
2025-06-04 17:59:59 +00:00

359 lines
20 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::BuildInfo Namespace Reference</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.5 -->
<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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1BuildInfo.html">BuildInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">ripple::BuildInfo Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Versioning information for this build.
<a href="namespaceripple_1_1BuildInfo.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8aa97a762a323b5f5e96db0a2fc1e33a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#a8aa97a762a323b5f5e96db0a2fc1e33a">getVersionString</a> ()</td></tr>
<tr class="memdesc:a8aa97a762a323b5f5e96db0a2fc1e33a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Server.html" title="A multi-protocol server.">Server</a> version. <a href="namespaceripple_1_1BuildInfo.html#a8aa97a762a323b5f5e96db0a2fc1e33a">More...</a><br /></td></tr>
<tr class="separator:a8aa97a762a323b5f5e96db0a2fc1e33a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e2b1646cf948c1c19ff190903c3e789"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#a1e2b1646cf948c1c19ff190903c3e789">getFullVersionString</a> ()</td></tr>
<tr class="memdesc:a1e2b1646cf948c1c19ff190903c3e789"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full server version string. <a href="namespaceripple_1_1BuildInfo.html#a1e2b1646cf948c1c19ff190903c3e789">More...</a><br /></td></tr>
<tr class="separator:a1e2b1646cf948c1c19ff190903c3e789"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33be2c6d6273d5cf9f743f9f45478646"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#a33be2c6d6273d5cf9f743f9f45478646">encodeSoftwareVersion</a> (char const *const versionStr)</td></tr>
<tr class="memdesc:a33be2c6d6273d5cf9f743f9f45478646"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode an arbitrary server software version in a 64-bit integer. <a href="namespaceripple_1_1BuildInfo.html#a33be2c6d6273d5cf9f743f9f45478646">More...</a><br /></td></tr>
<tr class="separator:a33be2c6d6273d5cf9f743f9f45478646"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a035daabd8a04c8b068a503761a1a3392"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#a035daabd8a04c8b068a503761a1a3392">getEncodedVersion</a> ()</td></tr>
<tr class="memdesc:a035daabd8a04c8b068a503761a1a3392"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns this server's version packed in a 64-bit integer. <a href="namespaceripple_1_1BuildInfo.html#a035daabd8a04c8b068a503761a1a3392">More...</a><br /></td></tr>
<tr class="separator:a035daabd8a04c8b068a503761a1a3392"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78c52e19009a32c3d05a43c59f864bd3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#a78c52e19009a32c3d05a43c59f864bd3">isRippledVersion</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> version)</td></tr>
<tr class="memdesc:a78c52e19009a32c3d05a43c59f864bd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the encoded software version is a rippled software version. <a href="namespaceripple_1_1BuildInfo.html#a78c52e19009a32c3d05a43c59f864bd3">More...</a><br /></td></tr>
<tr class="separator:a78c52e19009a32c3d05a43c59f864bd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5883781365410de620622c6a2b1b81d5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#a5883781365410de620622c6a2b1b81d5">isNewerVersion</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> version)</td></tr>
<tr class="memdesc:a5883781365410de620622c6a2b1b81d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the version is newer than the local node's rippled software version. <a href="namespaceripple_1_1BuildInfo.html#a5883781365410de620622c6a2b1b81d5">More...</a><br /></td></tr>
<tr class="separator:a5883781365410de620622c6a2b1b81d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:add98d1ad0d107ee61a6ace72d982cf36"><td class="memItemLeft" align="right" valign="top">char const *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#add98d1ad0d107ee61a6ace72d982cf36">versionString</a> = &quot;2.5.0-rc1&quot;</td></tr>
<tr class="separator:add98d1ad0d107ee61a6ace72d982cf36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f9689f7affc4d0b0c9e63869fd0deeb"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#a3f9689f7affc4d0b0c9e63869fd0deeb">implementationVersionIdentifier</a></td></tr>
<tr class="separator:a3f9689f7affc4d0b0c9e63869fd0deeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84938ab5d39de8b8e0a85035abf6aeb9"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1BuildInfo.html#a84938ab5d39de8b8e0a85035abf6aeb9">implementationVersionIdentifierMask</a></td></tr>
<tr class="separator:a84938ab5d39de8b8e0a85035abf6aeb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Versioning information for this build. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a8aa97a762a323b5f5e96db0a2fc1e33a" name="a8aa97a762a323b5f5e96db0a2fc1e33a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8aa97a762a323b5f5e96db0a2fc1e33a">&#9670;&#160;</a></span>getVersionString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp; ripple::BuildInfo::getVersionString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Server.html" title="A multi-protocol server.">Server</a> version. </p>
<p >Follows the Semantic Versioning Specification: <a href="http://semver.org/">http://semver.org/</a> </p>
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00068">68</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
<a id="a1e2b1646cf948c1c19ff190903c3e789" name="a1e2b1646cf948c1c19ff190903c3e789"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e2b1646cf948c1c19ff190903c3e789">&#9670;&#160;</a></span>getFullVersionString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp; ripple::BuildInfo::getFullVersionString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Full server version string. </p>
<p >This includes the name of the server. It is used in the peer protocol hello message and also the headers of some HTTP replies. </p>
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00081">81</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
<a id="a33be2c6d6273d5cf9f743f9f45478646" name="a33be2c6d6273d5cf9f743f9f45478646"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33be2c6d6273d5cf9f743f9f45478646">&#9670;&#160;</a></span>encodeSoftwareVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> ripple::BuildInfo::encodeSoftwareVersion </td>
<td>(</td>
<td class="paramtype">char const *const&#160;</td>
<td class="paramname"><em>versionStr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode an arbitrary server software version in a 64-bit integer. </p>
<p >The general format is:</p>
<p >........-........-........-........-........-........-........-........ XXXXXXXX-XXXXXXXX-YYYYYYYY-YYYYYYYY-YYYYYYYY-YYYYYYYY-YYYYYYYY-YYYYYYYY</p>
<p >X: 16 bits identifying the particular implementation Y: 48 bits of data specific to the implementation</p>
<p >The rippled-specific format (implementation ID is: 0x18 0x3B) is:</p>
<p >00011000-00111011-MMMMMMMM-mmmmmmmm-pppppppp-TTNNNNNN-00000000-00000000 </p><pre class="fragment">M: 8-bit major version (0-255)
m: 8-bit minor version (0-255)
p: 8-bit patch version (0-255)
T: 11 if neither an RC nor a beta
10 if an RC
01 if a beta
N: 6-bit rc/beta number (1-63)
</pre> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">the</td><td>version string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the encoded version in a 64-bit integer </dd></dl>
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00093">93</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
<a id="a035daabd8a04c8b068a503761a1a3392" name="a035daabd8a04c8b068a503761a1a3392"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a035daabd8a04c8b068a503761a1a3392">&#9670;&#160;</a></span>getEncodedVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> ripple::BuildInfo::getEncodedVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns this server's version packed in a 64-bit integer. </p>
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00158">158</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
<a id="a78c52e19009a32c3d05a43c59f864bd3" name="a78c52e19009a32c3d05a43c59f864bd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78c52e19009a32c3d05a43c59f864bd3">&#9670;&#160;</a></span>isRippledVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::BuildInfo::isRippledVersion </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td>
<td class="paramname"><em>version</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the encoded software version is a rippled software version. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">version</td><td>another node's encoded software version </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the version is a rippled software version, false otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00165">165</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
<a id="a5883781365410de620622c6a2b1b81d5" name="a5883781365410de620622c6a2b1b81d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5883781365410de620622c6a2b1b81d5">&#9670;&#160;</a></span>isNewerVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::BuildInfo::isNewerVersion </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td>
<td class="paramname"><em>version</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the version is newer than the local node's rippled software version. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">version</td><td>another node's encoded software version </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the version is newer than the local node's rippled software version, false otherwise.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function only understands version numbers that are generated by rippled. Please see the <a class="el" href="namespaceripple_1_1BuildInfo.html#a33be2c6d6273d5cf9f743f9f45478646" title="Encode an arbitrary server software version in a 64-bit integer.">encodeSoftwareVersion()</a> function for detail. </dd></dl>
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00172">172</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="add98d1ad0d107ee61a6ace72d982cf36" name="add98d1ad0d107ee61a6ace72d982cf36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add98d1ad0d107ee61a6ace72d982cf36">&#9670;&#160;</a></span>versionString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char const* const ripple::BuildInfo::versionString = &quot;2.5.0-rc1&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00039">39</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
<a id="a3f9689f7affc4d0b0c9e63869fd0deeb" name="a3f9689f7affc4d0b0c9e63869fd0deeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f9689f7affc4d0b0c9e63869fd0deeb">&#9670;&#160;</a></span>implementationVersionIdentifier</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> ripple::BuildInfo::implementationVersionIdentifier</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> 0x183B&#39;0000&#39;0000&#39;0000LLU</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00087">87</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
<a id="a84938ab5d39de8b8e0a85035abf6aeb9" name="a84938ab5d39de8b8e0a85035abf6aeb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84938ab5d39de8b8e0a85035abf6aeb9">&#9670;&#160;</a></span>implementationVersionIdentifierMask</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> ripple::BuildInfo::implementationVersionIdentifierMask</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> 0xFFFF&#39;0000&#39;0000&#39;0000LLU</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="BuildInfo_8cpp_source.html#l00089">89</a> of file <a class="el" href="BuildInfo_8cpp_source.html">BuildInfo.cpp</a>.</p>
</div>
</div>
</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink