joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dash-docs/en/doxygen/html/classCCoinsView.html

373 lines
20 KiB
HTML
Raw Blame History

<!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: CCoinsView 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('classCCoinsView.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="classCCoinsView-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CCoinsView Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="coins_8h_source.html">coins.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for CCoinsView:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classCCoinsView.png" usemap="#CCoinsView_map" alt=""/>
<map id="CCoinsView_map" name="CCoinsView_map">
<area href="classCCoinsViewBacked.html" alt="CCoinsViewBacked" shape="rect" coords="166,56,322,80"/>
<area href="classCCoinsViewDB.html" alt="CCoinsViewDB" shape="rect" coords="332,56,488,80"/>
<area href="classCCoinsViewCache.html" alt="CCoinsViewCache" shape="rect" coords="0,112,156,136"/>
<area href="classCCoinsViewErrorCatcher.html" alt="CCoinsViewErrorCatcher" shape="rect" coords="166,112,322,136"/>
<area href="classCCoinsViewMemPool.html" alt="CCoinsViewMemPool" shape="rect" coords="332,112,488,136"/>
</map>
</div></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:a67d865358127bef1f0011a23d5158a9f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCoinsView.html#a67d865358127bef1f0011a23d5158a9f">GetCoins</a> (const <a class="el" href="classuint256.html">uint256</a> &amp;txid, <a class="el" href="classCCoins.html">CCoins</a> &amp;coins) const</td></tr>
<tr class="memdesc:a67d865358127bef1f0011a23d5158a9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the <a class="el" href="classCCoins.html">CCoins</a> (unspent transaction outputs) for a given txid. <a href="#a67d865358127bef1f0011a23d5158a9f">More...</a><br /></td></tr>
<tr class="separator:a67d865358127bef1f0011a23d5158a9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade3a65fc3f1b02baf7bebce630e4eba3"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCoinsView.html#ade3a65fc3f1b02baf7bebce630e4eba3">HaveCoins</a> (const <a class="el" href="classuint256.html">uint256</a> &amp;txid) const</td></tr>
<tr class="separator:ade3a65fc3f1b02baf7bebce630e4eba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af81f2907d360a2548d59a61388e5e5cb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classuint256.html">uint256</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCoinsView.html#af81f2907d360a2548d59a61388e5e5cb">GetBestBlock</a> () const</td></tr>
<tr class="memdesc:af81f2907d360a2548d59a61388e5e5cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the block hash whose state this <a class="el" href="classCCoinsView.html">CCoinsView</a> currently represents. <a href="#af81f2907d360a2548d59a61388e5e5cb">More...</a><br /></td></tr>
<tr class="separator:af81f2907d360a2548d59a61388e5e5cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7dc37396ca4fac7014cea06fec7178e"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCoinsView.html#ad7dc37396ca4fac7014cea06fec7178e">BatchWrite</a> (<a class="el" href="coins_8h.html#a2886ba2fd0428bae777e1cbcabc02834">CCoinsMap</a> &amp;mapCoins, const <a class="el" href="classuint256.html">uint256</a> &amp;hashBlock)</td></tr>
<tr class="separator:ad7dc37396ca4fac7014cea06fec7178e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbd7f73ba071c6e441dd88d95b8f2c0d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCoinsView.html#adbd7f73ba071c6e441dd88d95b8f2c0d">GetStats</a> (<a class="el" href="structCCoinsStats.html">CCoinsStats</a> &amp;stats) const</td></tr>
<tr class="memdesc:adbd7f73ba071c6e441dd88d95b8f2c0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate statistics about the unspent transaction output set. <a href="#adbd7f73ba071c6e441dd88d95b8f2c0d">More...</a><br /></td></tr>
<tr class="separator:adbd7f73ba071c6e441dd88d95b8f2c0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ffb4218bf991ddff47339e44c8710da"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCoinsView.html#a7ffb4218bf991ddff47339e44c8710da">~CCoinsView</a> ()</td></tr>
<tr class="memdesc:a7ffb4218bf991ddff47339e44c8710da"><td class="mdescLeft">&#160;</td><td class="mdescRight">As we use CCoinsViews polymorphically, have a virtual destructor. <a href="#a7ffb4218bf991ddff47339e44c8710da">More...</a><br /></td></tr>
<tr class="separator:a7ffb4218bf991ddff47339e44c8710da"><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>Abstract view on the open txout dataset. </p>
<p class="definition">Definition at line <a class="el" href="coins_8h_source.html#l00315">315</a> of file <a class="el" href="coins_8h_source.html">coins.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7ffb4218bf991ddff47339e44c8710da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ffb4218bf991ddff47339e44c8710da">&#9670;&nbsp;</a></span>~CCoinsView()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual CCoinsView::~CCoinsView </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>As we use CCoinsViews polymorphically, have a virtual destructor. </p>
<p class="definition">Definition at line <a class="el" href="coins_8h_source.html#l00336">336</a> of file <a class="el" href="coins_8h_source.html">coins.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad7dc37396ca4fac7014cea06fec7178e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7dc37396ca4fac7014cea06fec7178e">&#9670;&nbsp;</a></span>BatchWrite()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CCoinsView::BatchWrite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="coins_8h.html#a2886ba2fd0428bae777e1cbcabc02834">CCoinsMap</a> &amp;&#160;</td>
<td class="paramname"><em>mapCoins</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classuint256.html">uint256</a> &amp;&#160;</td>
<td class="paramname"><em>hashBlock</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Do a bulk modification (multiple <a class="el" href="classCCoins.html">CCoins</a> changes + BestBlock change). The passed mapCoins can be modified. </p>
<p>Reimplemented in <a class="el" href="classCCoinsViewCache.html#a561bb7c6c97701b12c48fbbb563d0a91">CCoinsViewCache</a>, <a class="el" href="classCCoinsViewBacked.html#ace15da3934c9d7a9cb9c7a787f92f764">CCoinsViewBacked</a>, and <a class="el" href="classCCoinsViewDB.html#a33f98ec9323ce48e1704327bc8a2a002">CCoinsViewDB</a>.</p>
<p class="definition">Definition at line <a class="el" href="coins_8cpp_source.html#l00047">47</a> of file <a class="el" href="coins_8cpp_source.html">coins.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="coins_8cpp_source.html#l00056">CCoinsViewBacked::BatchWrite()</a>, and <a class="el" href="coins_8cpp_source.html#l00207">CCoinsViewCache::Flush()</a>.</p>
</div>
</div>
<a id="af81f2907d360a2548d59a61388e5e5cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af81f2907d360a2548d59a61388e5e5cb">&#9670;&nbsp;</a></span>GetBestBlock()</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="classuint256.html">uint256</a> CCoinsView::GetBestBlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the block hash whose state this <a class="el" href="classCCoinsView.html">CCoinsView</a> currently represents. </p>
<p>Reimplemented in <a class="el" href="classCCoinsViewCache.html#a1190c94a943c067d13211179ef06470b">CCoinsViewCache</a>, <a class="el" href="classCCoinsViewBacked.html#a39bca41ae922d0ce7f40e8aeab289280">CCoinsViewBacked</a>, and <a class="el" href="classCCoinsViewDB.html#ac9c513a34b9e58d942fdbeafd9e5bbce">CCoinsViewDB</a>.</p>
<p class="definition">Definition at line <a class="el" href="coins_8cpp_source.html#l00046">46</a> of file <a class="el" href="coins_8cpp_source.html">coins.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="coins_8cpp_source.html#l00054">CCoinsViewBacked::GetBestBlock()</a>, and <a class="el" href="coins_8cpp_source.html#l00152">CCoinsViewCache::GetBestBlock()</a>.</p>
</div>
</div>
<a id="a67d865358127bef1f0011a23d5158a9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67d865358127bef1f0011a23d5158a9f">&#9670;&nbsp;</a></span>GetCoins()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CCoinsView::GetCoins </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classuint256.html">uint256</a> &amp;&#160;</td>
<td class="paramname"><em>txid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCCoins.html">CCoins</a> &amp;&#160;</td>
<td class="paramname"><em>coins</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the <a class="el" href="classCCoins.html">CCoins</a> (unspent transaction outputs) for a given txid. </p>
<p>Reimplemented in <a class="el" href="classCCoinsViewMemPool.html#a1a4a556821b1680ff4b73758c8a1e471">CCoinsViewMemPool</a>, <a class="el" href="classCCoinsViewCache.html#a1b62444593fdb580bfa4bd6fab41fafa">CCoinsViewCache</a>, <a class="el" href="classCCoinsViewBacked.html#a456f9e85817556329a959c120998df5b">CCoinsViewBacked</a>, <a class="el" href="classCCoinsViewErrorCatcher.html#a909f7b9e364b6f06bfea955209aa015d">CCoinsViewErrorCatcher</a>, and <a class="el" href="classCCoinsViewDB.html#ac35a80d1115ec697101d382e71db5b31">CCoinsViewDB</a>.</p>
<p class="definition">Definition at line <a class="el" href="coins_8cpp_source.html#l00044">44</a> of file <a class="el" href="coins_8cpp_source.html">coins.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="coins_8cpp_source.html#l00072">CCoinsViewCache::FetchCoins()</a>, <a class="el" href="coins_8cpp_source.html#l00052">CCoinsViewBacked::GetCoins()</a>, <a class="el" href="txmempool_8cpp_source.html#l00984">CCoinsViewMemPool::GetCoins()</a>, and <a class="el" href="coins_8cpp_source.html#l00099">CCoinsViewCache::ModifyCoins()</a>.</p>
</div>
</div>
<a id="adbd7f73ba071c6e441dd88d95b8f2c0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbd7f73ba071c6e441dd88d95b8f2c0d">&#9670;&nbsp;</a></span>GetStats()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CCoinsView::GetStats </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structCCoinsStats.html">CCoinsStats</a> &amp;&#160;</td>
<td class="paramname"><em>stats</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate statistics about the unspent transaction output set. </p>
<p>Reimplemented in <a class="el" href="classCCoinsViewBacked.html#aa787da5760afa843d32764b70420b2d6">CCoinsViewBacked</a>, and <a class="el" href="classCCoinsViewDB.html#a227bf56f8801921f12e56c6839104fce">CCoinsViewDB</a>.</p>
<p class="definition">Definition at line <a class="el" href="coins_8cpp_source.html#l00048">48</a> of file <a class="el" href="coins_8cpp_source.html">coins.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="coins_8cpp_source.html#l00057">CCoinsViewBacked::GetStats()</a>.</p>
</div>
</div>
<a id="ade3a65fc3f1b02baf7bebce630e4eba3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade3a65fc3f1b02baf7bebce630e4eba3">&#9670;&nbsp;</a></span>HaveCoins()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CCoinsView::HaveCoins </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classuint256.html">uint256</a> &amp;&#160;</td>
<td class="paramname"><em>txid</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Just check whether we have data for a given txid. This may (but cannot always) return true for fully spent transactions </p>
<p>Reimplemented in <a class="el" href="classCCoinsViewMemPool.html#a2c5900448dc5570053060686ad1f014b">CCoinsViewMemPool</a>, <a class="el" href="classCCoinsViewCache.html#aa8f0c55b6fc207d2188948a565125ab7">CCoinsViewCache</a>, <a class="el" href="classCCoinsViewBacked.html#ad49041658bdec807d556e080476e6543">CCoinsViewBacked</a>, and <a class="el" href="classCCoinsViewDB.html#af55f35faadeb74b5406559fe3ed20114">CCoinsViewDB</a>.</p>
<p class="definition">Definition at line <a class="el" href="coins_8cpp_source.html#l00045">45</a> of file <a class="el" href="coins_8cpp_source.html">coins.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="coins_8cpp_source.html#l00053">CCoinsViewBacked::HaveCoins()</a>, and <a class="el" href="txmempool_8cpp_source.html#l00996">CCoinsViewMemPool::HaveCoins()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="coins_8h_source.html">coins.h</a></li>
<li>src/<a class="el" href="coins_8cpp_source.html">coins.cpp</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="classCCoinsView.html">CCoinsView</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>
Reference in a new issue View git blame Copy permalink