mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 03:26:01 +00:00
232 lines
32 KiB
HTML
232 lines
32 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" 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: Session.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&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&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&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">Session.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="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00003" 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 id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00006" 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 id="l00007" 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 id="l00008" 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 id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00010" 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 id="l00011" 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 id="l00012" 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 id="l00013" 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 id="l00014" 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 id="l00015" 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 id="l00016" 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 id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef RIPPLE_SERVER_SESSION_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_SERVER_SESSION_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <xrpl/beast/net/IPEndpoint.h></span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <xrpl/beast/utility/Journal.h></span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <xrpl/server/WSSession.h></span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <xrpl/server/Writer.h></span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <boost/beast/http/message.hpp></span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/functional.html">functional</a>></span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</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 id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/ostream.html">ostream</a>></span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a>></span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="foldopen" id="foldopen00042" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html"> 42</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1Session.html">Session</a></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>{</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#affbce918111a588e7fa49c1b0800dd21"> 45</a></span> <a class="code hl_function" href="classripple_1_1Session.html#affbce918111a588e7fa49c1b0800dd21">Session</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a52d48e029fccc0db59b82bca8af69039"> 46</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a52d48e029fccc0db59b82bca8af69039">Session</a>(<a class="code hl_class" href="classripple_1_1Session.html">Session</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_class" href="classripple_1_1Session.html">Session</a>&</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#ad7a7feca1a7d3321713275557e7f05ae"> 48</a></span> <a class="code hl_function" href="classripple_1_1Session.html#ad7a7feca1a7d3321713275557e7f05ae">operator=</a>(<a class="code hl_class" href="classripple_1_1Session.html">Session</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a7252e8f2b56377831ac8e391f3dc5bf9"> 49</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1Session.html#a7252e8f2b56377831ac8e391f3dc5bf9">~Session</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a8e66069a5970203f04fc737b84d53c72"> 55</a></span> <span class="keywordtype">void</span>* <a class="code hl_variable" href="classripple_1_1Session.html#a8e66069a5970203f04fc737b84d53c72">tag</a> = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a9bf723e6664d299e120453b201baadee"> 59</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a9bf723e6664d299e120453b201baadee">journal</a>() = 0;</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">virtual</span> <a class="code hl_struct" href="structripple_1_1Port.html">Port</a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a37cec955101fb6c0011a8dc490a6604f"> 63</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a37cec955101fb6c0011a8dc490a6604f">port</a>() = 0;</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a3153534e121d237bb95f43e43da22259"> 67</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a3153534e121d237bb95f43e43da22259">remoteAddress</a>() = 0;</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">http_request_type</a>&</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a6bc29f9523302f0761a8272bc5d67b8d"> 71</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a6bc29f9523302f0761a8272bc5d67b8d">request</a>() = 0;</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">void</span></div>
|
|
<div class="foldopen" id="foldopen00076" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a7ef37bf5e14c980a67ccf21342d7f80b"> 76</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a7ef37bf5e14c980a67ccf21342d7f80b">write</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& s)</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> {</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">if</span> (!s.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/string/basic_string/empty.html">empty</a>())</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <a class="code hl_function" href="classripple_1_1Session.html#a7ef37bf5e14c980a67ccf21342d7f80b">write</a>(&s[0], <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/iterator/distance.html">std::distance</a>(s.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/string/basic_string/begin.html">begin</a>(), s.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/string/basic_string/end.html">end</a>()));</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">template</span> <<span class="keyword">typename</span> BufferSequence></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span></div>
|
|
<div class="foldopen" id="foldopen00084" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#ad4d27e695ef3b85cac7c950770e4747a"> 84</a></span> <a class="code hl_function" href="classripple_1_1Session.html#ad4d27e695ef3b85cac7c950770e4747a">write</a>(BufferSequence <span class="keyword">const</span>& buffers)</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> {</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">for</span> (<span class="keyword">typename</span> BufferSequence::const_iterator iter(buffers.begin());</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> iter != buffers.end();</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> ++iter)</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> {</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">typename</span> BufferSequence::value_type <span class="keyword">const</span>& buffer(*iter);</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <a class="code hl_function" href="classripple_1_1Session.html#a7ef37bf5e14c980a67ccf21342d7f80b">write</a>(buffer.data(), boost::asio::buffer_size(buffer));</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> }</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#ae0acef5ec64ad04c47c5ededaf72cc07"> 96</a></span> <a class="code hl_function" href="classripple_1_1Session.html#ae0acef5ec64ad04c47c5ededaf72cc07">write</a>(<span class="keywordtype">void</span> <span class="keyword">const</span>* buffer, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> bytes) = 0;</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a7c36d70d9ce286186ce8f1cf52742ca1"> 99</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a7c36d70d9ce286186ce8f1cf52742ca1">write</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<Writer></a> <span class="keyword">const</span>& writer, <span class="keywordtype">bool</span> keep_alive) = 0;</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<Session></a></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a503c7741af1659809d5e1f113efc1c9a"> 109</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a503c7741af1659809d5e1f113efc1c9a">detach</a>() = 0;</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#af03f421d57123242a131a04c1550432f"> 118</a></span> <a class="code hl_function" href="classripple_1_1Session.html#af03f421d57123242a131a04c1550432f">complete</a>() = 0;</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a5950cab2e15a8ae0f286a179b53d262f"> 126</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a5950cab2e15a8ae0f286a179b53d262f">close</a>(<span class="keywordtype">bool</span> graceful) = 0;</div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<WSSession></a></div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="classripple_1_1Session.html#a2bc078b02ae151af6c8f2560c23add42"> 130</a></span> <a class="code hl_function" href="classripple_1_1Session.html#a2bc078b02ae151af6c8f2560c23add42">websocketUpgrade</a>() = 0;</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>} <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
|
|
<div class="ttc" id="abegin_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/begin.html">std::string::begin</a></div><div class="ttdeci">T begin(T... args)</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#l00037">IPEndpoint.h:38</a></div></div>
|
|
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00059">Journal.h:60</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html"><div class="ttname"><a href="classripple_1_1Session.html">ripple::Session</a></div><div class="ttdoc">Persistent state information for a connection session.</div><div class="ttdef"><b>Definition</b> <a href="Session_8h_source.html#l00042">Session.h:43</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a2bc078b02ae151af6c8f2560c23add42"><div class="ttname"><a href="classripple_1_1Session.html#a2bc078b02ae151af6c8f2560c23add42">ripple::Session::websocketUpgrade</a></div><div class="ttdeci">virtual std::shared_ptr< WSSession > websocketUpgrade()=0</div><div class="ttdoc">Convert the connection to WebSocket.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a3153534e121d237bb95f43e43da22259"><div class="ttname"><a href="classripple_1_1Session.html#a3153534e121d237bb95f43e43da22259">ripple::Session::remoteAddress</a></div><div class="ttdeci">virtual beast::IP::Endpoint remoteAddress()=0</div><div class="ttdoc">Returns the remote address of the connection.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a37cec955101fb6c0011a8dc490a6604f"><div class="ttname"><a href="classripple_1_1Session.html#a37cec955101fb6c0011a8dc490a6604f">ripple::Session::port</a></div><div class="ttdeci">virtual Port const & port()=0</div><div class="ttdoc">Returns the Port settings for this connection.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a503c7741af1659809d5e1f113efc1c9a"><div class="ttname"><a href="classripple_1_1Session.html#a503c7741af1659809d5e1f113efc1c9a">ripple::Session::detach</a></div><div class="ttdeci">virtual std::shared_ptr< Session > detach()=0</div><div class="ttdoc">Detach the session.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a52d48e029fccc0db59b82bca8af69039"><div class="ttname"><a href="classripple_1_1Session.html#a52d48e029fccc0db59b82bca8af69039">ripple::Session::Session</a></div><div class="ttdeci">Session(Session const &)=delete</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a5950cab2e15a8ae0f286a179b53d262f"><div class="ttname"><a href="classripple_1_1Session.html#a5950cab2e15a8ae0f286a179b53d262f">ripple::Session::close</a></div><div class="ttdeci">virtual void close(bool graceful)=0</div><div class="ttdoc">Close the session.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a6bc29f9523302f0761a8272bc5d67b8d"><div class="ttname"><a href="classripple_1_1Session.html#a6bc29f9523302f0761a8272bc5d67b8d">ripple::Session::request</a></div><div class="ttdeci">virtual http_request_type & request()=0</div><div class="ttdoc">Returns the current HTTP request.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a7252e8f2b56377831ac8e391f3dc5bf9"><div class="ttname"><a href="classripple_1_1Session.html#a7252e8f2b56377831ac8e391f3dc5bf9">ripple::Session::~Session</a></div><div class="ttdeci">virtual ~Session()=default</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a7c36d70d9ce286186ce8f1cf52742ca1"><div class="ttname"><a href="classripple_1_1Session.html#a7c36d70d9ce286186ce8f1cf52742ca1">ripple::Session::write</a></div><div class="ttdeci">virtual void write(std::shared_ptr< Writer > const &writer, bool keep_alive)=0</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a7ef37bf5e14c980a67ccf21342d7f80b"><div class="ttname"><a href="classripple_1_1Session.html#a7ef37bf5e14c980a67ccf21342d7f80b">ripple::Session::write</a></div><div class="ttdeci">void write(std::string const &s)</div><div class="ttdoc">Send a copy of data asynchronously.</div><div class="ttdef"><b>Definition</b> <a href="Session_8h_source.html#l00076">Session.h:76</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a8e66069a5970203f04fc737b84d53c72"><div class="ttname"><a href="classripple_1_1Session.html#a8e66069a5970203f04fc737b84d53c72">ripple::Session::tag</a></div><div class="ttdeci">void * tag</div><div class="ttdoc">A user-definable pointer.</div><div class="ttdef"><b>Definition</b> <a href="Session_8h_source.html#l00055">Session.h:55</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_a9bf723e6664d299e120453b201baadee"><div class="ttname"><a href="classripple_1_1Session.html#a9bf723e6664d299e120453b201baadee">ripple::Session::journal</a></div><div class="ttdeci">virtual beast::Journal journal()=0</div><div class="ttdoc">Returns the Journal to use for logging.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_ad4d27e695ef3b85cac7c950770e4747a"><div class="ttname"><a href="classripple_1_1Session.html#ad4d27e695ef3b85cac7c950770e4747a">ripple::Session::write</a></div><div class="ttdeci">void write(BufferSequence const &buffers)</div><div class="ttdef"><b>Definition</b> <a href="Session_8h_source.html#l00084">Session.h:84</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_ad7a7feca1a7d3321713275557e7f05ae"><div class="ttname"><a href="classripple_1_1Session.html#ad7a7feca1a7d3321713275557e7f05ae">ripple::Session::operator=</a></div><div class="ttdeci">Session & operator=(Session const &)=delete</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_ae0acef5ec64ad04c47c5ededaf72cc07"><div class="ttname"><a href="classripple_1_1Session.html#ae0acef5ec64ad04c47c5ededaf72cc07">ripple::Session::write</a></div><div class="ttdeci">virtual void write(void const *buffer, std::size_t bytes)=0</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_af03f421d57123242a131a04c1550432f"><div class="ttname"><a href="classripple_1_1Session.html#af03f421d57123242a131a04c1550432f">ripple::Session::complete</a></div><div class="ttdeci">virtual void complete()=0</div><div class="ttdoc">Indicate that the response is complete.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Session_html_affbce918111a588e7fa49c1b0800dd21"><div class="ttname"><a href="classripple_1_1Session.html#affbce918111a588e7fa49c1b0800dd21">ripple::Session::Session</a></div><div class="ttdeci">Session()=default</div></div>
|
|
<div class="ttc" id="adistance_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/iterator/distance.html">std::distance</a></div><div class="ttdeci">T distance(T... args)</div></div>
|
|
<div class="ttc" id="aempty_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/empty.html">std::string::empty</a></div><div class="ttdeci">T empty(T... args)</div></div>
|
|
<div class="ttc" id="aend_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/end.html">std::string::end</a></div><div class="ttdeci">T end(T... args)</div></div>
|
|
<div class="ttc" id="afunctional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/functional.html">functional</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="algorithm_8h_source.html#l00025">algorithm.h:25</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="Handoff_8h_source.html#l00032">Handoff.h:33</a></div></div>
|
|
<div class="ttc" id="aostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/ostream.html">ostream</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="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="astructripple_1_1Port_html"><div class="ttname"><a href="structripple_1_1Port.html">ripple::Port</a></div><div class="ttdoc">Configuration information for a Server listening port.</div><div class="ttdef"><b>Definition</b> <a href="Port_8h_source.html#l00049">Port.h:50</a></div></div>
|
|
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|