ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6e4b4ad064564d5fe2e166d04d113d603ddab3f9
rippled/classripple_1_1DatabaseBody_1_1reader.html
manojsdoshi 1ce46a7e6b deploy: aee422e819
2021-07-28 21:28:06 +00:00

379 lines
20 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::DatabaseBody::reader 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="structripple_1_1DatabaseBody.html">DatabaseBody</a></li><li class="navelem"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html">reader</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="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classripple_1_1DatabaseBody_1_1reader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::DatabaseBody::reader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Algorithm for storing buffers when parsing.
<a href="classripple_1_1DatabaseBody_1_1reader.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::DatabaseBody::reader:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1DatabaseBody_1_1reader__coll__graph.png" border="0" usemap="#ripple_1_1DatabaseBody_1_1reader_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1DatabaseBody_1_1reader_coll__map" id="ripple_1_1DatabaseBody_1_1reader_coll__map">
<area shape="rect" title="Algorithm for storing buffers when parsing." alt="" coords="1715,74,1877,115"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1393,5,1495,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1393,56,1495,83"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1397,107,1491,133"/>
<area shape="rect" href="classripple_1_1DatabaseBody_1_1value__type.html" title=" " alt="" coords="1363,158,1525,199"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="1037,17,1208,44"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1071,89,1174,116"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="1077,140,1169,167"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="1079,191,1166,217"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1025,242,1220,283"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="1037,307,1208,349"/>
<area shape="rect" href="classripple_1_1DatabaseCon.html" title=" " alt="" coords="800,315,955,341"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="485,249,656,290"/>
<area shape="rect" href="classripple_1_1Checkpointer.html" title=" " alt="" coords="261,256,415,283"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="5,249,212,290"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title="STL class." alt="" coords="491,315,650,341"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="491,366,651,407"/>
</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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a81d2c5b2cd575bf14ab66b9f305a39da"><td class="memTemplParams" colspan="2">template&lt;bool isRequest, class Fields &gt; </td></tr>
<tr class="memitem:a81d2c5b2cd575bf14ab66b9f305a39da"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#a81d2c5b2cd575bf14ab66b9f305a39da">reader</a> (boost::beast::http::header&lt; isRequest, Fields &gt; &amp;h, <a class="el" href="classripple_1_1DatabaseBody_1_1value__type.html">value_type</a> &amp;b)</td></tr>
<tr class="separator:a81d2c5b2cd575bf14ab66b9f305a39da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d32da3730b87f714f0b89f6a6251239"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#a2d32da3730b87f714f0b89f6a6251239">init</a> (boost::optional&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> &gt; const &amp;, boost::system::error_code &amp;ec)</td></tr>
<tr class="separator:a2d32da3730b87f714f0b89f6a6251239"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27a0312f8ad6c6d3ba2d58f01c5ce21a"><td class="memTemplParams" colspan="2">template&lt;class ConstBufferSequence &gt; </td></tr>
<tr class="memitem:a27a0312f8ad6c6d3ba2d58f01c5ce21a"><td class="memTemplItemLeft" 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="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#a27a0312f8ad6c6d3ba2d58f01c5ce21a">put</a> (ConstBufferSequence const &amp;buffers, boost::system::error_code &amp;ec)</td></tr>
<tr class="separator:a27a0312f8ad6c6d3ba2d58f01c5ce21a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6bee7a35d947532f797a7dd59c30c47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#ae6bee7a35d947532f797a7dd59c30c47">do_put</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;data)</td></tr>
<tr class="separator:ae6bee7a35d947532f797a7dd59c30c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a123757d492539dd5bce893b4306d1554"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#a123757d492539dd5bce893b4306d1554">finish</a> (boost::system::error_code &amp;ec)</td></tr>
<tr class="separator:a123757d492539dd5bce893b4306d1554"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ae49aa67900d561bcef3a42d6f6bdc1da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1DatabaseBody_1_1value__type.html">value_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#ae49aa67900d561bcef3a42d6f6bdc1da">body_</a></td></tr>
<tr class="separator:ae49aa67900d561bcef3a42d6f6bdc1da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a6201fe5baf0b8d62c9b77521e391257f"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#a6201fe5baf0b8d62c9b77521e391257f">FLUSH_SIZE</a> = 50000000</td></tr>
<tr class="separator:a6201fe5baf0b8d62c9b77521e391257f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26f00f9d0063c6885f34fca8329dba24"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#a26f00f9d0063c6885f34fca8329dba24">MAX_HANDLERS</a> = 3</td></tr>
<tr class="separator:a26f00f9d0063c6885f34fca8329dba24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2da1cd86d38a7334fbbe68736cedecc9"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DatabaseBody_1_1reader.html#a2da1cd86d38a7334fbbe68736cedecc9">MAX_ROW_SIZE_PAD</a> = 500</td></tr>
<tr class="separator:a2da1cd86d38a7334fbbe68736cedecc9"><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>Algorithm for storing buffers when parsing. </p>
<p>Objects of this type are created during parsing to store incoming buffers representing the body. </p>
<p class="definition">Definition at line <a class="el" href="DatabaseBody_8h_source.html#l00119">119</a> of file <a class="el" href="DatabaseBody_8h_source.html">DatabaseBody.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a81d2c5b2cd575bf14ab66b9f305a39da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81d2c5b2cd575bf14ab66b9f305a39da">&#9670;&nbsp;</a></span>reader()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;bool isRequest, class Fields &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::DatabaseBody::reader::reader </td>
<td>(</td>
<td class="paramtype">boost::beast::http::header&lt; isRequest, Fields &gt; &amp;&#160;</td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1DatabaseBody_1_1value__type.html">value_type</a> &amp;&#160;</td>
<td class="paramname"><em>b</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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2d32da3730b87f714f0b89f6a6251239"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d32da3730b87f714f0b89f6a6251239">&#9670;&nbsp;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::DatabaseBody::reader::init </td>
<td>(</td>
<td class="paramtype">boost::optional&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> &gt; const &amp;&#160;</td>
<td class="paramname">, </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>
</div><div class="memdoc">
</div>
</div>
<a id="a27a0312f8ad6c6d3ba2d58f01c5ce21a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27a0312f8ad6c6d3ba2d58f01c5ce21a">&#9670;&nbsp;</a></span>put()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ConstBufferSequence &gt; </div>
<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> ripple::DatabaseBody::reader::put </td>
<td>(</td>
<td class="paramtype">ConstBufferSequence const &amp;&#160;</td>
<td class="paramname"><em>buffers</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>
</div><div class="memdoc">
</div>
</div>
<a id="ae6bee7a35d947532f797a7dd59c30c47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6bee7a35d947532f797a7dd59c30c47">&#9670;&nbsp;</a></span>do_put()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::DatabaseBody::reader::do_put </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>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a123757d492539dd5bce893b4306d1554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a123757d492539dd5bce893b4306d1554">&#9670;&nbsp;</a></span>finish()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::DatabaseBody::reader::finish </td>
<td>(</td>
<td class="paramtype">boost::system::error_code &amp;&#160;</td>
<td class="paramname"><em>ec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae49aa67900d561bcef3a42d6f6bdc1da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae49aa67900d561bcef3a42d6f6bdc1da">&#9670;&nbsp;</a></span>body_</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_1DatabaseBody_1_1value__type.html">value_type</a>&amp; ripple::DatabaseBody::reader::body_</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="DatabaseBody_8h_source.html#l00121">121</a> of file <a class="el" href="DatabaseBody_8h_source.html">DatabaseBody.h</a>.</p>
</div>
</div>
<a id="a6201fe5baf0b8d62c9b77521e391257f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6201fe5baf0b8d62c9b77521e391257f">&#9670;&nbsp;</a></span>FLUSH_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::DatabaseBody::reader::FLUSH_SIZE = 50000000</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseBody_8h_source.html#l00123">123</a> of file <a class="el" href="DatabaseBody_8h_source.html">DatabaseBody.h</a>.</p>
</div>
</div>
<a id="a26f00f9d0063c6885f34fca8329dba24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26f00f9d0063c6885f34fca8329dba24">&#9670;&nbsp;</a></span>MAX_HANDLERS</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> ripple::DatabaseBody::reader::MAX_HANDLERS = 3</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseBody_8h_source.html#l00124">124</a> of file <a class="el" href="DatabaseBody_8h_source.html">DatabaseBody.h</a>.</p>
</div>
</div>
<a id="a2da1cd86d38a7334fbbe68736cedecc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2da1cd86d38a7334fbbe68736cedecc9">&#9670;&nbsp;</a></span>MAX_ROW_SIZE_PAD</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> ripple::DatabaseBody::reader::MAX_ROW_SIZE_PAD = 500</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseBody_8h_source.html#l00125">125</a> of file <a class="el" href="DatabaseBody_8h_source.html">DatabaseBody.h</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