mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
128 lines
13 KiB
HTML
128 lines
13 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: Keylet.cpp 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><li class="navelem"><a class="el" href="dir_41c387a0f328eeb295307369675c1162.html">impl</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Keylet.cpp</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">#include <ripple/protocol/Keylet.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <ripple/protocol/STLedgerEntry.h></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="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structripple_1_1Keylet.html#a1e8ccd4a50a894a338c789fc566d8802"> 26</a></span> <a class="code" href="structripple_1_1Keylet.html#a1e8ccd4a50a894a338c789fc566d8802">Keylet::check</a>(<a class="code" href="classripple_1_1STLedgerEntry.html">STLedgerEntry</a> <span class="keyword">const</span>& sle)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  assert(sle.<a class="code" href="classripple_1_1STLedgerEntry.html#a3c289baf99474db3d44d381e43358723">getType</a>() != <a class="code" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139a926f3c33237e0c1bb2d4cb8afc0c82b4">ltANY</a> || sle.<a class="code" href="classripple_1_1STLedgerEntry.html#a3c289baf99474db3d44d381e43358723">getType</a>() != <a class="code" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139a822b27579a5bc94b9dea2395852e5bbd">ltCHILD</a>);</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">if</span> (<a class="code" href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">type</a> == <a class="code" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139a926f3c33237e0c1bb2d4cb8afc0c82b4">ltANY</a>)</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">if</span> (<a class="code" href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">type</a> == <a class="code" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139a822b27579a5bc94b9dea2395852e5bbd">ltCHILD</a>)</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">return</span> sle.<a class="code" href="classripple_1_1STLedgerEntry.html#a3c289baf99474db3d44d381e43358723">getType</a>() != <a class="code" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139a1ca6f5da9e86f814af3d6f8b3631ebe8">ltDIR_NODE</a>;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">return</span> sle.<a class="code" href="classripple_1_1STLedgerEntry.html#a3c289baf99474db3d44d381e43358723">getType</a>() == <a class="code" href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">type</a>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> }</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> } <span class="comment">// namespace ripple</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1STLedgerEntry_html"><div class="ttname"><a href="classripple_1_1STLedgerEntry.html">ripple::STLedgerEntry</a></div><div class="ttdef"><b>Definition:</b> <a href="STLedgerEntry_8h_source.html#l00030">STLedgerEntry.h:30</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ac151bf19e1f4daae2b04c65c65117139a926f3c33237e0c1bb2d4cb8afc0c82b4"><div class="ttname"><a href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139a926f3c33237e0c1bb2d4cb8afc0c82b4">ripple::ltANY</a></div><div class="ttdeci">@ ltANY</div><div class="ttdoc">A special type, matching any ledger entry type.</div><div class="ttdef"><b>Definition:</b> <a href="LedgerFormats_8h_source.html#l00176">LedgerFormats.h:176</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ac151bf19e1f4daae2b04c65c65117139a822b27579a5bc94b9dea2395852e5bbd"><div class="ttname"><a href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139a822b27579a5bc94b9dea2395852e5bbd">ripple::ltCHILD</a></div><div class="ttdeci">@ ltCHILD</div><div class="ttdoc">A special type, matching any ledger type except directory nodes.</div><div class="ttdef"><b>Definition:</b> <a href="LedgerFormats_8h_source.html#l00189">LedgerFormats.h:189</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ac151bf19e1f4daae2b04c65c65117139a1ca6f5da9e86f814af3d6f8b3631ebe8"><div class="ttname"><a href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139a1ca6f5da9e86f814af3d6f8b3631ebe8">ripple::ltDIR_NODE</a></div><div class="ttdeci">@ ltDIR_NODE</div><div class="ttdoc">A ledger object which contains a list of object identifiers.</div><div class="ttdef"><b>Definition:</b> <a href="LedgerFormats_8h_source.html#l00066">LedgerFormats.h:66</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1Keylet_html_a194d83c488eaa909ae4bcf816d8f4cb0"><div class="ttname"><a href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">ripple::Keylet::type</a></div><div class="ttdeci">LedgerEntryType type</div><div class="ttdef"><b>Definition:</b> <a href="Keylet_8h_source.html#l00041">Keylet.h:41</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1STLedgerEntry_html_a3c289baf99474db3d44d381e43358723"><div class="ttname"><a href="classripple_1_1STLedgerEntry.html#a3c289baf99474db3d44d381e43358723">ripple::STLedgerEntry::getType</a></div><div class="ttdeci">LedgerEntryType getType() const</div><div class="ttdef"><b>Definition:</b> <a href="STLedgerEntry_8h_source.html#l00119">STLedgerEntry.h:119</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="astructripple_1_1Keylet_html_a1e8ccd4a50a894a338c789fc566d8802"><div class="ttname"><a href="structripple_1_1Keylet.html#a1e8ccd4a50a894a338c789fc566d8802">ripple::Keylet::check</a></div><div class="ttdeci">bool check(STLedgerEntry const &) const</div><div class="ttdoc">Returns true if the SLE matches the type.</div><div class="ttdef"><b>Definition:</b> <a href="Keylet_8cpp_source.html#l00026">Keylet.cpp:26</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>
|