ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2b45155992b7b2747eb341ac740c4e03e32bea0f
rippled/classripple_1_1Session.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

656 lines
37 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::Session Class 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="classripple_1_1Session.html">Session</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="classripple_1_1Session-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Session Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Persistent state information for a connection session.
<a href="classripple_1_1Session.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Session_8h_source.html">Session.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::Session:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Session__inherit__graph.png" border="0" usemap="#aripple_1_1Session_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1Session_inherit__map" id="aripple_1_1Session_inherit__map">
<area shape="rect" title="Persistent state information for a connection session." alt="" coords="5,99,123,124"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title=" " alt="" coords="171,5,361,60"/>
<area shape="poly" title=" " alt="" coords="109,91,194,58,196,63,111,96"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title=" " alt="" coords="175,84,357,139"/>
<area shape="poly" title=" " alt="" coords="137,109,174,109,174,114,137,114"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title="Represents an active connection." alt="" coords="185,163,347,203"/>
<area shape="poly" title=" " alt="" coords="112,127,172,149,206,161,204,166,170,154,110,132"/>
<area shape="rect" href="classripple_1_1PlainHTTPPeer.html" title=" " alt="" coords="409,13,572,53"/>
<area shape="poly" title=" " alt="" coords="375,30,409,30,409,35,375,35"/>
<area shape="rect" href="classripple_1_1SSLHTTPPeer.html" title=" " alt="" coords="414,91,567,131"/>
<area shape="poly" title=" " alt="" coords="371,109,414,109,414,114,371,114"/>
</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:affbce918111a588e7fa49c1b0800dd21" id="r_affbce918111a588e7fa49c1b0800dd21"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#affbce918111a588e7fa49c1b0800dd21">Session</a> ()=default</td></tr>
<tr class="separator:affbce918111a588e7fa49c1b0800dd21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52d48e029fccc0db59b82bca8af69039" id="r_a52d48e029fccc0db59b82bca8af69039"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a52d48e029fccc0db59b82bca8af69039">Session</a> (<a class="el" href="classripple_1_1Session.html">Session</a> const &amp;)=delete</td></tr>
<tr class="separator:a52d48e029fccc0db59b82bca8af69039"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7a7feca1a7d3321713275557e7f05ae" id="r_ad7a7feca1a7d3321713275557e7f05ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Session.html">Session</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#ad7a7feca1a7d3321713275557e7f05ae">operator=</a> (<a class="el" href="classripple_1_1Session.html">Session</a> const &amp;)=delete</td></tr>
<tr class="separator:ad7a7feca1a7d3321713275557e7f05ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7252e8f2b56377831ac8e391f3dc5bf9" id="r_a7252e8f2b56377831ac8e391f3dc5bf9"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a7252e8f2b56377831ac8e391f3dc5bf9">~Session</a> ()=default</td></tr>
<tr class="separator:a7252e8f2b56377831ac8e391f3dc5bf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bf723e6664d299e120453b201baadee" id="r_a9bf723e6664d299e120453b201baadee"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a9bf723e6664d299e120453b201baadee">journal</a> ()=0</td></tr>
<tr class="memdesc:a9bf723e6664d299e120453b201baadee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the Journal to use for logging. <br /></td></tr>
<tr class="separator:a9bf723e6664d299e120453b201baadee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37cec955101fb6c0011a8dc490a6604f" id="r_a37cec955101fb6c0011a8dc490a6604f"><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="classripple_1_1Session.html#a37cec955101fb6c0011a8dc490a6604f">port</a> ()=0</td></tr>
<tr class="memdesc:a37cec955101fb6c0011a8dc490a6604f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="structripple_1_1Port.html" title="Configuration information for a Server listening port.">Port</a> settings for this connection. <br /></td></tr>
<tr class="separator:a37cec955101fb6c0011a8dc490a6604f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3153534e121d237bb95f43e43da22259" id="r_a3153534e121d237bb95f43e43da22259"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a3153534e121d237bb95f43e43da22259">remoteAddress</a> ()=0</td></tr>
<tr class="memdesc:a3153534e121d237bb95f43e43da22259"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the remote address of the connection. <br /></td></tr>
<tr class="separator:a3153534e121d237bb95f43e43da22259"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bc29f9523302f0761a8272bc5d67b8d" id="r_a6bc29f9523302f0761a8272bc5d67b8d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">http_request_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a6bc29f9523302f0761a8272bc5d67b8d">request</a> ()=0</td></tr>
<tr class="memdesc:a6bc29f9523302f0761a8272bc5d67b8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current HTTP request. <br /></td></tr>
<tr class="separator:a6bc29f9523302f0761a8272bc5d67b8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a503c7741af1659809d5e1f113efc1c9a" id="r_a503c7741af1659809d5e1f113efc1c9a"><td class="memItemLeft" align="right" valign="top">virtual <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_1Session.html">Session</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a503c7741af1659809d5e1f113efc1c9a">detach</a> ()=0</td></tr>
<tr class="memdesc:a503c7741af1659809d5e1f113efc1c9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detach the session. <br /></td></tr>
<tr class="separator:a503c7741af1659809d5e1f113efc1c9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af03f421d57123242a131a04c1550432f" id="r_af03f421d57123242a131a04c1550432f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#af03f421d57123242a131a04c1550432f">complete</a> ()=0</td></tr>
<tr class="memdesc:af03f421d57123242a131a04c1550432f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the response is complete. <br /></td></tr>
<tr class="separator:af03f421d57123242a131a04c1550432f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5950cab2e15a8ae0f286a179b53d262f" id="r_a5950cab2e15a8ae0f286a179b53d262f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a5950cab2e15a8ae0f286a179b53d262f">close</a> (bool graceful)=0</td></tr>
<tr class="memdesc:a5950cab2e15a8ae0f286a179b53d262f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the session. <br /></td></tr>
<tr class="separator:a5950cab2e15a8ae0f286a179b53d262f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bc078b02ae151af6c8f2560c23add42" id="r_a2bc078b02ae151af6c8f2560c23add42"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="structripple_1_1WSSession.html">WSSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a2bc078b02ae151af6c8f2560c23add42">websocketUpgrade</a> ()=0</td></tr>
<tr class="memdesc:a2bc078b02ae151af6c8f2560c23add42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the connection to WebSocket. <br /></td></tr>
<tr class="separator:a2bc078b02ae151af6c8f2560c23add42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a7ef37bf5e14c980a67ccf21342d7f80b" id="r_a7ef37bf5e14c980a67ccf21342d7f80b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a7ef37bf5e14c980a67ccf21342d7f80b">write</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;s)</td></tr>
<tr class="memdesc:a7ef37bf5e14c980a67ccf21342d7f80b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a copy of data asynchronously. <br /></td></tr>
<tr class="separator:a7ef37bf5e14c980a67ccf21342d7f80b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4d27e695ef3b85cac7c950770e4747a" id="r_ad4d27e695ef3b85cac7c950770e4747a"><td class="memTemplParams" colspan="2">template&lt;typename BufferSequence &gt; </td></tr>
<tr class="memitem:ad4d27e695ef3b85cac7c950770e4747a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#ad4d27e695ef3b85cac7c950770e4747a">write</a> (BufferSequence const &amp;buffers)</td></tr>
<tr class="separator:ad4d27e695ef3b85cac7c950770e4747a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0acef5ec64ad04c47c5ededaf72cc07" id="r_ae0acef5ec64ad04c47c5ededaf72cc07"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#ae0acef5ec64ad04c47c5ededaf72cc07">write</a> (void const *buffer, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> bytes)=0</td></tr>
<tr class="separator:ae0acef5ec64ad04c47c5ededaf72cc07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c36d70d9ce286186ce8f1cf52742ca1" id="r_a7c36d70d9ce286186ce8f1cf52742ca1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a7c36d70d9ce286186ce8f1cf52742ca1">write</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_1Writer.html">Writer</a> &gt; const &amp;writer, bool keep_alive)=0</td></tr>
<tr class="separator:a7c36d70d9ce286186ce8f1cf52742ca1"><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:a8e66069a5970203f04fc737b84d53c72" id="r_a8e66069a5970203f04fc737b84d53c72"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Session.html#a8e66069a5970203f04fc737b84d53c72">tag</a> = nullptr</td></tr>
<tr class="memdesc:a8e66069a5970203f04fc737b84d53c72"><td class="mdescLeft">&#160;</td><td class="mdescRight">A user-definable pointer. <br /></td></tr>
<tr class="separator:a8e66069a5970203f04fc737b84d53c72"><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>Persistent state information for a connection session. </p>
<p>These values are preserved between calls for efficiency. Some fields are input parameters, some are output parameters, and all only become defined during specific callbacks. </p>
<p class="definition">Definition at line <a class="el" href="Session_8h_source.html#l00023">23</a> of file <a class="el" href="Session_8h_source.html">Session.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="affbce918111a588e7fa49c1b0800dd21" name="affbce918111a588e7fa49c1b0800dd21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affbce918111a588e7fa49c1b0800dd21">&#9670;&#160;</a></span>Session() <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::Session::Session </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="a52d48e029fccc0db59b82bca8af69039" name="a52d48e029fccc0db59b82bca8af69039"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52d48e029fccc0db59b82bca8af69039">&#9670;&#160;</a></span>Session() <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::Session::Session </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Session.html">Session</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="a7252e8f2b56377831ac8e391f3dc5bf9" name="a7252e8f2b56377831ac8e391f3dc5bf9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7252e8f2b56377831ac8e391f3dc5bf9">&#9670;&#160;</a></span>~Session()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::Session::~Session </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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad7a7feca1a7d3321713275557e7f05ae" name="ad7a7feca1a7d3321713275557e7f05ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7a7feca1a7d3321713275557e7f05ae">&#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="classripple_1_1Session.html">Session</a> &amp; ripple::Session::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Session.html">Session</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="a9bf723e6664d299e120453b201baadee" name="a9bf723e6664d299e120453b201baadee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bf723e6664d299e120453b201baadee">&#9670;&#160;</a></span>journal()</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="classbeast_1_1Journal.html">beast::Journal</a> ripple::Session::journal </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>Returns the Journal to use for logging. </p>
<p>Implemented in <a class="el" href="classripple_1_1BaseHTTPPeer.html#aff9d53bd74b61d6eae3b62850a46271e">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#aff9d53bd74b61d6eae3b62850a46271e">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#aff9d53bd74b61d6eae3b62850a46271e">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a37cec955101fb6c0011a8dc490a6604f" name="a37cec955101fb6c0011a8dc490a6604f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37cec955101fb6c0011a8dc490a6604f">&#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::Session::port </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>Returns the <a class="el" href="structripple_1_1Port.html" title="Configuration information for a Server listening port.">Port</a> settings for this connection. </p>
<p>Implemented in <a class="el" href="classripple_1_1BaseHTTPPeer.html#a240dab5c44197fcd1888fa86017b5915">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#a240dab5c44197fcd1888fa86017b5915">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#a240dab5c44197fcd1888fa86017b5915">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a3153534e121d237bb95f43e43da22259" name="a3153534e121d237bb95f43e43da22259"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3153534e121d237bb95f43e43da22259">&#9670;&#160;</a></span>remoteAddress()</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="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> ripple::Session::remoteAddress </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>Returns the remote address of the connection. </p>
<p>Implemented in <a class="el" href="classripple_1_1BaseHTTPPeer.html#a89958b61c0c00d875bdf5a9c24562a51">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#a89958b61c0c00d875bdf5a9c24562a51">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#a89958b61c0c00d875bdf5a9c24562a51">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a6bc29f9523302f0761a8272bc5d67b8d" name="a6bc29f9523302f0761a8272bc5d67b8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bc29f9523302f0761a8272bc5d67b8d">&#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> &amp; ripple::Session::request </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>Returns the current HTTP request. </p>
<p>Implemented in <a class="el" href="classripple_1_1BaseHTTPPeer.html#ac48502b9300e891c8ad8f41497530b56">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#ac48502b9300e891c8ad8f41497530b56">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#ac48502b9300e891c8ad8f41497530b56">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a7ef37bf5e14c980a67ccf21342d7f80b" name="a7ef37bf5e14c980a67ccf21342d7f80b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ef37bf5e14c980a67ccf21342d7f80b">&#9670;&#160;</a></span>write() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::Session::write </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a copy of data asynchronously. </p>
<p class="definition">Definition at line <a class="el" href="Session_8h_source.html#l00057">57</a> of file <a class="el" href="Session_8h_source.html">Session.h</a>.</p>
</div>
</div>
<a id="ad4d27e695ef3b85cac7c950770e4747a" name="ad4d27e695ef3b85cac7c950770e4747a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4d27e695ef3b85cac7c950770e4747a">&#9670;&#160;</a></span>write() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BufferSequence &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ripple::Session::write </td>
<td>(</td>
<td class="paramtype">BufferSequence const &amp;&#160;</td>
<td class="paramname"><em>buffers</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Session_8h_source.html#l00065">65</a> of file <a class="el" href="Session_8h_source.html">Session.h</a>.</p>
</div>
</div>
<a id="ae0acef5ec64ad04c47c5ededaf72cc07" name="ae0acef5ec64ad04c47c5ededaf72cc07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0acef5ec64ad04c47c5ededaf72cc07">&#9670;&#160;</a></span>write() <span class="overload">[3/4]</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::Session::write </td>
<td>(</td>
<td class="paramtype">void const *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>bytes</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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_1BaseHTTPPeer.html#a1b5f027094241df6cf223121cce472c9">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#a1b5f027094241df6cf223121cce472c9">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#a1b5f027094241df6cf223121cce472c9">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a7c36d70d9ce286186ce8f1cf52742ca1" name="a7c36d70d9ce286186ce8f1cf52742ca1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c36d70d9ce286186ce8f1cf52742ca1">&#9670;&#160;</a></span>write() <span class="overload">[4/4]</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::Session::write </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_1Writer.html">Writer</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>writer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>keep_alive</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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_1BaseHTTPPeer.html#a3cc3bb9cb450732a913985d11e94d74b">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#a3cc3bb9cb450732a913985d11e94d74b">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#a3cc3bb9cb450732a913985d11e94d74b">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a503c7741af1659809d5e1f113efc1c9a" name="a503c7741af1659809d5e1f113efc1c9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a503c7741af1659809d5e1f113efc1c9a">&#9670;&#160;</a></span>detach()</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="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Session.html">Session</a> &gt; ripple::Session::detach </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>Detach the session. </p>
<p>This holds the session open so that the response can be sent asynchronously. Calls to io_context::run made by the server will not return until all detached sessions are closed. </p>
<p>Implemented in <a class="el" href="classripple_1_1BaseHTTPPeer.html#abebfe90f713e5db580fd1b8a35b9aa93">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#abebfe90f713e5db580fd1b8a35b9aa93">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#abebfe90f713e5db580fd1b8a35b9aa93">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="af03f421d57123242a131a04c1550432f" name="af03f421d57123242a131a04c1550432f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af03f421d57123242a131a04c1550432f">&#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::Session::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. If Keep-Alive is indicated on the connection, this will trigger a read for the next request; else, the connection will be closed when all remaining data has been sent. </p>
<p>Implemented in <a class="el" href="classripple_1_1BaseHTTPPeer.html#acc518d685dfcf92be4c6196684180cf8">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#acc518d685dfcf92be4c6196684180cf8">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#acc518d685dfcf92be4c6196684180cf8">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a5950cab2e15a8ae0f286a179b53d262f" name="a5950cab2e15a8ae0f286a179b53d262f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5950cab2e15a8ae0f286a179b53d262f">&#9670;&#160;</a></span>close()</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::Session::close </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>graceful</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>Close the session. </p>
<p>This will be performed asynchronously. The session will be closed gracefully after all pending writes have completed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">graceful</td><td><code>true</code> to wait until all data has finished sending. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classripple_1_1BaseHTTPPeer.html#a9184879f5d4d9fa13564d6cbb6a610b1">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#a9184879f5d4d9fa13564d6cbb6a610b1">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BaseHTTPPeer.html#a9184879f5d4d9fa13564d6cbb6a610b1">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<a id="a2bc078b02ae151af6c8f2560c23add42" name="a2bc078b02ae151af6c8f2560c23add42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bc078b02ae151af6c8f2560c23add42">&#9670;&#160;</a></span>websocketUpgrade()</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="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="structripple_1_1WSSession.html">WSSession</a> &gt; ripple::Session::websocketUpgrade </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>Convert the connection to WebSocket. </p>
<p>Implemented in <a class="el" href="classripple_1_1PlainHTTPPeer.html#a9c0f50f624bd173b9224d0df05368dad">ripple::PlainHTTPPeer&lt; Handler &gt;</a>, and <a class="el" href="classripple_1_1SSLHTTPPeer.html#a346b5c48d65d5a22db94f841bc9a83a3">ripple::SSLHTTPPeer&lt; Handler &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8e66069a5970203f04fc737b84d53c72" name="a8e66069a5970203f04fc737b84d53c72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e66069a5970203f04fc737b84d53c72">&#9670;&#160;</a></span>tag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ripple::Session::tag = nullptr</td>
</tr>
</table>
</div><div class="memdoc">
<p>A user-definable pointer. </p>
<p>The initial value is always zero. Changes to the value are persisted between calls. </p>
<p class="definition">Definition at line <a class="el" href="Session_8h_source.html#l00036">36</a> of file <a class="el" href="Session_8h_source.html">Session.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