ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-26 14:05:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/classripple_1_1NodeStore_1_1BatchWriter.html
nbougalis ee2b4c457d deploy: 5c8e072b7f
2020-12-05 06:17:37 +00:00

589 lines
32 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::NodeStore::BatchWriter 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="namespaceripple_1_1NodeStore.html">NodeStore</a></li><li class="navelem"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html">BatchWriter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1NodeStore_1_1BatchWriter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::NodeStore::BatchWriter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Batch-writing assist logic.
<a href="classripple_1_1NodeStore_1_1BatchWriter.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for ripple::NodeStore::BatchWriter:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1NodeStore_1_1BatchWriter__inherit__graph.png" border="0" usemap="#ripple_1_1NodeStore_1_1BatchWriter_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1NodeStore_1_1BatchWriter_inherit__map" id="ripple_1_1NodeStore_1_1BatchWriter_inherit__map">
<area shape="rect" title="Batch&#45;writing assist logic." alt="" coords="20,80,163,121"/>
<area shape="rect" href="structripple_1_1NodeStore_1_1Task.html" title="Derived classes perform scheduled tasks." alt="" coords="5,5,177,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::NodeStore::BatchWriter:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1NodeStore_1_1BatchWriter__coll__graph.png" border="0" usemap="#ripple_1_1NodeStore_1_1BatchWriter_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1NodeStore_1_1BatchWriter_coll__map" id="ripple_1_1NodeStore_1_1BatchWriter_coll__map">
<area shape="rect" title="Batch&#45;writing assist logic." alt="" coords="1679,189,1821,231"/>
<area shape="rect" href="structripple_1_1NodeStore_1_1Task.html" title="Derived classes perform scheduled tasks." alt="" coords="1331,50,1503,77"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1327,101,1506,143"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="977,109,1203,135"/>
<area shape="rect" href="classripple_1_1NodeObject.html" title="A simple object that the Ledger uses to store entries." alt="" coords="764,109,907,135"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="503,5,665,47"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="513,71,655,112"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,27,389,68"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,34,108,61"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,115,349,142"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title="STL class." alt="" coords="519,199,649,226"/>
<area shape="rect" title=" " alt="" coords="286,199,325,226"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title="STL class." alt="" coords="1337,167,1496,194"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1Scheduler.html" title="Scheduling for asynchronous backend activity." alt="" coords="1345,219,1488,260"/>
<area shape="rect" href="structripple_1_1NodeStore_1_1BatchWriter_1_1Callback.html" title="This callback does the actual writing." alt="" coords="1335,284,1498,325"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/condition_variable_any.html" title=" " alt="" coords="1316,350,1517,377"/>
</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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1BatchWriter_1_1Callback.html">Callback</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This callback does the actual writing. <a href="structripple_1_1NodeStore_1_1BatchWriter_1_1Callback.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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:ad2bd82080d5ae1a6f10eac76d6ef7874"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#ad2bd82080d5ae1a6f10eac76d6ef7874">BatchWriter</a> (<a class="el" href="structripple_1_1NodeStore_1_1BatchWriter_1_1Callback.html">Callback</a> &amp;callback, <a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html">Scheduler</a> &amp;scheduler)</td></tr>
<tr class="memdesc:ad2bd82080d5ae1a6f10eac76d6ef7874"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a batch writer. <a href="classripple_1_1NodeStore_1_1BatchWriter.html#ad2bd82080d5ae1a6f10eac76d6ef7874">More...</a><br /></td></tr>
<tr class="separator:ad2bd82080d5ae1a6f10eac76d6ef7874"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af79bad700133763e550a4750fcae40d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#af79bad700133763e550a4750fcae40d7">~BatchWriter</a> ()</td></tr>
<tr class="memdesc:af79bad700133763e550a4750fcae40d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a batch writer. <a href="classripple_1_1NodeStore_1_1BatchWriter.html#af79bad700133763e550a4750fcae40d7">More...</a><br /></td></tr>
<tr class="separator:af79bad700133763e550a4750fcae40d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42b3434b00f66603124653fbf691ad26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a42b3434b00f66603124653fbf691ad26">store</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_1NodeObject.html">NodeObject</a> &gt; const &amp;object)</td></tr>
<tr class="memdesc:a42b3434b00f66603124653fbf691ad26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store the object. <a href="classripple_1_1NodeStore_1_1BatchWriter.html#a42b3434b00f66603124653fbf691ad26">More...</a><br /></td></tr>
<tr class="separator:a42b3434b00f66603124653fbf691ad26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51dceb04c1517ed641e90a51c5a9ea1b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a51dceb04c1517ed641e90a51c5a9ea1b">getWriteLoad</a> ()</td></tr>
<tr class="memdesc:a51dceb04c1517ed641e90a51c5a9ea1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an estimate of the amount of writing I/O pending. <a href="classripple_1_1NodeStore_1_1BatchWriter.html#a51dceb04c1517ed641e90a51c5a9ea1b">More...</a><br /></td></tr>
<tr class="separator:a51dceb04c1517ed641e90a51c5a9ea1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:ab7e7a35ffac7d201823bf05170752d23"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#ab7e7a35ffac7d201823bf05170752d23">LockType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a></td></tr>
<tr class="separator:ab7e7a35ffac7d201823bf05170752d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbda8c921848433242d2e44470e835fc"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#adbda8c921848433242d2e44470e835fc">CondvarType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable_any.html">std::condition_variable_any</a></td></tr>
<tr class="separator:adbda8c921848433242d2e44470e835fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:aafd94fab31d667c79c53ae2f5b770778"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#aafd94fab31d667c79c53ae2f5b770778">performScheduledTask</a> () override</td></tr>
<tr class="memdesc:aafd94fab31d667c79c53ae2f5b770778"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs the task. <a href="classripple_1_1NodeStore_1_1BatchWriter.html#aafd94fab31d667c79c53ae2f5b770778">More...</a><br /></td></tr>
<tr class="separator:aafd94fab31d667c79c53ae2f5b770778"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9098b71490f289b477b5365d98cafee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#ac9098b71490f289b477b5365d98cafee">writeBatch</a> ()</td></tr>
<tr class="separator:ac9098b71490f289b477b5365d98cafee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fe23bec6b7c7fd4a4ca7c954241930c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a3fe23bec6b7c7fd4a4ca7c954241930c">waitForWriting</a> ()</td></tr>
<tr class="separator:a3fe23bec6b7c7fd4a4ca7c954241930c"><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:a3e9fcc020d96a6a061bc6d00cb8c4eb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1NodeStore_1_1BatchWriter_1_1Callback.html">Callback</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a3e9fcc020d96a6a061bc6d00cb8c4eb4">m_callback</a></td></tr>
<tr class="separator:a3e9fcc020d96a6a061bc6d00cb8c4eb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45c6abdc7dcdc3cdb4a8c1e3bfac8cd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a45c6abdc7dcdc3cdb4a8c1e3bfac8cd8">m_scheduler</a></td></tr>
<tr class="separator:a45c6abdc7dcdc3cdb4a8c1e3bfac8cd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8446bde66ae915ce1e8a23c1d9e03932"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#ab7e7a35ffac7d201823bf05170752d23">LockType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a8446bde66ae915ce1e8a23c1d9e03932">mWriteMutex</a></td></tr>
<tr class="separator:a8446bde66ae915ce1e8a23c1d9e03932"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae99b6e34ec47a86bcdc8de5a5a49eff4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#adbda8c921848433242d2e44470e835fc">CondvarType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#ae99b6e34ec47a86bcdc8de5a5a49eff4">mWriteCondition</a></td></tr>
<tr class="separator:ae99b6e34ec47a86bcdc8de5a5a49eff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90833868dbf5ca5fcb5840d8ead21f3a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a90833868dbf5ca5fcb5840d8ead21f3a">mWriteLoad</a></td></tr>
<tr class="separator:a90833868dbf5ca5fcb5840d8ead21f3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dac1815fb23e64b1d0a63d4595a816f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a0dac1815fb23e64b1d0a63d4595a816f">mWritePending</a></td></tr>
<tr class="separator:a0dac1815fb23e64b1d0a63d4595a816f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3764d56b2e80ee3345a2427f06192abb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1NodeStore.html#ae0e4b79f8eb3ffa0bf8fcaf848643202">Batch</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#a3764d56b2e80ee3345a2427f06192abb">mWriteSet</a></td></tr>
<tr class="separator:a3764d56b2e80ee3345a2427f06192abb"><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>Batch-writing assist logic. </p>
<p>The batch writes are performed with a scheduled task. Use of the class it not required. A backend can implement its own write batching, or skip write batching if doing so yields a performance benefit.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html" title="Scheduling for asynchronous backend activity.">Scheduler</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="BatchWriter_8h_source.html#l00040">40</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab7e7a35ffac7d201823bf05170752d23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7e7a35ffac7d201823bf05170752d23">&#9670;&nbsp;</a></span>LockType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#ab7e7a35ffac7d201823bf05170752d23">ripple::NodeStore::BatchWriter::LockType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a></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="BatchWriter_8h_source.html#l00086">86</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div>
</div>
<a id="adbda8c921848433242d2e44470e835fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbda8c921848433242d2e44470e835fc">&#9670;&nbsp;</a></span>CondvarType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#adbda8c921848433242d2e44470e835fc">ripple::NodeStore::BatchWriter::CondvarType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable_any.html">std::condition_variable_any</a></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="BatchWriter_8h_source.html#l00087">87</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad2bd82080d5ae1a6f10eac76d6ef7874"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2bd82080d5ae1a6f10eac76d6ef7874">&#9670;&nbsp;</a></span>BatchWriter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::NodeStore::BatchWriter::BatchWriter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1NodeStore_1_1BatchWriter_1_1Callback.html">Callback</a> &amp;&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td>
<td class="paramname"><em>scheduler</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a batch writer. </p>
<p class="definition">Definition at line <a class="el" href="BatchWriter_8cpp_source.html#l00025">25</a> of file <a class="el" href="BatchWriter_8cpp_source.html">BatchWriter.cpp</a>.</p>
</div>
</div>
<a id="af79bad700133763e550a4750fcae40d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af79bad700133763e550a4750fcae40d7">&#9670;&nbsp;</a></span>~BatchWriter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::NodeStore::BatchWriter::~BatchWriter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a batch writer. </p>
<p>Anything pending in the batch is written out before this returns. </p>
<p class="definition">Definition at line <a class="el" href="BatchWriter_8cpp_source.html#l00034">34</a> of file <a class="el" href="BatchWriter_8cpp_source.html">BatchWriter.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a42b3434b00f66603124653fbf691ad26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42b3434b00f66603124653fbf691ad26">&#9670;&nbsp;</a></span>store()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::NodeStore::BatchWriter::store </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_1NodeObject.html">NodeObject</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Store the object. </p>
<p>This will add to the batch and initiate a scheduled task to write the batch out. </p>
<p class="definition">Definition at line <a class="el" href="BatchWriter_8cpp_source.html#l00040">40</a> of file <a class="el" href="BatchWriter_8cpp_source.html">BatchWriter.cpp</a>.</p>
</div>
</div>
<a id="a51dceb04c1517ed641e90a51c5a9ea1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51dceb04c1517ed641e90a51c5a9ea1b">&#9670;&nbsp;</a></span>getWriteLoad()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ripple::NodeStore::BatchWriter::getWriteLoad </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an estimate of the amount of writing I/O pending. </p>
<p class="definition">Definition at line <a class="el" href="BatchWriter_8cpp_source.html#l00060">60</a> of file <a class="el" href="BatchWriter_8cpp_source.html">BatchWriter.cpp</a>.</p>
</div>
</div>
<a id="aafd94fab31d667c79c53ae2f5b770778"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafd94fab31d667c79c53ae2f5b770778">&#9670;&nbsp;</a></span>performScheduledTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::NodeStore::BatchWriter::performScheduledTask </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">private</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs the task. </p>
<p>The call may take place on a foreign thread. </p>
<p>Implements <a class="el" href="structripple_1_1NodeStore_1_1Task.html#a1ed44e570fe3bd98407aae13a554ec2b">ripple::NodeStore::Task</a>.</p>
<p class="definition">Definition at line <a class="el" href="BatchWriter_8cpp_source.html#l00068">68</a> of file <a class="el" href="BatchWriter_8cpp_source.html">BatchWriter.cpp</a>.</p>
</div>
</div>
<a id="ac9098b71490f289b477b5365d98cafee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9098b71490f289b477b5365d98cafee">&#9670;&nbsp;</a></span>writeBatch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::NodeStore::BatchWriter::writeBatch </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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="BatchWriter_8cpp_source.html#l00074">74</a> of file <a class="el" href="BatchWriter_8cpp_source.html">BatchWriter.cpp</a>.</p>
</div>
</div>
<a id="a3fe23bec6b7c7fd4a4ca7c954241930c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fe23bec6b7c7fd4a4ca7c954241930c">&#9670;&nbsp;</a></span>waitForWriting()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::NodeStore::BatchWriter::waitForWriting </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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="BatchWriter_8cpp_source.html#l00113">113</a> of file <a class="el" href="BatchWriter_8cpp_source.html">BatchWriter.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a3e9fcc020d96a6a061bc6d00cb8c4eb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e9fcc020d96a6a061bc6d00cb8c4eb4">&#9670;&nbsp;</a></span>m_callback</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="structripple_1_1NodeStore_1_1BatchWriter_1_1Callback.html">Callback</a>&amp; ripple::NodeStore::BatchWriter::m_callback</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="BatchWriter_8h_source.html#l00089">89</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div>
</div>
<a id="a45c6abdc7dcdc3cdb4a8c1e3bfac8cd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45c6abdc7dcdc3cdb4a8c1e3bfac8cd8">&#9670;&nbsp;</a></span>m_scheduler</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_1NodeStore_1_1Scheduler.html">Scheduler</a>&amp; ripple::NodeStore::BatchWriter::m_scheduler</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="BatchWriter_8h_source.html#l00090">90</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div>
</div>
<a id="a8446bde66ae915ce1e8a23c1d9e03932"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8446bde66ae915ce1e8a23c1d9e03932">&#9670;&nbsp;</a></span>mWriteMutex</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_1NodeStore_1_1BatchWriter.html#ab7e7a35ffac7d201823bf05170752d23">LockType</a> ripple::NodeStore::BatchWriter::mWriteMutex</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="BatchWriter_8h_source.html#l00091">91</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div>
</div>
<a id="ae99b6e34ec47a86bcdc8de5a5a49eff4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae99b6e34ec47a86bcdc8de5a5a49eff4">&#9670;&nbsp;</a></span>mWriteCondition</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_1NodeStore_1_1BatchWriter.html#adbda8c921848433242d2e44470e835fc">CondvarType</a> ripple::NodeStore::BatchWriter::mWriteCondition</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="BatchWriter_8h_source.html#l00092">92</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div>
</div>
<a id="a90833868dbf5ca5fcb5840d8ead21f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90833868dbf5ca5fcb5840d8ead21f3a">&#9670;&nbsp;</a></span>mWriteLoad</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ripple::NodeStore::BatchWriter::mWriteLoad</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="BatchWriter_8h_source.html#l00093">93</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div>
</div>
<a id="a0dac1815fb23e64b1d0a63d4595a816f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dac1815fb23e64b1d0a63d4595a816f">&#9670;&nbsp;</a></span>mWritePending</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::NodeStore::BatchWriter::mWritePending</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="BatchWriter_8h_source.html#l00094">94</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.h</a>.</p>
</div>
</div>
<a id="a3764d56b2e80ee3345a2427f06192abb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3764d56b2e80ee3345a2427f06192abb">&#9670;&nbsp;</a></span>mWriteSet</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="namespaceripple_1_1NodeStore.html#ae0e4b79f8eb3ffa0bf8fcaf848643202">Batch</a> ripple::NodeStore::BatchWriter::mWriteSet</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="BatchWriter_8h_source.html#l00095">95</a> of file <a class="el" href="BatchWriter_8h_source.html">BatchWriter.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