ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 19:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2ef1af9423e3adf2a90158ce99b5ef20fc13619e
rippled/WSSession_8h_source.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

269 lines
40 KiB
HTML
Raw 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: WSSession.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">WSSession.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 &quot;AS IS&quot; 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_WSSESSION_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_SERVER_WSSESSION_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 &lt;xrpl/server/Handoff.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpl/server/Port.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/server/Writer.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;boost/asio/buffer.hpp&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;boost/asio/ip/tcp.hpp&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;boost/beast/core/buffers_prefix.hpp&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;boost/beast/websocket/rfc6455.hpp&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &lt;boost/logic/tribool.hpp&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a>&gt;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/functional.html">functional</a>&gt;</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</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="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a>&gt;</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a>&gt;</span></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="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="foldopen" id="foldopen00041" data-start="{" data-end="};">
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classripple_1_1WSMsg.html"> 41</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1WSMsg.html">WSMsg</a></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classripple_1_1WSMsg.html#ae30e2aaf77912b6413f7ec9ca7c42a2a"> 44</a></span> <a class="code hl_function" href="classripple_1_1WSMsg.html#ae30e2aaf77912b6413f7ec9ca7c42a2a">WSMsg</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classripple_1_1WSMsg.html#abc477b01fda6b57f05ad5a383c6bc6c4"> 45</a></span> <a class="code hl_function" href="classripple_1_1WSMsg.html#abc477b01fda6b57f05ad5a383c6bc6c4">WSMsg</a>(<a class="code hl_class" href="classripple_1_1WSMsg.html">WSMsg</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_class" href="classripple_1_1WSMsg.html">WSMsg</a>&amp;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classripple_1_1WSMsg.html#a1b58b279d44545ba5dffe18adcd0e6f2"> 47</a></span> <a class="code hl_function" href="classripple_1_1WSMsg.html#a1b58b279d44545ba5dffe18adcd0e6f2">operator=</a>(<a class="code hl_class" href="classripple_1_1WSMsg.html">WSMsg</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classripple_1_1WSMsg.html#a5ba20a3e8d67015f0359ff2920de1bd6"> 48</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1WSMsg.html#a5ba20a3e8d67015f0359ff2920de1bd6">~WSMsg</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;boost::tribool, std::vector&lt;boost::asio::const_buffer&gt;</a>&gt;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classripple_1_1WSMsg.html#a783fa465c220ef5de8f4567d2f7f3f98"> 68</a></span> <a class="code hl_function" href="classripple_1_1WSMsg.html#a783fa465c220ef5de8f4567d2f7f3f98">prepare</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> bytes, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;<span class="keywordtype">void</span>(<span class="keywordtype">void</span>)&gt; resume) = 0;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>};</div>
</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Streambuf&gt;</div>
<div class="foldopen" id="foldopen00072" data-start="{" data-end="};">
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classripple_1_1StreambufWSMsg.html"> 72</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1StreambufWSMsg.html">StreambufWSMsg</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1WSMsg.html">WSMsg</a></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>{</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd"> 74</a></span> Streambuf <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">sb_</a>;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classripple_1_1StreambufWSMsg.html#a40941fb7fde09a644a5da538e410bc05"> 75</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a40941fb7fde09a644a5da538e410bc05">n_</a> = 0;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00078" data-start="{" data-end="}">
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classripple_1_1StreambufWSMsg.html#ae4448cac0f175fdeca377bcdbe04b1ca"> 78</a></span> <a class="code hl_function" href="classripple_1_1StreambufWSMsg.html#ae4448cac0f175fdeca377bcdbe04b1ca">StreambufWSMsg</a>(Streambuf&amp;&amp; sb) : <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">sb_</a>(<a class="code hl_namespace" href="namespacestd.html">std</a>::move(sb))</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> {</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> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;boost::tribool, std::vector&lt;boost::asio::const_buffer&gt;</a>&gt;</div>
<div class="foldopen" id="foldopen00083" data-start="{" data-end="}">
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classripple_1_1StreambufWSMsg.html#a60de9ff038a97a7f85fecc97dd115f7e"> 83</a></span> <a class="code hl_function" href="classripple_1_1StreambufWSMsg.html#a60de9ff038a97a7f85fecc97dd115f7e">prepare</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> bytes, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;<span class="keywordtype">void</span>(<span class="keywordtype">void</span>)&gt;)<span class="keyword"> override</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">sb_</a>.size() == 0)</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">return</span> {<span class="keyword">true</span>, {}};</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">sb_</a>.consume(<a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a40941fb7fde09a644a5da538e410bc05">n_</a>);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> boost::tribool done;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordflow">if</span> (bytes &lt; <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">sb_</a>.size())</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> {</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a40941fb7fde09a644a5da538e410bc05">n_</a> = bytes;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> done = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> }</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> {</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a40941fb7fde09a644a5da538e410bc05">n_</a> = <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">sb_</a>.size();</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> done = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> }</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">auto</span> <span class="keyword">const</span> pb = boost::beast::buffers_prefix(<a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a40941fb7fde09a644a5da538e410bc05">n_</a>, <a class="code hl_variable" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">sb_</a>.data());</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;boost::asio::const_buffer&gt;</a> vb(</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/iterator/distance.html">std::distance</a>(pb.begin(), pb.end()));</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/algorithm/copy.html">std::copy</a>(pb.begin(), pb.end(), <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/iterator/back_inserter.html">std::back_inserter</a>(vb));</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">return</span> {done, vb};</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>};</div>
</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="foldopen" id="foldopen00107" data-start="{" data-end="};">
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html"> 107</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1WSSession.html">WSSession</a></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>{</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#a2b91a0f839ba3bde37fd06444fa5d931"> 109</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;void&gt;</a> <a class="code hl_variable" href="structripple_1_1WSSession.html#a2b91a0f839ba3bde37fd06444fa5d931">appDefined</a>;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#af2873180683531fcbac7a58059fb5f8a"> 111</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="structripple_1_1WSSession.html#af2873180683531fcbac7a58059fb5f8a">~WSSession</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#aa04e8f3c9fedb35f8a52180f2de647a1"> 112</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#aa04e8f3c9fedb35f8a52180f2de647a1">WSSession</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#ad71e83d9e5906f603b943f84dd44555e"> 113</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#ad71e83d9e5906f603b943f84dd44555e">WSSession</a>(<a class="code hl_struct" href="structripple_1_1WSSession.html">WSSession</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <a class="code hl_struct" href="structripple_1_1WSSession.html">WSSession</a>&amp;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#a706f8ad1002d6c19e44fa2af60243b63"> 115</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#a706f8ad1002d6c19e44fa2af60243b63">operator=</a>(<a class="code hl_struct" href="structripple_1_1WSSession.html">WSSession</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</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="structripple_1_1WSSession.html#a8d8ff14085fd9951038f860a4a08939f"> 118</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#a8d8ff14085fd9951038f860a4a08939f">run</a>() = 0;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">virtual</span> <a class="code hl_struct" href="structripple_1_1Port.html">Port</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#a744eee07322a943e85dd4549c86a78f4"> 121</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#a744eee07322a943e85dd4549c86a78f4">port</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">http_request_type</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#a45f868ea10de1df1550395a965e86541"> 124</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#a45f868ea10de1df1550395a965e86541">request</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">virtual</span> boost::asio::ip::tcp::endpoint <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#a6ec5802c9aeeddc9e22790af6ab0cad2"> 127</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#a6ec5802c9aeeddc9e22790af6ab0cad2">remote_endpoint</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#a8e7e0b568ae4bcced108341224dec263"> 131</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#a8e7e0b568ae4bcced108341224dec263">send</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;WSMsg&gt;</a> w) = 0;</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="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#a17da7bcecda1540505b77c4bab0a5b93"> 134</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#a17da7bcecda1540505b77c4bab0a5b93">close</a>() = 0;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#aa3b2298b56bf9e479c89df60e32215b9"> 137</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#aa3b2298b56bf9e479c89df60e32215b9">close</a>(boost::beast::websocket::close_reason <span class="keyword">const</span>&amp; reason) = 0;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"><a class="line" href="structripple_1_1WSSession.html#ad95020dc99b4322736f342c9427f6445"> 144</a></span> <a class="code hl_function" href="structripple_1_1WSSession.html#ad95020dc99b4322736f342c9427f6445">complete</a>() = 0;</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span>};</div>
</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aalgorithm_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a></div></div>
<div class="ttc" id="aback_inserter_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/iterator/back_inserter.html">std::back_inserter</a></div><div class="ttdeci">T back_inserter(T... args)</div></div>
<div class="ttc" id="aclassripple_1_1StreambufWSMsg_html"><div class="ttname"><a href="classripple_1_1StreambufWSMsg.html">ripple::StreambufWSMsg</a></div><div class="ttdef"><b>Definition</b> <a href="WSSession_8h_source.html#l00072">WSSession.h:73</a></div></div>
<div class="ttc" id="aclassripple_1_1StreambufWSMsg_html_a40941fb7fde09a644a5da538e410bc05"><div class="ttname"><a href="classripple_1_1StreambufWSMsg.html#a40941fb7fde09a644a5da538e410bc05">ripple::StreambufWSMsg::n_</a></div><div class="ttdeci">std::size_t n_</div><div class="ttdef"><b>Definition</b> <a href="WSSession_8h_source.html#l00075">WSSession.h:75</a></div></div>
<div class="ttc" id="aclassripple_1_1StreambufWSMsg_html_a60de9ff038a97a7f85fecc97dd115f7e"><div class="ttname"><a href="classripple_1_1StreambufWSMsg.html#a60de9ff038a97a7f85fecc97dd115f7e">ripple::StreambufWSMsg::prepare</a></div><div class="ttdeci">std::pair&lt; boost::tribool, std::vector&lt; boost::asio::const_buffer &gt; &gt; prepare(std::size_t bytes, std::function&lt; void(void)&gt;) override</div><div class="ttdoc">Retrieve message data.</div><div class="ttdef"><b>Definition</b> <a href="WSSession_8h_source.html#l00083">WSSession.h:83</a></div></div>
<div class="ttc" id="aclassripple_1_1StreambufWSMsg_html_a92b1963360380594112cd3b746c10fdd"><div class="ttname"><a href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">ripple::StreambufWSMsg::sb_</a></div><div class="ttdeci">Streambuf sb_</div><div class="ttdef"><b>Definition</b> <a href="WSSession_8h_source.html#l00074">WSSession.h:74</a></div></div>
<div class="ttc" id="aclassripple_1_1StreambufWSMsg_html_ae4448cac0f175fdeca377bcdbe04b1ca"><div class="ttname"><a href="classripple_1_1StreambufWSMsg.html#ae4448cac0f175fdeca377bcdbe04b1ca">ripple::StreambufWSMsg::StreambufWSMsg</a></div><div class="ttdeci">StreambufWSMsg(Streambuf &amp;&amp;sb)</div><div class="ttdef"><b>Definition</b> <a href="WSSession_8h_source.html#l00078">WSSession.h:78</a></div></div>
<div class="ttc" id="aclassripple_1_1WSMsg_html"><div class="ttname"><a href="classripple_1_1WSMsg.html">ripple::WSMsg</a></div><div class="ttdef"><b>Definition</b> <a href="WSSession_8h_source.html#l00041">WSSession.h:42</a></div></div>
<div class="ttc" id="aclassripple_1_1WSMsg_html_a1b58b279d44545ba5dffe18adcd0e6f2"><div class="ttname"><a href="classripple_1_1WSMsg.html#a1b58b279d44545ba5dffe18adcd0e6f2">ripple::WSMsg::operator=</a></div><div class="ttdeci">WSMsg &amp; operator=(WSMsg const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1WSMsg_html_a5ba20a3e8d67015f0359ff2920de1bd6"><div class="ttname"><a href="classripple_1_1WSMsg.html#a5ba20a3e8d67015f0359ff2920de1bd6">ripple::WSMsg::~WSMsg</a></div><div class="ttdeci">virtual ~WSMsg()=default</div></div>
<div class="ttc" id="aclassripple_1_1WSMsg_html_a783fa465c220ef5de8f4567d2f7f3f98"><div class="ttname"><a href="classripple_1_1WSMsg.html#a783fa465c220ef5de8f4567d2f7f3f98">ripple::WSMsg::prepare</a></div><div class="ttdeci">virtual std::pair&lt; boost::tribool, std::vector&lt; boost::asio::const_buffer &gt; &gt; prepare(std::size_t bytes, std::function&lt; void(void)&gt; resume)=0</div><div class="ttdoc">Retrieve message data.</div></div>
<div class="ttc" id="aclassripple_1_1WSMsg_html_abc477b01fda6b57f05ad5a383c6bc6c4"><div class="ttname"><a href="classripple_1_1WSMsg.html#abc477b01fda6b57f05ad5a383c6bc6c4">ripple::WSMsg::WSMsg</a></div><div class="ttdeci">WSMsg(WSMsg const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1WSMsg_html_ae30e2aaf77912b6413f7ec9ca7c42a2a"><div class="ttname"><a href="classripple_1_1WSMsg.html#ae30e2aaf77912b6413f7ec9ca7c42a2a">ripple::WSMsg::WSMsg</a></div><div class="ttdeci">WSMsg()=default</div></div>
<div class="ttc" id="acopy_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/copy.html">std::copy</a></div><div class="ttdeci">T copy(T... args)</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="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a></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&lt; boost::beast::http::dynamic_body &gt; 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="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</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="astructripple_1_1WSSession_html"><div class="ttname"><a href="structripple_1_1WSSession.html">ripple::WSSession</a></div><div class="ttdef"><b>Definition</b> <a href="WSSession_8h_source.html#l00107">WSSession.h:108</a></div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_a17da7bcecda1540505b77c4bab0a5b93"><div class="ttname"><a href="structripple_1_1WSSession.html#a17da7bcecda1540505b77c4bab0a5b93">ripple::WSSession::close</a></div><div class="ttdeci">virtual void close()=0</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_a2b91a0f839ba3bde37fd06444fa5d931"><div class="ttname"><a href="structripple_1_1WSSession.html#a2b91a0f839ba3bde37fd06444fa5d931">ripple::WSSession::appDefined</a></div><div class="ttdeci">std::shared_ptr&lt; void &gt; appDefined</div><div class="ttdef"><b>Definition</b> <a href="WSSession_8h_source.html#l00109">WSSession.h:109</a></div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_a45f868ea10de1df1550395a965e86541"><div class="ttname"><a href="structripple_1_1WSSession.html#a45f868ea10de1df1550395a965e86541">ripple::WSSession::request</a></div><div class="ttdeci">virtual http_request_type const &amp; request() const =0</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_a6ec5802c9aeeddc9e22790af6ab0cad2"><div class="ttname"><a href="structripple_1_1WSSession.html#a6ec5802c9aeeddc9e22790af6ab0cad2">ripple::WSSession::remote_endpoint</a></div><div class="ttdeci">virtual boost::asio::ip::tcp::endpoint const &amp; remote_endpoint() const =0</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_a706f8ad1002d6c19e44fa2af60243b63"><div class="ttname"><a href="structripple_1_1WSSession.html#a706f8ad1002d6c19e44fa2af60243b63">ripple::WSSession::operator=</a></div><div class="ttdeci">WSSession &amp; operator=(WSSession const &amp;)=delete</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_a744eee07322a943e85dd4549c86a78f4"><div class="ttname"><a href="structripple_1_1WSSession.html#a744eee07322a943e85dd4549c86a78f4">ripple::WSSession::port</a></div><div class="ttdeci">virtual Port const &amp; port() const =0</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_a8d8ff14085fd9951038f860a4a08939f"><div class="ttname"><a href="structripple_1_1WSSession.html#a8d8ff14085fd9951038f860a4a08939f">ripple::WSSession::run</a></div><div class="ttdeci">virtual void run()=0</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_a8e7e0b568ae4bcced108341224dec263"><div class="ttname"><a href="structripple_1_1WSSession.html#a8e7e0b568ae4bcced108341224dec263">ripple::WSSession::send</a></div><div class="ttdeci">virtual void send(std::shared_ptr&lt; WSMsg &gt; w)=0</div><div class="ttdoc">Send a WebSockets message.</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_aa04e8f3c9fedb35f8a52180f2de647a1"><div class="ttname"><a href="structripple_1_1WSSession.html#aa04e8f3c9fedb35f8a52180f2de647a1">ripple::WSSession::WSSession</a></div><div class="ttdeci">WSSession()=default</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_aa3b2298b56bf9e479c89df60e32215b9"><div class="ttname"><a href="structripple_1_1WSSession.html#aa3b2298b56bf9e479c89df60e32215b9">ripple::WSSession::close</a></div><div class="ttdeci">virtual void close(boost::beast::websocket::close_reason const &amp;reason)=0</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_ad71e83d9e5906f603b943f84dd44555e"><div class="ttname"><a href="structripple_1_1WSSession.html#ad71e83d9e5906f603b943f84dd44555e">ripple::WSSession::WSSession</a></div><div class="ttdeci">WSSession(WSSession const &amp;)=delete</div></div>
<div class="ttc" id="astructripple_1_1WSSession_html_ad95020dc99b4322736f342c9427f6445"><div class="ttname"><a href="structripple_1_1WSSession.html#ad95020dc99b4322736f342c9427f6445">ripple::WSSession::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="astructripple_1_1WSSession_html_af2873180683531fcbac7a58059fb5f8a"><div class="ttname"><a href="structripple_1_1WSSession.html#af2873180683531fcbac7a58059fb5f8a">ripple::WSSession::~WSSession</a></div><div class="ttdeci">virtual ~WSSession()=default</div></div>
<div class="ttc" id="autility_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/utility.html">utility</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&#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