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

312 lines
18 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: LockedPageManager 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('classLockedPageManager.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-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classLockedPageManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LockedPageManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="pagelocker_8h_source.html">pagelocker.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 LockedPageManager:</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="classLockedPageManager.png" usemap="#LockedPageManager_map" alt=""/>
<map id="LockedPageManager_map" name="LockedPageManager_map">
<area href="classLockedPageManagerBase.html" alt="LockedPageManagerBase&lt; MemoryPageLocker &gt;" shape="rect" coords="0,0,299,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac9b1d42d240dba4714a35fff970b6dde"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classLockedPageManager.html">LockedPageManager</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManager.html#ac9b1d42d240dba4714a35fff970b6dde">Instance</a> ()</td></tr>
<tr class="separator:ac9b1d42d240dba4714a35fff970b6dde"><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:a2314ed1fc7851a67384fbc2b3656b259"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManager.html#a2314ed1fc7851a67384fbc2b3656b259">LockedPageManager</a> ()</td></tr>
<tr class="separator:a2314ed1fc7851a67384fbc2b3656b259"><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-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:a3933ba60669b1c1b0ef03222637257e7"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManager.html#a3933ba60669b1c1b0ef03222637257e7">CreateInstance</a> ()</td></tr>
<tr class="separator:a3933ba60669b1c1b0ef03222637257e7"><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:a28548f50fe302a322444c1cfe2a83487"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classLockedPageManager.html">LockedPageManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManager.html#a28548f50fe302a322444c1cfe2a83487">_instance</a> = NULL</td></tr>
<tr class="separator:a28548f50fe302a322444c1cfe2a83487"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a081452980235d98b2269c34f094f300e"><td class="memItemLeft" align="right" valign="top">static boost::once_flag&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManager.html#a081452980235d98b2269c34f094f300e">init_flag</a> = BOOST_ONCE_INIT</td></tr>
<tr class="separator:a081452980235d98b2269c34f094f300e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_classLockedPageManagerBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classLockedPageManagerBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classLockedPageManagerBase.html">LockedPageManagerBase&lt; MemoryPageLocker &gt;</a></td></tr>
<tr class="memitem:ad1974eafb41a3cae3358e34b7896419a inherit pub_methods_classLockedPageManagerBase"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManagerBase.html#ad1974eafb41a3cae3358e34b7896419a">LockedPageManagerBase</a> (size_t <a class="el" href="classLockedPageManagerBase.html#af485e095ca992fa134d5a441accfbf21">page_size</a>)</td></tr>
<tr class="separator:ad1974eafb41a3cae3358e34b7896419a inherit pub_methods_classLockedPageManagerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af57e9c9ea40884e105b25415148ee1d6 inherit pub_methods_classLockedPageManagerBase"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManagerBase.html#af57e9c9ea40884e105b25415148ee1d6">~LockedPageManagerBase</a> ()</td></tr>
<tr class="separator:af57e9c9ea40884e105b25415148ee1d6 inherit pub_methods_classLockedPageManagerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae24ac08899505b892d451404133fa494 inherit pub_methods_classLockedPageManagerBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManagerBase.html#ae24ac08899505b892d451404133fa494">LockRange</a> (void *p, size_t size)</td></tr>
<tr class="separator:ae24ac08899505b892d451404133fa494 inherit pub_methods_classLockedPageManagerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34bcf7b9120295ed178fe9545ed229af inherit pub_methods_classLockedPageManagerBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManagerBase.html#a34bcf7b9120295ed178fe9545ed229af">UnlockRange</a> (void *p, size_t size)</td></tr>
<tr class="separator:a34bcf7b9120295ed178fe9545ed229af inherit pub_methods_classLockedPageManagerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8074f7d1b43cc8dd34b3ba9cdb2eca50 inherit pub_methods_classLockedPageManagerBase"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLockedPageManagerBase.html#a8074f7d1b43cc8dd34b3ba9cdb2eca50">GetLockedPageCount</a> ()</td></tr>
<tr class="separator:a8074f7d1b43cc8dd34b3ba9cdb2eca50 inherit pub_methods_classLockedPageManagerBase"><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>Singleton class to keep track of locked (ie, non-swappable) memory pages, for use in std::allocator templates.</p>
<p>Some implementations of the STL allocate memory in some constructors (i.e., see MSVC's vector&lt;T&gt; implementation where it allocates 1 byte of memory in the allocator.) Due to the unpredictable order of static initializers, we have to make sure the <a class="el" href="classLockedPageManager.html">LockedPageManager</a> instance exists before any other STL-based objects that use <a class="el" href="structsecure__allocator.html">secure_allocator</a> are created. So instead of having <a class="el" href="classLockedPageManager.html">LockedPageManager</a> also be static-initialized, it is created on demand. </p>
<p class="definition">Definition at line <a class="el" href="pagelocker_8h_source.html#l00133">133</a> of file <a class="el" href="pagelocker_8h_source.html">pagelocker.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2314ed1fc7851a67384fbc2b3656b259"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2314ed1fc7851a67384fbc2b3656b259">&#9670;&nbsp;</a></span>LockedPageManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LockedPageManager::LockedPageManager </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="pagelocker_8cpp_source.html#l00068">68</a> of file <a class="el" href="pagelocker_8cpp_source.html">pagelocker.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3933ba60669b1c1b0ef03222637257e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3933ba60669b1c1b0ef03222637257e7">&#9670;&nbsp;</a></span>CreateInstance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void LockedPageManager::CreateInstance </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">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pagelocker_8h_source.html#l00145">145</a> of file <a class="el" href="pagelocker_8h_source.html">pagelocker.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="pagelocker_8h_source.html#l00136">Instance()</a>.</p>
</div>
</div>
<a id="ac9b1d42d240dba4714a35fff970b6dde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9b1d42d240dba4714a35fff970b6dde">&#9670;&nbsp;</a></span>Instance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classLockedPageManager.html">LockedPageManager</a>&amp; LockedPageManager::Instance </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pagelocker_8h_source.html#l00136">136</a> of file <a class="el" href="pagelocker_8h_source.html">pagelocker.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="secure_8h_source.html#l00041">secure_allocator&lt; T &gt;::allocate()</a>, <a class="el" href="crypter_8h_source.html#l00090">CCrypter::CCrypter()</a>, <a class="el" href="secure_8h_source.html#l00050">secure_allocator&lt; T &gt;::deallocate()</a>, <a class="el" href="pagelocker_8h_source.html#l00165">LockObject()</a>, <a class="el" href="pagelocker_8h_source.html#l00171">UnlockObject()</a>, and <a class="el" href="crypter_8h_source.html#l00101">CCrypter::~CCrypter()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a28548f50fe302a322444c1cfe2a83487"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28548f50fe302a322444c1cfe2a83487">&#9670;&nbsp;</a></span>_instance</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="classLockedPageManager.html">LockedPageManager</a> * LockedPageManager::_instance = NULL</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pagelocker_8h_source.html#l00156">156</a> of file <a class="el" href="pagelocker_8h_source.html">pagelocker.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="pagelocker_8h_source.html#l00145">CreateInstance()</a>, and <a class="el" href="pagelocker_8h_source.html#l00136">Instance()</a>.</p>
</div>
</div>
<a id="a081452980235d98b2269c34f094f300e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a081452980235d98b2269c34f094f300e">&#9670;&nbsp;</a></span>init_flag</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::once_flag LockedPageManager::init_flag = BOOST_ONCE_INIT</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pagelocker_8h_source.html#l00157">157</a> of file <a class="el" href="pagelocker_8h_source.html">pagelocker.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="pagelocker_8h_source.html#l00136">Instance()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/support/<a class="el" href="pagelocker_8h_source.html">pagelocker.h</a></li>
<li>src/support/<a class="el" href="pagelocker_8cpp_source.html">pagelocker.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="classLockedPageManager.html">LockedPageManager</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:13 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>