dash-docs/en/doxygen/html/classCDBBatch.html

333 lines
15 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: CDBBatch 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classCDBBatch.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classCDBBatch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CDBBatch Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a>&gt;</code></p>
<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:ab08bb79a9e37e04d05dbcff6f335bbc9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDBBatch.html#ab08bb79a9e37e04d05dbcff6f335bbc9">CDBBatch</a> (const std::vector&lt; unsigned char &gt; *<a class="el" href="classCDBBatch.html#a0e4545536cb12048b179538986d5e463">obfuscate_key</a>)</td></tr>
<tr class="separator:ab08bb79a9e37e04d05dbcff6f335bbc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91b5d889a8d7e56c4f0bbf446e246111"><td class="memTemplParams" colspan="2">template&lt;typename K , typename V &gt; </td></tr>
<tr class="memitem:a91b5d889a8d7e56c4f0bbf446e246111"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCDBBatch.html#a91b5d889a8d7e56c4f0bbf446e246111">Write</a> (const K &amp;key, const V &amp;value)</td></tr>
<tr class="separator:a91b5d889a8d7e56c4f0bbf446e246111"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b9ed3a5fa7fb461cd668c5a5c7ccd42"><td class="memTemplParams" colspan="2">template&lt;typename K &gt; </td></tr>
<tr class="memitem:a0b9ed3a5fa7fb461cd668c5a5c7ccd42"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCDBBatch.html#a0b9ed3a5fa7fb461cd668c5a5c7ccd42">Erase</a> (const K &amp;key)</td></tr>
<tr class="separator:a0b9ed3a5fa7fb461cd668c5a5c7ccd42"><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:ace784336d18faed5e938a6e97ad14e9b"><td class="memItemLeft" align="right" valign="top">leveldb::WriteBatch&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDBBatch.html#ace784336d18faed5e938a6e97ad14e9b">batch</a></td></tr>
<tr class="separator:ace784336d18faed5e938a6e97ad14e9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e4545536cb12048b179538986d5e463"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; unsigned char &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDBBatch.html#a0e4545536cb12048b179538986d5e463">obfuscate_key</a></td></tr>
<tr class="separator:a0e4545536cb12048b179538986d5e463"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a2d327eccbb43e94ccd92f0ae70db14dd"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDBBatch.html#a2d327eccbb43e94ccd92f0ae70db14dd">CDBWrapper</a></td></tr>
<tr class="separator:a2d327eccbb43e94ccd92f0ae70db14dd"><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 of changes queued to be written to a <a class="el" href="classCDBWrapper.html">CDBWrapper</a> </p>
<p class="definition">Definition at line <a class="el" href="dbwrapper_8h_source.html#l00029">29</a> of file <a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab08bb79a9e37e04d05dbcff6f335bbc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab08bb79a9e37e04d05dbcff6f335bbc9">&#9670;&nbsp;</a></span>CDBBatch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CDBBatch::CDBBatch </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; unsigned char &gt; *&#160;</td>
<td class="paramname"><em>obfuscate_key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obfuscate_key</td><td>If passed, XOR data with this key. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="dbwrapper_8h_source.html#l00041">41</a> of file <a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0b9ed3a5fa7fb461cd668c5a5c7ccd42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b9ed3a5fa7fb461cd668c5a5c7ccd42">&#9670;&nbsp;</a></span>Erase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CDBBatch::Erase </td>
<td>(</td>
<td class="paramtype">const K &amp;&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbwrapper_8h_source.html#l00061">61</a> of file <a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbwrapper_8h_source.html#l00236">CDBWrapper::Erase()</a>, <a class="el" href="txdb_8cpp_source.html#l00231">CBlockTreeDB::EraseAddressIndex()</a>, <a class="el" href="txdb_8cpp_source.html#l00186">CBlockTreeDB::UpdateAddressUnspentIndex()</a>, and <a class="el" href="txdb_8cpp_source.html#l00174">CBlockTreeDB::UpdateSpentIndex()</a>.</p>
</div>
</div>
<a id="a91b5d889a8d7e56c4f0bbf446e246111"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91b5d889a8d7e56c4f0bbf446e246111">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K , typename V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CDBBatch::Write </td>
<td>(</td>
<td class="paramtype">const K &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const V &amp;&#160;</td>
<td class="paramname"><em>value</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbwrapper_8h_source.html#l00044">44</a> of file <a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="txdb_8cpp_source.html#l00186">CBlockTreeDB::UpdateAddressUnspentIndex()</a>, <a class="el" href="txdb_8cpp_source.html#l00174">CBlockTreeDB::UpdateSpentIndex()</a>, <a class="el" href="dbwrapper_8h_source.html#l00209">CDBWrapper::Write()</a>, <a class="el" href="txdb_8cpp_source.html#l00224">CBlockTreeDB::WriteAddressIndex()</a>, <a class="el" href="txdb_8cpp_source.html#l00147">CBlockTreeDB::WriteBatchSync()</a>, <a class="el" href="txdb_8cpp_source.html#l00272">CBlockTreeDB::WriteTimestampIndex()</a>, and <a class="el" href="txdb_8cpp_source.html#l00163">CBlockTreeDB::WriteTxIndex()</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a2d327eccbb43e94ccd92f0ae70db14dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d327eccbb43e94ccd92f0ae70db14dd">&#9670;&nbsp;</a></span>CDBWrapper</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classCDBWrapper.html">CDBWrapper</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="dbwrapper_8h_source.html#l00031">31</a> of file <a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ace784336d18faed5e938a6e97ad14e9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace784336d18faed5e938a6e97ad14e9b">&#9670;&nbsp;</a></span>batch</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">leveldb::WriteBatch CDBBatch::batch</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="dbwrapper_8h_source.html#l00034">34</a> of file <a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbwrapper_8h_source.html#l00061">Erase()</a>, and <a class="el" href="dbwrapper_8h_source.html#l00044">Write()</a>.</p>
</div>
</div>
<a id="a0e4545536cb12048b179538986d5e463"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e4545536cb12048b179538986d5e463">&#9670;&nbsp;</a></span>obfuscate_key</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt;unsigned char&gt;* CDBBatch::obfuscate_key</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="dbwrapper_8h_source.html#l00035">35</a> of file <a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbwrapper_8h_source.html#l00044">Write()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="dbwrapper_8h_source.html">dbwrapper.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classCDBBatch.html">CDBBatch</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:12 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>