mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-22 12:05:53 +00:00
143 lines
16 KiB
HTML
143 lines
16 KiB
HTML
<!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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: Protocol.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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_1e765e6a8d5970800a535eb2615ec474.html">protocol</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Protocol.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_PROTOCOL_PROTOCOL_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_PROTOCOL_PROTOCOL_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/basics/base_uint.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/basics/ByteUtilities.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespaceripple.html#afdd3180ba6c0d82272a58f3f4f4f1197"> 39</a></span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> constexpr <a class="code" href="namespaceripple.html#afdd3180ba6c0d82272a58f3f4f4f1197">txMinSizeBytes</a> = 32;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespaceripple.html#a34a0fcba72dd7fe8833688cd314e3201"> 42</a></span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> constexpr <a class="code" href="namespaceripple.html#a34a0fcba72dd7fe8833688cd314e3201">txMaxSizeBytes</a> = <a class="code" href="namespaceripple.html#a13d7c6c34d30731bbc221f629e03f8db">megabytes</a>(1);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="namespaceripple.html#a7d68f79a2b6f8d40de6f5c45f133e97f"> 45</a></span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> constexpr <a class="code" href="namespaceripple.html#a7d68f79a2b6f8d40de6f5c45f133e97f">unfundedOfferRemoveLimit</a> = 1000;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="namespaceripple.html#a4fa9a45199e7918a98e750262ba7be96"> 48</a></span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> constexpr <a class="code" href="namespaceripple.html#a4fa9a45199e7918a98e750262ba7be96">oversizeMetaDataCap</a> = 5200;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="namespaceripple.html#aa92d4d5c77691ea9bf8a848d84187e39"> 51</a></span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> constexpr <a class="code" href="namespaceripple.html#aa92d4d5c77691ea9bf8a848d84187e39">dirNodeMaxEntries</a> = 32;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="namespaceripple.html#ac258349be8397bcc873d4eb789c70a6c"> 54</a></span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> constexpr <a class="code" href="namespaceripple.html#ac258349be8397bcc873d4eb789c70a6c">dirNodeMaxPages</a> = 262144;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd"> 57</a></span> <span class="keyword">using</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="namespaceripple.html#a3f39560bfd60c64700b109c412e90f72"> 63</a></span> <span class="keyword">using</span> <a class="code" href="classripple_1_1base__uint.html">TxID</a> = <a class="code" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="namespaceripple.html#a915c46a838a92e2e6eb2122b0f335af0"> 65</a></span> <span class="keyword">using</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">TxSeq</a> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <span class="comment">// ripple</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="anamespaceripple_html_afdd3180ba6c0d82272a58f3f4f4f1197"><div class="ttname"><a href="namespaceripple.html#afdd3180ba6c0d82272a58f3f4f4f1197">ripple::txMinSizeBytes</a></div><div class="ttdeci">constexpr std::size_t txMinSizeBytes</div><div class="ttdoc">Protocol specific constants, types, and data.</div><div class="ttdef"><b>Definition:</b> <a href="Protocol_8h_source.html#l00039">Protocol.h:39</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ac258349be8397bcc873d4eb789c70a6c"><div class="ttname"><a href="namespaceripple.html#ac258349be8397bcc873d4eb789c70a6c">ripple::dirNodeMaxPages</a></div><div class="ttdeci">constexpr std::uint64_t dirNodeMaxPages</div><div class="ttdoc">The maximum number of pages allowed in a directory.</div><div class="ttdef"><b>Definition:</b> <a href="Protocol_8h_source.html#l00054">Protocol.h:54</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a7d68f79a2b6f8d40de6f5c45f133e97f"><div class="ttname"><a href="namespaceripple.html#a7d68f79a2b6f8d40de6f5c45f133e97f">ripple::unfundedOfferRemoveLimit</a></div><div class="ttdeci">constexpr std::size_t unfundedOfferRemoveLimit</div><div class="ttdoc">The maximum number of unfunded offers to delete at once.</div><div class="ttdef"><b>Definition:</b> <a href="Protocol_8h_source.html#l00045">Protocol.h:45</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a356c68147333a9a48a344718038576d9"><div class="ttname"><a href="namespaceripple.html#a356c68147333a9a48a344718038576d9">ripple::uint256</a></div><div class="ttdeci">base_uint< 256 > uint256</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00436">base_uint.h:436</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint< 256 ></a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a13d7c6c34d30731bbc221f629e03f8db"><div class="ttname"><a href="namespaceripple.html#a13d7c6c34d30731bbc221f629e03f8db">ripple::megabytes</a></div><div class="ttdeci">constexpr auto megabytes(T value) noexcept</div><div class="ttdef"><b>Definition:</b> <a href="ByteUtilities_8h_source.html#l00032">ByteUtilities.h:32</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::uint64_t</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a34a0fcba72dd7fe8833688cd314e3201"><div class="ttname"><a href="namespaceripple.html#a34a0fcba72dd7fe8833688cd314e3201">ripple::txMaxSizeBytes</a></div><div class="ttdeci">constexpr std::size_t txMaxSizeBytes</div><div class="ttdoc">Largest legal byte size of a transaction.</div><div class="ttdef"><b>Definition:</b> <a href="Protocol_8h_source.html#l00042">Protocol.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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a4fa9a45199e7918a98e750262ba7be96"><div class="ttname"><a href="namespaceripple.html#a4fa9a45199e7918a98e750262ba7be96">ripple::oversizeMetaDataCap</a></div><div class="ttdeci">constexpr std::size_t oversizeMetaDataCap</div><div class="ttdoc">The maximum number of metadata entries allowed in one transaction.</div><div class="ttdef"><b>Definition:</b> <a href="Protocol_8h_source.html#l00048">Protocol.h:48</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="anamespaceripple_html_aa92d4d5c77691ea9bf8a848d84187e39"><div class="ttname"><a href="namespaceripple.html#aa92d4d5c77691ea9bf8a848d84187e39">ripple::dirNodeMaxEntries</a></div><div class="ttdeci">constexpr std::size_t dirNodeMaxEntries</div><div class="ttdoc">The maximum number of entries per directory page.</div><div class="ttdef"><b>Definition:</b> <a href="Protocol_8h_source.html#l00051">Protocol.h:51</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|