ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-22 03:55:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 020b285808

Browse Source
This commit is contained in:
nbougalis
2020-04-15 21:15:02 +00:00
commit 4ad595bf18
12373 changed files with 1478990 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

157
Ping_8cpp_source.html Normal file
View File

@@ -0,0 +1,157 @@
<!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: Ping.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&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_f4afb74df24474efa0cc7e8ea3ddd5ce.html">rpc</a></li><li class="navelem"><a class="el" href="dir_72652aacd0eb4ee32af795650dd02b37.html">handlers</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Ping.cpp</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-2014 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">#include &lt;ripple/json/json_value.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/jss.h&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;ripple/rpc/Role.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/rpc/Context.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</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>RPC {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">struct </span>JsonContext;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;} <span class="comment">// RPC</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespaceripple.html#a988176b0725428d237f59528a1afb840"> 31</a></span>&#160;<a class="code" href="classJson_1_1Value.html">Json::Value</a> <a class="code" href="namespaceripple.html#a988176b0725428d237f59528a1afb840">doPing</a> (<a class="code" href="structripple_1_1RPC_1_1JsonContext.html">RPC::JsonContext</a>&amp; context)</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"> 33</span>&#160; <a class="code" href="classJson_1_1Value.html">Json::Value</a> ret(<a class="code" href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6">Json::objectValue</a>);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">switch</span> (context.<a class="code" href="structripple_1_1RPC_1_1Context.html#a20ec6d6aa84f8c76eeb90ad92fe25e20">role</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; <span class="keywordflow">case</span> <a class="code" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca73acd9a5972130b75066c82595a1fae3">Role::ADMIN</a>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; ret[jss::role] = <span class="stringliteral">&quot;admin&quot;</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca1ce51056a04cffe133dd6c79fea6f044">Role::IDENTIFIED</a>:</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; ret[jss::role] = <span class="stringliteral">&quot;identified&quot;</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; ret[jss::username] = context.<a class="code" href="structripple_1_1RPC_1_1JsonContext.html#acc2af1889f5b374cf1c26651cd4ab95e">headers</a>.<a class="code" href="structripple_1_1RPC_1_1JsonContext_1_1Headers.html#ae47d898ea10de5370d723df3fa25b600">user</a>.to_string();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">if</span> (context.<a class="code" href="structripple_1_1RPC_1_1JsonContext.html#acc2af1889f5b374cf1c26651cd4ab95e">headers</a>.<a class="code" href="structripple_1_1RPC_1_1JsonContext_1_1Headers.html#adce8d84e5b7a978c9f2ca7ac69a387a5">forwardedFor</a>.size())</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; ret[jss::ip] = context.<a class="code" href="structripple_1_1RPC_1_1JsonContext.html#acc2af1889f5b374cf1c26651cd4ab95e">headers</a>.<a class="code" href="structripple_1_1RPC_1_1JsonContext_1_1Headers.html#adce8d84e5b7a978c9f2ca7ac69a387a5">forwardedFor</a>.to_string();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2cae69e6446e892e3922e76c82e96837920">Role::PROXY</a>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; ret[jss::role] = <span class="stringliteral">&quot;proxied&quot;</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; ret[jss::ip] = context.<a class="code" href="structripple_1_1RPC_1_1JsonContext.html#acc2af1889f5b374cf1c26651cd4ab95e">headers</a>.<a class="code" href="structripple_1_1RPC_1_1JsonContext_1_1Headers.html#adce8d84e5b7a978c9f2ca7ac69a387a5">forwardedFor</a>.to_string();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">default</span>:</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; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">// This is only accessible on ws sessions.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">if</span> (context.<a class="code" href="structripple_1_1RPC_1_1Context.html#a8b3d9cecb7761db847886bcb482b8db7">infoSub</a>)</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">if</span> (context.<a class="code" href="structripple_1_1RPC_1_1Context.html#a8b3d9cecb7761db847886bcb482b8db7">infoSub</a>-&gt;<a class="code" href="classripple_1_1InfoSub.html#af71cb4db7309641e675e740f656046d5">getConsumer</a>().<a class="code" href="classripple_1_1Resource_1_1Consumer.html#aa196f44968e79d8c852e15ac96a71ee3">isUnlimited</a>())</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; ret[jss::unlimited] = <span class="keyword">true</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; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;} <span class="comment">// ripple</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructripple_1_1RPC_1_1Context_html_a8b3d9cecb7761db847886bcb482b8db7"><div class="ttname"><a href="structripple_1_1RPC_1_1Context.html#a8b3d9cecb7761db847886bcb482b8db7">ripple::RPC::Context::infoSub</a></div><div class="ttdeci">InfoSub::pointer infoSub</div><div class="ttdef"><b>Definition:</b> <a href="Context_8h_source.html#l00049">Context.h:49</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1JsonContext_html"><div class="ttname"><a href="structripple_1_1RPC_1_1JsonContext.html">ripple::RPC::JsonContext</a></div><div class="ttdef"><b>Definition:</b> <a href="Context_8h_source.html#l00052">Context.h:52</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1JsonContext_1_1Headers_html_ae47d898ea10de5370d723df3fa25b600"><div class="ttname"><a href="structripple_1_1RPC_1_1JsonContext_1_1Headers.html#ae47d898ea10de5370d723df3fa25b600">ripple::RPC::JsonContext::Headers::user</a></div><div class="ttdeci">boost::string_view user</div><div class="ttdef"><b>Definition:</b> <a href="Context_8h_source.html#l00059">Context.h:59</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2ca1ce51056a04cffe133dd6c79fea6f044"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca1ce51056a04cffe133dd6c79fea6f044">ripple::Role::IDENTIFIED</a></div><div class="ttdeci">@ IDENTIFIED</div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Context_html_a20ec6d6aa84f8c76eeb90ad92fe25e20"><div class="ttname"><a href="structripple_1_1RPC_1_1Context.html#a20ec6d6aa84f8c76eeb90ad92fe25e20">ripple::RPC::Context::role</a></div><div class="ttdeci">Role role</div><div class="ttdef"><b>Definition:</b> <a href="Context_8h_source.html#l00047">Context.h:47</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1JsonContext_html_acc2af1889f5b374cf1c26651cd4ab95e"><div class="ttname"><a href="structripple_1_1RPC_1_1JsonContext.html#acc2af1889f5b374cf1c26651cd4ab95e">ripple::RPC::JsonContext::headers</a></div><div class="ttdeci">Headers headers</div><div class="ttdef"><b>Definition:</b> <a href="Context_8h_source.html#l00066">Context.h:66</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2ca73acd9a5972130b75066c82595a1fae3"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca73acd9a5972130b75066c82595a1fae3">ripple::Role::ADMIN</a></div><div class="ttdeci">@ ADMIN</div></div>
<div class="ttc" id="anamespaceJson_html_a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6"><div class="ttname"><a href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6">Json::objectValue</a></div><div class="ttdeci">@ objectValue</div><div class="ttdoc">object value (collection of name/value pairs).</div><div class="ttdef"><b>Definition:</b> <a href="json__value_8h_source.html#l00045">json_value.h:45</a></div></div>
<div class="ttc" id="anamespaceripple_html_a988176b0725428d237f59528a1afb840"><div class="ttname"><a href="namespaceripple.html#a988176b0725428d237f59528a1afb840">ripple::doPing</a></div><div class="ttdeci">Json::Value doPing(RPC::JsonContext &amp;)</div><div class="ttdef"><b>Definition:</b> <a href="Ping_8cpp_source.html#l00031">Ping.cpp:31</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2cae69e6446e892e3922e76c82e96837920"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2cae69e6446e892e3922e76c82e96837920">ripple::Role::PROXY</a></div><div class="ttdeci">@ PROXY</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="aclassripple_1_1Resource_1_1Consumer_html_aa196f44968e79d8c852e15ac96a71ee3"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#aa196f44968e79d8c852e15ac96a71ee3">ripple::Resource::Consumer::isUnlimited</a></div><div class="ttdeci">bool isUnlimited() const</div><div class="ttdoc">Returns true if this is a privileged endpoint.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00081">Consumer.cpp:81</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1JsonContext_1_1Headers_html_adce8d84e5b7a978c9f2ca7ac69a387a5"><div class="ttname"><a href="structripple_1_1RPC_1_1JsonContext_1_1Headers.html#adce8d84e5b7a978c9f2ca7ac69a387a5">ripple::RPC::JsonContext::Headers::forwardedFor</a></div><div class="ttdeci">boost::string_view forwardedFor</div><div class="ttdef"><b>Definition:</b> <a href="Context_8h_source.html#l00060">Context.h:60</a></div></div>
<div class="ttc" id="aclassripple_1_1InfoSub_html_af71cb4db7309641e675e740f656046d5"><div class="ttname"><a href="classripple_1_1InfoSub.html#af71cb4db7309641e675e740f656046d5">ripple::InfoSub::getConsumer</a></div><div class="ttdeci">Consumer &amp; getConsumer()</div><div class="ttdef"><b>Definition:</b> <a href="InfoSub_8cpp_source.html#l00080">InfoSub.cpp:80</a></div></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition:</b> <a href="json__value_8h_source.html#l00141">json_value.h:141</a></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>