ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/Key_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

171 lines
20 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: Key.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_68f79f171b7159941f300783854c1b48.html">resource</a></li><li class="navelem"><a class="el" href="dir_83cc80d895ddee2dee79c9a486487346.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Key.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_RESOURCE_KEY_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_RESOURCE_KEY_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/net/IPEndpoint.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/resource/detail/Kind.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span>Resource {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// The consumer key</span></div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html"> 12</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1Resource_1_1Key.html">Key</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>{</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3"> 14</a></span> <a class="code hl_enumeration" href="namespaceripple_1_1Resource.html#a21bb0387f51ba0f1dc971bce94ffbac9">Kind</a> <a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">kind</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1"> 15</a></span> <a class="code hl_class" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> <a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html#a483cbc9cc036eea28a3108b87ce8feaa"> 17</a></span> <a class="code hl_function" href="structripple_1_1Resource_1_1Key.html#a483cbc9cc036eea28a3108b87ce8feaa">Key</a>() = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="}">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html#a9094d5a54f1309099ff6694bde27730b"> 19</a></span> <a class="code hl_function" href="structripple_1_1Resource_1_1Key.html#a9094d5a54f1309099ff6694bde27730b">Key</a>(<a class="code hl_enumeration" href="namespaceripple_1_1Resource.html#a21bb0387f51ba0f1dc971bce94ffbac9">Kind</a> k, <a class="code hl_class" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> <span class="keyword">const</span>&amp; addr) : <a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">kind</a>(k), <a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a>(addr)</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> }</div>
</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="};">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1hasher.html"> 23</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1Resource_1_1Key_1_1hasher.html">hasher</a></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
<div class="foldopen" id="foldopen00026" data-start="{" data-end="}">
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1hasher.html#a83f34d25b4dbfe584b9d4ab0cd67ad9f"> 26</a></span> <a class="code hl_function" href="structripple_1_1Resource_1_1Key_1_1hasher.html#a83f34d25b4dbfe584b9d4ab0cd67ad9f">operator()</a>(<a class="code hl_struct" href="structripple_1_1Resource_1_1Key.html">Key</a> <span class="keyword">const</span>&amp; v)<span class="keyword"> const</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="structripple_1_1Resource_1_1Key_1_1hasher.html#afa7f29a1b9846e82dd658e3ef044d47f">m_addr_hash</a>(v.<a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a>);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> }</div>
</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1hasher.html#afa7f29a1b9846e82dd658e3ef044d47f"> 32</a></span> <a class="code hl_struct" href="structbeast_1_1uhash.html">beast::uhash&lt;&gt;</a> <a class="code hl_variable" href="structripple_1_1Resource_1_1Key_1_1hasher.html#afa7f29a1b9846e82dd658e3ef044d47f">m_addr_hash</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> };</div>
</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="};">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1key__equal.html"> 35</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1Resource_1_1Key_1_1key__equal.html">key_equal</a></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1key__equal.html#ab08fdb2959f9abc66e65247e94110cc2"> 37</a></span> <a class="code hl_function" href="structripple_1_1Resource_1_1Key_1_1key__equal.html#ab08fdb2959f9abc66e65247e94110cc2">key_equal</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00040" data-start="{" data-end="}">
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1key__equal.html#a9feb32547539b275265c7b6bfda5f1c6"> 40</a></span> <a class="code hl_function" href="structripple_1_1Resource_1_1Key_1_1key__equal.html#a9feb32547539b275265c7b6bfda5f1c6">operator()</a>(<a class="code hl_struct" href="structripple_1_1Resource_1_1Key.html">Key</a> <span class="keyword">const</span>&amp; lhs, <a class="code hl_struct" href="structripple_1_1Resource_1_1Key.html">Key</a> <span class="keyword">const</span>&amp; rhs)<span class="keyword"> const</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">return</span> lhs.<a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">kind</a> == rhs.<a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">kind</a> &amp;&amp; lhs.<a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a> == rhs.<a class="code hl_variable" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> };</div>
</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>};</div>
</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>} <span class="comment">// namespace Resource</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassbeast_1_1IP_1_1Endpoint_html"><div class="ttname"><a href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a></div><div class="ttdoc">A version-independent IP address and port combination.</div><div class="ttdef"><b>Definition</b> <a href="IPEndpoint_8h_source.html#l00018">IPEndpoint.h:19</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a21bb0387f51ba0f1dc971bce94ffbac9"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a21bb0387f51ba0f1dc971bce94ffbac9">ripple::Resource::Kind</a></div><div class="ttdeci">Kind</div><div class="ttdoc">Kind of consumer.</div><div class="ttdef"><b>Definition</b> <a href="Kind_8h_source.html#l00015">Kind.h:15</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="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="astructbeast_1_1uhash_html"><div class="ttname"><a href="structbeast_1_1uhash.html">beast::uhash</a></div><div class="ttdef"><b>Definition</b> <a href="uhash_8h_source.html#l00011">uhash.h:12</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_1_1hasher_html"><div class="ttname"><a href="structripple_1_1Resource_1_1Key_1_1hasher.html">ripple::Resource::Key::hasher</a></div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00023">Key.h:24</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_1_1hasher_html_a83f34d25b4dbfe584b9d4ab0cd67ad9f"><div class="ttname"><a href="structripple_1_1Resource_1_1Key_1_1hasher.html#a83f34d25b4dbfe584b9d4ab0cd67ad9f">ripple::Resource::Key::hasher::operator()</a></div><div class="ttdeci">std::size_t operator()(Key const &amp;v) const</div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00026">Key.h:26</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_1_1hasher_html_afa7f29a1b9846e82dd658e3ef044d47f"><div class="ttname"><a href="structripple_1_1Resource_1_1Key_1_1hasher.html#afa7f29a1b9846e82dd658e3ef044d47f">ripple::Resource::Key::hasher::m_addr_hash</a></div><div class="ttdeci">beast::uhash m_addr_hash</div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00032">Key.h:32</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_1_1key__equal_html"><div class="ttname"><a href="structripple_1_1Resource_1_1Key_1_1key__equal.html">ripple::Resource::Key::key_equal</a></div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00035">Key.h:36</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_1_1key__equal_html_a9feb32547539b275265c7b6bfda5f1c6"><div class="ttname"><a href="structripple_1_1Resource_1_1Key_1_1key__equal.html#a9feb32547539b275265c7b6bfda5f1c6">ripple::Resource::Key::key_equal::operator()</a></div><div class="ttdeci">bool operator()(Key const &amp;lhs, Key const &amp;rhs) const</div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00040">Key.h:40</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_1_1key__equal_html_ab08fdb2959f9abc66e65247e94110cc2"><div class="ttname"><a href="structripple_1_1Resource_1_1Key_1_1key__equal.html#ab08fdb2959f9abc66e65247e94110cc2">ripple::Resource::Key::key_equal::key_equal</a></div><div class="ttdeci">key_equal()=default</div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_html"><div class="ttname"><a href="structripple_1_1Resource_1_1Key.html">ripple::Resource::Key</a></div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00012">Key.h:13</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_html_a055d0599801371df81ecc35087076fa1"><div class="ttname"><a href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">ripple::Resource::Key::address</a></div><div class="ttdeci">beast::IP::Endpoint address</div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00015">Key.h:15</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_html_a483cbc9cc036eea28a3108b87ce8feaa"><div class="ttname"><a href="structripple_1_1Resource_1_1Key.html#a483cbc9cc036eea28a3108b87ce8feaa">ripple::Resource::Key::Key</a></div><div class="ttdeci">Key()=delete</div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_html_a9094d5a54f1309099ff6694bde27730b"><div class="ttname"><a href="structripple_1_1Resource_1_1Key.html#a9094d5a54f1309099ff6694bde27730b">ripple::Resource::Key::Key</a></div><div class="ttdeci">Key(Kind k, beast::IP::Endpoint const &amp;addr)</div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00019">Key.h:19</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Key_html_afc16c2cbfed9837b2f1eb9554c0f21e3"><div class="ttname"><a href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">ripple::Resource::Key::kind</a></div><div class="ttdeci">Kind kind</div><div class="ttdef"><b>Definition</b> <a href="Key_8h_source.html#l00014">Key.h:14</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