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

502 lines
27 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: ripple::WSSession Struct Reference</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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="structripple_1_1WSSession.html">WSSession</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1WSSession-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::WSSession Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="WSSession_8h_source.html">WSSession.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::WSSession:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1WSSession__inherit__graph.png" border="0" usemap="#aripple_1_1WSSession_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1WSSession_inherit__map" id="aripple_1_1WSSession_inherit__map">
<area shape="rect" title=" " alt="" coords="5,99,144,124"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title=" " alt="" coords="192,5,371,60"/>
<area shape="poly" title=" " alt="" coords="121,91,208,58,210,63,123,96"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title=" " alt="" coords="197,84,365,139"/>
<area shape="poly" title=" " alt="" coords="158,109,197,109,197,114,158,114"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title="Represents an active WebSocket connection." alt="" coords="207,163,356,203"/>
<area shape="poly" title=" " alt="" coords="126,126,224,161,222,166,124,131"/>
<area shape="rect" href="classripple_1_1PlainWSPeer.html" title=" " alt="" coords="419,13,569,53"/>
<area shape="poly" title=" " alt="" coords="385,30,419,30,419,35,385,35"/>
<area shape="rect" href="classripple_1_1SSLWSPeer.html" title=" " alt="" coords="419,91,569,131"/>
<area shape="poly" title=" " alt="" coords="379,109,418,109,418,114,379,114"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::WSSession:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1WSSession__coll__graph.png" border="0" usemap="#aripple_1_1WSSession_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1WSSession_coll__map" id="aripple_1_1WSSession_coll__map">
<area shape="rect" title=" " alt="" coords="25,93,163,119"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="5,5,183,31"/>
<area shape="poly" title=" " alt="" coords="97,45,97,93,91,93,91,45"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af2873180683531fcbac7a58059fb5f8a" id="r_af2873180683531fcbac7a58059fb5f8a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#af2873180683531fcbac7a58059fb5f8a">~WSSession</a> ()=default</td></tr>
<tr class="separator:af2873180683531fcbac7a58059fb5f8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa04e8f3c9fedb35f8a52180f2de647a1" id="r_aa04e8f3c9fedb35f8a52180f2de647a1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#aa04e8f3c9fedb35f8a52180f2de647a1">WSSession</a> ()=default</td></tr>
<tr class="separator:aa04e8f3c9fedb35f8a52180f2de647a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad71e83d9e5906f603b943f84dd44555e" id="r_ad71e83d9e5906f603b943f84dd44555e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#ad71e83d9e5906f603b943f84dd44555e">WSSession</a> (<a class="el" href="structripple_1_1WSSession.html">WSSession</a> const &amp;)=delete</td></tr>
<tr class="separator:ad71e83d9e5906f603b943f84dd44555e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a706f8ad1002d6c19e44fa2af60243b63" id="r_a706f8ad1002d6c19e44fa2af60243b63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1WSSession.html">WSSession</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#a706f8ad1002d6c19e44fa2af60243b63">operator=</a> (<a class="el" href="structripple_1_1WSSession.html">WSSession</a> const &amp;)=delete</td></tr>
<tr class="separator:a706f8ad1002d6c19e44fa2af60243b63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d8ff14085fd9951038f860a4a08939f" id="r_a8d8ff14085fd9951038f860a4a08939f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#a8d8ff14085fd9951038f860a4a08939f">run</a> ()=0</td></tr>
<tr class="separator:a8d8ff14085fd9951038f860a4a08939f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a744eee07322a943e85dd4549c86a78f4" id="r_a744eee07322a943e85dd4549c86a78f4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structripple_1_1Port.html">Port</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#a744eee07322a943e85dd4549c86a78f4">port</a> () const =0</td></tr>
<tr class="separator:a744eee07322a943e85dd4549c86a78f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45f868ea10de1df1550395a965e86541" id="r_a45f868ea10de1df1550395a965e86541"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">http_request_type</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#a45f868ea10de1df1550395a965e86541">request</a> () const =0</td></tr>
<tr class="separator:a45f868ea10de1df1550395a965e86541"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ec5802c9aeeddc9e22790af6ab0cad2" id="r_a6ec5802c9aeeddc9e22790af6ab0cad2"><td class="memItemLeft" align="right" valign="top">virtual boost::asio::ip::tcp::endpoint const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#a6ec5802c9aeeddc9e22790af6ab0cad2">remote_endpoint</a> () const =0</td></tr>
<tr class="separator:a6ec5802c9aeeddc9e22790af6ab0cad2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e7e0b568ae4bcced108341224dec263" id="r_a8e7e0b568ae4bcced108341224dec263"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#a8e7e0b568ae4bcced108341224dec263">send</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1WSMsg.html">WSMsg</a> &gt; w)=0</td></tr>
<tr class="memdesc:a8e7e0b568ae4bcced108341224dec263"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a WebSockets message. <br /></td></tr>
<tr class="separator:a8e7e0b568ae4bcced108341224dec263"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17da7bcecda1540505b77c4bab0a5b93" id="r_a17da7bcecda1540505b77c4bab0a5b93"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#a17da7bcecda1540505b77c4bab0a5b93">close</a> ()=0</td></tr>
<tr class="separator:a17da7bcecda1540505b77c4bab0a5b93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3b2298b56bf9e479c89df60e32215b9" id="r_aa3b2298b56bf9e479c89df60e32215b9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#aa3b2298b56bf9e479c89df60e32215b9">close</a> (boost::beast::websocket::close_reason const &amp;reason)=0</td></tr>
<tr class="separator:aa3b2298b56bf9e479c89df60e32215b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad95020dc99b4322736f342c9427f6445" id="r_ad95020dc99b4322736f342c9427f6445"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#ad95020dc99b4322736f342c9427f6445">complete</a> ()=0</td></tr>
<tr class="memdesc:ad95020dc99b4322736f342c9427f6445"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the response is complete. <br /></td></tr>
<tr class="separator:ad95020dc99b4322736f342c9427f6445"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2b91a0f839ba3bde37fd06444fa5d931" id="r_a2b91a0f839ba3bde37fd06444fa5d931"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1WSSession.html#a2b91a0f839ba3bde37fd06444fa5d931">appDefined</a></td></tr>
<tr class="separator:a2b91a0f839ba3bde37fd06444fa5d931"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="WSSession_8h_source.html#l00107">107</a> of file <a class="el" href="WSSession_8h_source.html">WSSession.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af2873180683531fcbac7a58059fb5f8a" name="af2873180683531fcbac7a58059fb5f8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2873180683531fcbac7a58059fb5f8a">&#9670;&#160;</a></span>~WSSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::WSSession::~WSSession </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa04e8f3c9fedb35f8a52180f2de647a1" name="aa04e8f3c9fedb35f8a52180f2de647a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa04e8f3c9fedb35f8a52180f2de647a1">&#9670;&#160;</a></span>WSSession() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::WSSession::WSSession </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad71e83d9e5906f603b943f84dd44555e" name="ad71e83d9e5906f603b943f84dd44555e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad71e83d9e5906f603b943f84dd44555e">&#9670;&#160;</a></span>WSSession() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::WSSession::WSSession </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1WSSession.html">WSSession</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a706f8ad1002d6c19e44fa2af60243b63" name="a706f8ad1002d6c19e44fa2af60243b63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a706f8ad1002d6c19e44fa2af60243b63">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1WSSession.html">WSSession</a> &amp; ripple::WSSession::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1WSSession.html">WSSession</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8d8ff14085fd9951038f860a4a08939f" name="a8d8ff14085fd9951038f860a4a08939f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d8ff14085fd9951038f860a4a08939f">&#9670;&#160;</a></span>run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::WSSession::run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1BaseWSPeer.html#abfcbf7e3a0537770be7001d581f7098f">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#abfcbf7e3a0537770be7001d581f7098f">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseWSPeer.html#abfcbf7e3a0537770be7001d581f7098f">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a744eee07322a943e85dd4549c86a78f4" name="a744eee07322a943e85dd4549c86a78f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a744eee07322a943e85dd4549c86a78f4">&#9670;&#160;</a></span>port()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structripple_1_1Port.html">Port</a> const &amp; ripple::WSSession::port </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1BaseWSPeer.html#a894b1e36aaef17cc7bc2e5620db1126e">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a894b1e36aaef17cc7bc2e5620db1126e">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseWSPeer.html#a894b1e36aaef17cc7bc2e5620db1126e">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a45f868ea10de1df1550395a965e86541" name="a45f868ea10de1df1550395a965e86541"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45f868ea10de1df1550395a965e86541">&#9670;&#160;</a></span>request()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">http_request_type</a> const &amp; ripple::WSSession::request </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1BaseWSPeer.html#a2327c1c59bad48a2c4972b8b5b593de8">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a2327c1c59bad48a2c4972b8b5b593de8">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseWSPeer.html#a2327c1c59bad48a2c4972b8b5b593de8">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a6ec5802c9aeeddc9e22790af6ab0cad2" name="a6ec5802c9aeeddc9e22790af6ab0cad2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ec5802c9aeeddc9e22790af6ab0cad2">&#9670;&#160;</a></span>remote_endpoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual boost::asio::ip::tcp::endpoint const &amp; ripple::WSSession::remote_endpoint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1BaseWSPeer.html#a8276d7fe8845272d9794f38b798508bf">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a8276d7fe8845272d9794f38b798508bf">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseWSPeer.html#a8276d7fe8845272d9794f38b798508bf">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a8e7e0b568ae4bcced108341224dec263" name="a8e7e0b568ae4bcced108341224dec263"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e7e0b568ae4bcced108341224dec263">&#9670;&#160;</a></span>send()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::WSSession::send </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1WSMsg.html">WSMsg</a> &gt;&#160;</td>
<td class="paramname"><em>w</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a WebSockets message. </p>
<p>Implemented in <a class="el" href="classripple_1_1BaseWSPeer.html#a95efb377404ff6fd4197e48c879668f3">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a95efb377404ff6fd4197e48c879668f3">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseWSPeer.html#a95efb377404ff6fd4197e48c879668f3">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a17da7bcecda1540505b77c4bab0a5b93" name="a17da7bcecda1540505b77c4bab0a5b93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17da7bcecda1540505b77c4bab0a5b93">&#9670;&#160;</a></span>close() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::WSSession::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1BaseWSPeer.html#a97a9f5f6956b657add9bb7bea1890604">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a97a9f5f6956b657add9bb7bea1890604">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseWSPeer.html#a97a9f5f6956b657add9bb7bea1890604">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="aa3b2298b56bf9e479c89df60e32215b9" name="aa3b2298b56bf9e479c89df60e32215b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3b2298b56bf9e479c89df60e32215b9">&#9670;&#160;</a></span>close() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::WSSession::close </td>
<td>(</td>
<td class="paramtype">boost::beast::websocket::close_reason const &amp;&#160;</td>
<td class="paramname"><em>reason</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1BaseWSPeer.html#a5363d3570049b626c78bacd9e5023cd3">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a5363d3570049b626c78bacd9e5023cd3">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseWSPeer.html#a5363d3570049b626c78bacd9e5023cd3">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="ad95020dc99b4322736f342c9427f6445" name="ad95020dc99b4322736f342c9427f6445"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad95020dc99b4322736f342c9427f6445">&#9670;&#160;</a></span>complete()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::WSSession::complete </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicate that the response is complete. </p>
<p>The handler should call this when it has completed writing the response. </p>
<p>Implemented in <a class="el" href="classripple_1_1BaseWSPeer.html#a8f6413535433f5820faf23f394e61225">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a8f6413535433f5820faf23f394e61225">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseWSPeer.html#a8f6413535433f5820faf23f394e61225">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2b91a0f839ba3bde37fd06444fa5d931" name="a2b91a0f839ba3bde37fd06444fa5d931"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b91a0f839ba3bde37fd06444fa5d931">&#9670;&#160;</a></span>appDefined</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt;void&gt; ripple::WSSession::appDefined</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="WSSession_8h_source.html#l00109">109</a> of file <a class="el" href="WSSession_8h_source.html">WSSession.h</a>.</p>
</div>
</div>
</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