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

286 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::Writer 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_1Writer.html">Writer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1Writer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Writer Class 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="server_2Writer_8h_source.html">Writer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::Writer:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Writer__inherit__graph.png" border="0" usemap="#aripple_1_1Writer_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1Writer_inherit__map" id="aripple_1_1Writer_inherit__map">
<area shape="rect" title=" " alt="" coords="28,5,135,31"/>
<area shape="rect" href="classripple_1_1SimpleWriter.html" title="Deprecated: Writer that serializes a HTTP/1 message." alt="" coords="5,79,157,104"/>
<area shape="poly" title=" " alt="" coords="84,44,84,79,79,79,79,44"/>
</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:a173844e6daa9f39ecaf275e785267ea7" id="r_a173844e6daa9f39ecaf275e785267ea7"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Writer.html#a173844e6daa9f39ecaf275e785267ea7">~Writer</a> ()=default</td></tr>
<tr class="separator:a173844e6daa9f39ecaf275e785267ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e5d614e955a0d73bb1f95014eca5ad5" id="r_a9e5d614e955a0d73bb1f95014eca5ad5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Writer.html#a9e5d614e955a0d73bb1f95014eca5ad5">complete</a> ()=0</td></tr>
<tr class="memdesc:a9e5d614e955a0d73bb1f95014eca5ad5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if there is no more data to pull. <br /></td></tr>
<tr class="separator:a9e5d614e955a0d73bb1f95014eca5ad5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3877b4bdeed64a4dc396a9810b6dec2" id="r_af3877b4bdeed64a4dc396a9810b6dec2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Writer.html#af3877b4bdeed64a4dc396a9810b6dec2">consume</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> bytes)=0</td></tr>
<tr class="memdesc:af3877b4bdeed64a4dc396a9810b6dec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes bytes from the input sequence. <br /></td></tr>
<tr class="separator:af3877b4bdeed64a4dc396a9810b6dec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacd6a7817a08ed6b57968154c198db55" id="r_aacd6a7817a08ed6b57968154c198db55"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Writer.html#aacd6a7817a08ed6b57968154c198db55">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; resume)=0</td></tr>
<tr class="memdesc:aacd6a7817a08ed6b57968154c198db55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add data to the input sequence. <br /></td></tr>
<tr class="separator:aacd6a7817a08ed6b57968154c198db55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d540272ca1d26dcedd8b4f2538db53f" id="r_a2d540272ca1d26dcedd8b4f2538db53f"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; boost::asio::const_buffer &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Writer.html#a2d540272ca1d26dcedd8b4f2538db53f">data</a> ()=0</td></tr>
<tr class="memdesc:a2d540272ca1d26dcedd8b4f2538db53f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a ConstBufferSequence representing the input sequence. <br /></td></tr>
<tr class="separator:a2d540272ca1d26dcedd8b4f2538db53f"><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="server_2Writer_8h_source.html#l00011">11</a> of file <a class="el" href="server_2Writer_8h_source.html">server/Writer.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a173844e6daa9f39ecaf275e785267ea7" name="a173844e6daa9f39ecaf275e785267ea7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a173844e6daa9f39ecaf275e785267ea7">&#9670;&#160;</a></span>~Writer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::Writer::~Writer </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="a9e5d614e955a0d73bb1f95014eca5ad5" name="a9e5d614e955a0d73bb1f95014eca5ad5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e5d614e955a0d73bb1f95014eca5ad5">&#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 bool ripple::Writer::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>Returns <code>true</code> if there is no more data to pull. </p>
<p>Implemented in <a class="el" href="classripple_1_1SimpleWriter.html#aed8940f922abaa05f76a4bdfcf4e9669">ripple::SimpleWriter</a>.</p>
</div>
</div>
<a id="af3877b4bdeed64a4dc396a9810b6dec2" name="af3877b4bdeed64a4dc396a9810b6dec2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3877b4bdeed64a4dc396a9810b6dec2">&#9670;&#160;</a></span>consume()</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::Writer::consume </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><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>Removes bytes from the input sequence. </p>
<p>Can be called with 0. </p>
<p>Implemented in <a class="el" href="classripple_1_1SimpleWriter.html#aa60007a776c86d8f6d667b61b2c32c9d">ripple::SimpleWriter</a>.</p>
</div>
</div>
<a id="aacd6a7817a08ed6b57968154c198db55" name="aacd6a7817a08ed6b57968154c198db55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacd6a7817a08ed6b57968154c198db55">&#9670;&#160;</a></span>prepare()</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::Writer::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add data to the input sequence. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bytes</td><td>A hint to the number of bytes desired. </td></tr>
<tr><td class="paramname">resume</td><td>A functor to later resume execution. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the writer is ready to provide more data. </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1SimpleWriter.html#aab58cb9243a4f45472fb467ce2ef0d6d">ripple::SimpleWriter</a>.</p>
</div>
</div>
<a id="a2d540272ca1d26dcedd8b4f2538db53f" name="a2d540272ca1d26dcedd8b4f2538db53f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d540272ca1d26dcedd8b4f2538db53f">&#9670;&#160;</a></span>data()</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/container/vector.html">std::vector</a>&lt; boost::asio::const_buffer &gt; ripple::Writer::data </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 a ConstBufferSequence representing the input sequence. </p>
<p>Implemented in <a class="el" href="classripple_1_1SimpleWriter.html#a21f6c11438273c7b821bb358b212f84c">ripple::SimpleWriter</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