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

145 lines
14 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: Handoff.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_9d7e4921ea2f62e76f4d31f5afd6d533.html">server</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Handoff.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_SERVER_HANDOFF_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_SERVER_HANDOFF_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/server/Writer.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;boost/beast/http/dynamic_body.hpp&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;boost/beast/http/message.hpp&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>&gt;</span></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="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0"> 13</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">http_request_type</a> =</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> boost::beast::http::request&lt;boost::beast::http::dynamic_body&gt;;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="namespaceripple.html#a2581fa85c4291f16bf9e17d78615d584"> 16</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceripple.html#a2581fa85c4291f16bf9e17d78615d584">http_response_type</a> =</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> boost::beast::http::response&lt;boost::beast::http::dynamic_body&gt;;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html"> 20</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1Handoff.html">Handoff</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// When `true`, the Session will close the socket. The</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// Handler may optionally take socket ownership using std::move</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html#aaa0aa2a937dec4a692870365b7a4ad3d"> 24</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structripple_1_1Handoff.html#aaa0aa2a937dec4a692870365b7a4ad3d">moved</a> = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// If response is set, this determines the keep alive</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html#a1200155ab6c4ac3ba14702a950c363cf"> 27</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structripple_1_1Handoff.html#a1200155ab6c4ac3ba14702a950c363cf">keep_alive</a> = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// When set, this will be sent back</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html#a808daa7fd8b0b6f64aec56b83ce5fe85"> 30</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Writer&gt;</a> <a class="code hl_variable" href="structripple_1_1Handoff.html#a808daa7fd8b0b6f64aec56b83ce5fe85">response</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="}">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html#ab1477119f0015c9fee06bfcbd77da40b"> 33</a></span> <a class="code hl_function" href="structripple_1_1Handoff.html#ab1477119f0015c9fee06bfcbd77da40b">handled</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="structripple_1_1Handoff.html#aaa0aa2a937dec4a692870365b7a4ad3d">moved</a> || <a class="code hl_variable" href="structripple_1_1Handoff.html#a808daa7fd8b0b6f64aec56b83ce5fe85">response</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> }</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>};</div>
</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="comment">// namespace ripple</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="amemory_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/memory.html">memory</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="anamespaceripple_html_a2581fa85c4291f16bf9e17d78615d584"><div class="ttname"><a href="namespaceripple.html#a2581fa85c4291f16bf9e17d78615d584">ripple::http_response_type</a></div><div class="ttdeci">boost::beast::http::response&lt; boost::beast::http::dynamic_body &gt; http_response_type</div><div class="ttdef"><b>Definition</b> <a href="Handoff_8h_source.html#l00016">Handoff.h:17</a></div></div>
<div class="ttc" id="anamespaceripple_html_aa265217edeb8282e636c78b50049f4c0"><div class="ttname"><a href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">ripple::http_request_type</a></div><div class="ttdeci">boost::beast::http::request&lt; boost::beast::http::dynamic_body &gt; http_request_type</div><div class="ttdef"><b>Definition</b> <a href="Handoff_8h_source.html#l00013">Handoff.h:14</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="astructripple_1_1Handoff_html"><div class="ttname"><a href="structripple_1_1Handoff.html">ripple::Handoff</a></div><div class="ttdoc">Used to indicate the result of a server connection handoff.</div><div class="ttdef"><b>Definition</b> <a href="Handoff_8h_source.html#l00020">Handoff.h:21</a></div></div>
<div class="ttc" id="astructripple_1_1Handoff_html_a1200155ab6c4ac3ba14702a950c363cf"><div class="ttname"><a href="structripple_1_1Handoff.html#a1200155ab6c4ac3ba14702a950c363cf">ripple::Handoff::keep_alive</a></div><div class="ttdeci">bool keep_alive</div><div class="ttdef"><b>Definition</b> <a href="Handoff_8h_source.html#l00027">Handoff.h:27</a></div></div>
<div class="ttc" id="astructripple_1_1Handoff_html_a808daa7fd8b0b6f64aec56b83ce5fe85"><div class="ttname"><a href="structripple_1_1Handoff.html#a808daa7fd8b0b6f64aec56b83ce5fe85">ripple::Handoff::response</a></div><div class="ttdeci">std::shared_ptr&lt; Writer &gt; response</div><div class="ttdef"><b>Definition</b> <a href="Handoff_8h_source.html#l00030">Handoff.h:30</a></div></div>
<div class="ttc" id="astructripple_1_1Handoff_html_aaa0aa2a937dec4a692870365b7a4ad3d"><div class="ttname"><a href="structripple_1_1Handoff.html#aaa0aa2a937dec4a692870365b7a4ad3d">ripple::Handoff::moved</a></div><div class="ttdeci">bool moved</div><div class="ttdef"><b>Definition</b> <a href="Handoff_8h_source.html#l00024">Handoff.h:24</a></div></div>
<div class="ttc" id="astructripple_1_1Handoff_html_ab1477119f0015c9fee06bfcbd77da40b"><div class="ttname"><a href="structripple_1_1Handoff.html#ab1477119f0015c9fee06bfcbd77da40b">ripple::Handoff::handled</a></div><div class="ttdeci">bool handled() const</div><div class="ttdef"><b>Definition</b> <a href="Handoff_8h_source.html#l00033">Handoff.h:33</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