mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-22 03:55:53 +00:00
148 lines
16 KiB
HTML
148 lines
16 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: 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 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_80c35e8ddb2dc186c009e0af0763187b.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 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">#ifndef RIPPLE_SERVER_HANDOFF_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_SERVER_HANDOFF_H_INCLUDED</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="preprocessor">#include <ripple/server/Writer.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <boost/beast/http/dynamic_body.hpp></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <boost/beast/http/message.hpp></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</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="keyword">using</span> <a class="code" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">http_request_type</a> =</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  boost::beast::http::request<boost::beast::http::dynamic_body>;</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="keyword">using</span> <a class="code" href="namespaceripple.html#a2581fa85c4291f16bf9e17d78615d584">http_response_type</a> =</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  boost::beast::http::response<boost::beast::http::dynamic_body>;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html"> 37</a></span> <span class="keyword">struct </span><a class="code" href="structripple_1_1Handoff.html">Handoff</a></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">// When `true`, the Session will close the socket. The</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// Handler may optionally take socket ownership using std::move</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html#aaa0aa2a937dec4a692870365b7a4ad3d"> 41</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structripple_1_1Handoff.html#aaa0aa2a937dec4a692870365b7a4ad3d">moved</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// If response is set, this determines the keep alive</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html#a1200155ab6c4ac3ba14702a950c363cf"> 44</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structripple_1_1Handoff.html#a1200155ab6c4ac3ba14702a950c363cf">keep_alive</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// When set, this will be sent back</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html#a808daa7fd8b0b6f64aec56b83ce5fe85"> 47</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<Writer></a> <a class="code" href="structripple_1_1Handoff.html#a808daa7fd8b0b6f64aec56b83ce5fe85">response</a>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structripple_1_1Handoff.html#ab1477119f0015c9fee06bfcbd77da40b"> 50</a></span>  <a class="code" href="structripple_1_1Handoff.html#ab1477119f0015c9fee06bfcbd77da40b">handled</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> <a class="code" href="structripple_1_1Handoff.html#aaa0aa2a937dec4a692870365b7a4ad3d">moved</a> || <a class="code" href="structripple_1_1Handoff.html#a808daa7fd8b0b6f64aec56b83ce5fe85">response</a>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> };</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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 class="ttdoc">STL class.</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#l00041">Handoff.h:41</a></div></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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</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#l00050">Handoff.h:50</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#l00037">Handoff.h:37</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< Writer > response</div><div class="ttdef"><b>Definition:</b> <a href="Handoff_8h_source.html#l00047">Handoff.h:47</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< boost::beast::http::dynamic_body > http_request_type</div><div class="ttdef"><b>Definition:</b> <a href="Handshake_8h_source.html#l00047">Handshake.h:47</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< boost::beast::http::dynamic_body > http_response_type</div><div class="ttdef"><b>Definition:</b> <a href="Handshake_8h_source.html#l00049">Handshake.h:49</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#l00044">Handoff.h:44</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>
|