Files
rippled/Key_8h_source.html
2021-03-12 22:34:28 +00:00

169 lines
21 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: 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 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&amp;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&amp;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_a49d03dbe37362975c505cb11669e4db.html">resource</a></li><li class="navelem"><a class="el" href="dir_aba2e5a74369646cde66327ddb8ef67e.html">impl</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 name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<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>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_RESOURCE_KEY_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_RESOURCE_KEY_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/beast/net/IPEndpoint.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;ripple/resource/impl/Kind.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<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>&#160;<span class="keyword">namespace </span>Resource {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">// The consumer key</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html"> 31</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structripple_1_1Resource_1_1Key.html">Key</a></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3"> 33</a></span>&#160; <a class="code" href="namespaceripple_1_1Resource.html#a21bb0387f51ba0f1dc971bce94ffbac9">Kind</a> <a class="code" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">kind</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1"> 34</a></span>&#160; <a class="code" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> <a class="code" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="structripple_1_1Resource_1_1Key.html#a483cbc9cc036eea28a3108b87ce8feaa">Key</a>() = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key.html#a9094d5a54f1309099ff6694bde27730b"> 38</a></span>&#160; <a class="code" href="structripple_1_1Resource_1_1Key.html#a9094d5a54f1309099ff6694bde27730b">Key</a>(<a class="code" href="namespaceripple_1_1Resource.html#a21bb0387f51ba0f1dc971bce94ffbac9">Kind</a> k, <a class="code" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> <span class="keyword">const</span>&amp; addr) : <a class="code" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">kind</a>(k), <a class="code" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a>(addr)</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; }</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1hasher.html"> 42</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structripple_1_1Resource_1_1Key_1_1hasher.html">hasher</a></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1hasher.html#a83f34d25b4dbfe584b9d4ab0cd67ad9f"> 45</a></span>&#160; <a class="code" href="structripple_1_1Resource_1_1Key_1_1hasher.html#a83f34d25b4dbfe584b9d4ab0cd67ad9f">operator()</a>(<a class="code" 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 name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structripple_1_1Resource_1_1Key_1_1hasher.html#afa7f29a1b9846e82dd658e3ef044d47f">m_addr_hash</a>(v.<a class="code" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a>);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; }</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1hasher.html#afa7f29a1b9846e82dd658e3ef044d47f"> 51</a></span>&#160; <a class="code" href="structbeast_1_1uhash.html">beast::uhash&lt;&gt;</a> <a class="code" href="structripple_1_1Resource_1_1Key_1_1hasher.html#afa7f29a1b9846e82dd658e3ef044d47f">m_addr_hash</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; };</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1key__equal.html"> 54</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structripple_1_1Resource_1_1Key_1_1key__equal.html">key_equal</a></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">explicit</span> <a class="code" href="structripple_1_1Resource_1_1Key_1_1key__equal.html#ab08fdb2959f9abc66e65247e94110cc2">key_equal</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Key_1_1key__equal.html#a9feb32547539b275265c7b6bfda5f1c6"> 59</a></span>&#160; <a class="code" href="structripple_1_1Resource_1_1Key_1_1key__equal.html#a9feb32547539b275265c7b6bfda5f1c6">operator()</a>(<a class="code" href="structripple_1_1Resource_1_1Key.html">Key</a> <span class="keyword">const</span>&amp; lhs, <a class="code" 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 name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">return</span> lhs.<a class="code" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">kind</a> == rhs.<a class="code" href="structripple_1_1Resource_1_1Key.html#afc16c2cbfed9837b2f1eb9554c0f21e3">kind</a> &amp;&amp; lhs.<a class="code" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a> == rhs.<a class="code" href="structripple_1_1Resource_1_1Key.html#a055d0599801371df81ecc35087076fa1">address</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; };</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;};</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;} <span class="comment">// namespace Resource</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<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#l00038">Key.h:38</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#l00034">Kind.h:34</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#l00059">Key.h:59</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#l00033">Key.h:33</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#l00054">Key.h:54</a></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#l00031">Key.h:31</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#l00042">Key.h:42</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#l00045">Key.h:45</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#l00034">Key.h:34</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_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#l00051">Key.h:51</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="acassert_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</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="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#l00038">IPEndpoint.h:38</a></div></div>
<div class="ttc" id="astructbeast_1_1uhash_html"><div class="ttname"><a href="structbeast_1_1uhash.html">beast::uhash&lt;&gt;</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>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>