ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-23 12:35:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/classripple_1_1HTTPStream.html
manojsdoshi dffdcfc0e7 deploy: 9d89d4c188
2021-03-12 22:34:28 +00:00

402 lines
19 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::HTTPStream 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1HTTPStream.html">HTTPStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1HTTPStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::HTTPStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ripple::HTTPStream:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1HTTPStream__inherit__graph.png" border="0" usemap="#ripple_1_1HTTPStream_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1HTTPStream_inherit__map" id="ripple_1_1HTTPStream_inherit__map">
<area shape="rect" title=" " alt="" coords="84,5,232,32"/>
<area shape="rect" href="classripple_1_1RawStream.html" title=" " alt="" coords="5,80,148,107"/>
<area shape="rect" href="classripple_1_1SSLStream.html" title=" " alt="" coords="172,80,309,107"/>
</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 name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:adaedf72be1e41c7baad6422bd4c4b965"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1HTTPStream.html#adaedf72be1e41c7baad6422bd4c4b965">request</a> = boost::beast::http::request&lt; boost::beast::http::empty_body &gt;</td></tr>
<tr class="separator:adaedf72be1e41c7baad6422bd4c4b965"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1af9210c0f8c4b51ab17fa23db5dcaa"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1HTTPStream.html#ae1af9210c0f8c4b51ab17fa23db5dcaa">parser</a> = boost::beast::http::basic_parser&lt; false &gt;</td></tr>
<tr class="separator:ae1af9210c0f8c4b51ab17fa23db5dcaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afe02610b424d6ed1f58adea4950e8b7d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1HTTPStream.html#afe02610b424d6ed1f58adea4950e8b7d">~HTTPStream</a> ()=default</td></tr>
<tr class="separator:afe02610b424d6ed1f58adea4950e8b7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfdaadeaf054e17c50ad69a363a1005f"><td class="memItemLeft" align="right" valign="top">virtual boost::asio::ip::tcp::socket &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1HTTPStream.html#acfdaadeaf054e17c50ad69a363a1005f">getStream</a> ()=0</td></tr>
<tr class="separator:acfdaadeaf054e17c50ad69a363a1005f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad830795f6b182b183c8160553e8cb25d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1HTTPStream.html#ad830795f6b182b183c8160553e8cb25d">connect</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;errorOut, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;host, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;port, boost::asio::yield_context &amp;yield)=0</td></tr>
<tr class="separator:ad830795f6b182b183c8160553e8cb25d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada3094239b9cedb4417c31edc3fd8c70"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1HTTPStream.html#ada3094239b9cedb4417c31edc3fd8c70">asyncWrite</a> (<a class="el" href="classripple_1_1HTTPStream.html#adaedf72be1e41c7baad6422bd4c4b965">request</a> &amp;req, boost::asio::yield_context &amp;yield, boost::system::error_code &amp;ec)=0</td></tr>
<tr class="separator:ada3094239b9cedb4417c31edc3fd8c70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a852d1708918beddb12c088d35f6c924b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1HTTPStream.html#a852d1708918beddb12c088d35f6c924b">asyncRead</a> (boost::beast::flat_buffer &amp;buf, <a class="el" href="classripple_1_1HTTPStream.html#ae1af9210c0f8c4b51ab17fa23db5dcaa">parser</a> &amp;p, boost::asio::yield_context &amp;yield, boost::system::error_code &amp;ec)=0</td></tr>
<tr class="separator:a852d1708918beddb12c088d35f6c924b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4a8049d8ab3daa91b5814ec72f20072"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1HTTPStream.html#ab4a8049d8ab3daa91b5814ec72f20072">asyncReadSome</a> (boost::beast::flat_buffer &amp;buf, <a class="el" href="classripple_1_1HTTPStream.html#ae1af9210c0f8c4b51ab17fa23db5dcaa">parser</a> &amp;p, boost::asio::yield_context &amp;yield, boost::system::error_code &amp;ec)=0</td></tr>
<tr class="separator:ab4a8049d8ab3daa91b5814ec72f20072"><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="HTTPStream_8h_source.html#l00035">35</a> of file <a class="el" href="HTTPStream_8h_source.html">HTTPStream.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="adaedf72be1e41c7baad6422bd4c4b965"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adaedf72be1e41c7baad6422bd4c4b965">&#9670;&nbsp;</a></span>request</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1HTTPStream.html#adaedf72be1e41c7baad6422bd4c4b965">ripple::HTTPStream::request</a> = boost::beast::http::request&lt;boost::beast::http::empty_body&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="HTTPStream_8h_source.html#l00038">38</a> of file <a class="el" href="HTTPStream_8h_source.html">HTTPStream.h</a>.</p>
</div>
</div>
<a id="ae1af9210c0f8c4b51ab17fa23db5dcaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1af9210c0f8c4b51ab17fa23db5dcaa">&#9670;&nbsp;</a></span>parser</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1HTTPStream.html#ae1af9210c0f8c4b51ab17fa23db5dcaa">ripple::HTTPStream::parser</a> = boost::beast::http::basic_parser&lt;false&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="HTTPStream_8h_source.html#l00039">39</a> of file <a class="el" href="HTTPStream_8h_source.html">HTTPStream.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afe02610b424d6ed1f58adea4950e8b7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe02610b424d6ed1f58adea4950e8b7d">&#9670;&nbsp;</a></span>~HTTPStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::HTTPStream::~HTTPStream </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="acfdaadeaf054e17c50ad69a363a1005f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfdaadeaf054e17c50ad69a363a1005f">&#9670;&nbsp;</a></span>getStream()</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::socket&amp; ripple::HTTPStream::getStream </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_1RawStream.html#a5faa92440a13689961c047c15f793607">ripple::RawStream</a>, and <a class="el" href="classripple_1_1SSLStream.html#a7937719d2404f5a9b1edbb39e1f9de53">ripple::SSLStream</a>.</p>
</div>
</div>
<a id="ad830795f6b182b183c8160553e8cb25d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad830795f6b182b183c8160553e8cb25d">&#9670;&nbsp;</a></span>connect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ripple::HTTPStream::connect </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;&#160;</td>
<td class="paramname"><em>errorOut</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::asio::yield_context &amp;&#160;</td>
<td class="paramname"><em>yield</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_1RawStream.html#ab5fe3709f147f522aa491ea694299da0">ripple::RawStream</a>, and <a class="el" href="classripple_1_1SSLStream.html#a0b9a2e54b9323f0c1e0f906d3aca4cd4">ripple::SSLStream</a>.</p>
</div>
</div>
<a id="ada3094239b9cedb4417c31edc3fd8c70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada3094239b9cedb4417c31edc3fd8c70">&#9670;&nbsp;</a></span>asyncWrite()</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::HTTPStream::asyncWrite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1HTTPStream.html#adaedf72be1e41c7baad6422bd4c4b965">request</a> &amp;&#160;</td>
<td class="paramname"><em>req</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::asio::yield_context &amp;&#160;</td>
<td class="paramname"><em>yield</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::system::error_code &amp;&#160;</td>
<td class="paramname"><em>ec</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_1RawStream.html#a4afda9f235e8bcec83ba18cc0346aed7">ripple::RawStream</a>, and <a class="el" href="classripple_1_1SSLStream.html#afb72bab804e165234e643bb5724a398a">ripple::SSLStream</a>.</p>
</div>
</div>
<a id="a852d1708918beddb12c088d35f6c924b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a852d1708918beddb12c088d35f6c924b">&#9670;&nbsp;</a></span>asyncRead()</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::HTTPStream::asyncRead </td>
<td>(</td>
<td class="paramtype">boost::beast::flat_buffer &amp;&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1HTTPStream.html#ae1af9210c0f8c4b51ab17fa23db5dcaa">parser</a> &amp;&#160;</td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::asio::yield_context &amp;&#160;</td>
<td class="paramname"><em>yield</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::system::error_code &amp;&#160;</td>
<td class="paramname"><em>ec</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_1RawStream.html#a4befbb4488a79896bce339e98e51d35b">ripple::RawStream</a>, and <a class="el" href="classripple_1_1SSLStream.html#afd5dc8f168c0b52004d64ba24acfcdda">ripple::SSLStream</a>.</p>
</div>
</div>
<a id="ab4a8049d8ab3daa91b5814ec72f20072"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4a8049d8ab3daa91b5814ec72f20072">&#9670;&nbsp;</a></span>asyncReadSome()</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::HTTPStream::asyncReadSome </td>
<td>(</td>
<td class="paramtype">boost::beast::flat_buffer &amp;&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1HTTPStream.html#ae1af9210c0f8c4b51ab17fa23db5dcaa">parser</a> &amp;&#160;</td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::asio::yield_context &amp;&#160;</td>
<td class="paramname"><em>yield</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::system::error_code &amp;&#160;</td>
<td class="paramname"><em>ec</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_1RawStream.html#ad150796218c98b411ff0fd11000c1ab1">ripple::RawStream</a>, and <a class="el" href="classripple_1_1SSLStream.html#a0d852cd4a3f4c36990086fd5b2197337">ripple::SSLStream</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink