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
gh-pages
rippled/classripple_1_1StreambufWSMsg.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

258 lines
14 KiB
HTML
Raw Permalink 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::StreambufWSMsg&lt; Streambuf &gt; Class Template 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_1StreambufWSMsg.html">StreambufWSMsg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1StreambufWSMsg-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::StreambufWSMsg&lt; Streambuf &gt; Class Template Reference</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::StreambufWSMsg&lt; Streambuf &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1StreambufWSMsg__inherit__graph.png" border="0" usemap="#aripple_1_1StreambufWSMsg_3_01Streambuf_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1StreambufWSMsg_3_01Streambuf_01_4_inherit__map" id="aripple_1_1StreambufWSMsg_3_01Streambuf_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,79,188,119"/>
<area shape="rect" href="classripple_1_1WSMsg.html" title=" " alt="" coords="39,5,154,31"/>
<area shape="poly" title=" " alt="" coords="99,44,99,79,94,79,94,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::StreambufWSMsg&lt; Streambuf &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1StreambufWSMsg__coll__graph.png" border="0" usemap="#aripple_1_1StreambufWSMsg_3_01Streambuf_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1StreambufWSMsg_3_01Streambuf_01_4_coll__map" id="aripple_1_1StreambufWSMsg_3_01Streambuf_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="34,93,217,133"/>
<area shape="rect" href="classripple_1_1WSMsg.html" title=" " alt="" coords="5,5,120,31"/>
<area shape="poly" title=" " alt="" coords="80,41,115,92,110,95,76,44"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="144,5,232,31"/>
<area shape="poly" title=" " alt="" coords="175,44,140,95,136,92,170,41"/>
</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:ae4448cac0f175fdeca377bcdbe04b1ca" id="r_ae4448cac0f175fdeca377bcdbe04b1ca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1StreambufWSMsg.html#ae4448cac0f175fdeca377bcdbe04b1ca">StreambufWSMsg</a> (Streambuf &amp;&amp;sb)</td></tr>
<tr class="separator:ae4448cac0f175fdeca377bcdbe04b1ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60de9ff038a97a7f85fecc97dd115f7e" id="r_a60de9ff038a97a7f85fecc97dd115f7e"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>&lt; boost::tribool, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; boost::asio::const_buffer &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1StreambufWSMsg.html#a60de9ff038a97a7f85fecc97dd115f7e">prepare</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> bytes, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void(void)&gt;) override</td></tr>
<tr class="memdesc:a60de9ff038a97a7f85fecc97dd115f7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve message data. <br /></td></tr>
<tr class="separator:a60de9ff038a97a7f85fecc97dd115f7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a92b1963360380594112cd3b746c10fdd" id="r_a92b1963360380594112cd3b746c10fdd"><td class="memItemLeft" align="right" valign="top">Streambuf&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1StreambufWSMsg.html#a92b1963360380594112cd3b746c10fdd">sb_</a></td></tr>
<tr class="separator:a92b1963360380594112cd3b746c10fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40941fb7fde09a644a5da538e410bc05" id="r_a40941fb7fde09a644a5da538e410bc05"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1StreambufWSMsg.html#a40941fb7fde09a644a5da538e410bc05">n_</a> = 0</td></tr>
<tr class="separator:a40941fb7fde09a644a5da538e410bc05"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class Streambuf&gt;<br />
class ripple::StreambufWSMsg&lt; Streambuf &gt;</div>
<p class="definition">Definition at line <a class="el" href="WSSession_8h_source.html#l00053">53</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="ae4448cac0f175fdeca377bcdbe04b1ca" name="ae4448cac0f175fdeca377bcdbe04b1ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4448cac0f175fdeca377bcdbe04b1ca">&#9670;&#160;</a></span>StreambufWSMsg()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Streambuf &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1StreambufWSMsg.html">ripple::StreambufWSMsg</a>&lt; Streambuf &gt;::StreambufWSMsg </td>
<td>(</td>
<td class="paramtype">Streambuf &amp;&amp;&#160;</td>
<td class="paramname"><em>sb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="WSSession_8h_source.html#l00059">59</a> of file <a class="el" href="WSSession_8h_source.html">WSSession.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a60de9ff038a97a7f85fecc97dd115f7e" name="a60de9ff038a97a7f85fecc97dd115f7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60de9ff038a97a7f85fecc97dd115f7e">&#9670;&#160;</a></span>prepare()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Streambuf &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>&lt; boost::tribool, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; boost::asio::const_buffer &gt; &gt; <a class="el" href="classripple_1_1StreambufWSMsg.html">ripple::StreambufWSMsg</a>&lt; Streambuf &gt;::prepare </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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void(void)&gt;&#160;</td>
<td class="paramname"><em>resume</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve message data. </p>
<p>Returns a tribool indicating whether or not data is available, and a ConstBufferSequence representing the data.</p>
<p>tribool values: maybe: Data is not ready yet false: Data is available true: Data is available, and it is the last chunk of bytes.</p>
<p>Derived classes that do not know when the data ends (for example, when returning the output of a paged database query) may return <code>true</code> and an empty vector. </p>
<p>Implements <a class="el" href="classripple_1_1WSMsg.html#a783fa465c220ef5de8f4567d2f7f3f98">ripple::WSMsg</a>.</p>
<p class="definition">Definition at line <a class="el" href="WSSession_8h_source.html#l00064">64</a> of file <a class="el" href="WSSession_8h_source.html">WSSession.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a92b1963360380594112cd3b746c10fdd" name="a92b1963360380594112cd3b746c10fdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92b1963360380594112cd3b746c10fdd">&#9670;&#160;</a></span>sb_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Streambuf &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Streambuf <a class="el" href="classripple_1_1StreambufWSMsg.html">ripple::StreambufWSMsg</a>&lt; Streambuf &gt;::sb_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="WSSession_8h_source.html#l00055">55</a> of file <a class="el" href="WSSession_8h_source.html">WSSession.h</a>.</p>
</div>
</div>
<a id="a40941fb7fde09a644a5da538e410bc05" name="a40941fb7fde09a644a5da538e410bc05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40941fb7fde09a644a5da538e410bc05">&#9670;&#160;</a></span>n_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Streambuf &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="el" href="classripple_1_1StreambufWSMsg.html">ripple::StreambufWSMsg</a>&lt; Streambuf &gt;::n_ = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="WSSession_8h_source.html#l00056">56</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