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

382 lines
20 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: CBaseChainParams 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('classCBaseChainParams.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="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classCBaseChainParams-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CBaseChainParams Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.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 CBaseChainParams:</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="classCBaseChainParams.png" usemap="#CBaseChainParams_map" alt=""/>
<map id="CBaseChainParams_map" name="CBaseChainParams_map">
<area href="classCBaseMainParams.html" alt="CBaseMainParams" shape="rect" coords="0,56,136,80"/>
<area href="classCBaseRegTestParams.html" alt="CBaseRegTestParams" shape="rect" coords="146,56,282,80"/>
<area href="classCBaseTestNetParams.html" alt="CBaseTestNetParams" shape="rect" coords="292,56,428,80"/>
</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:a4b142e94ae27f860522dd5efef41fb67"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBaseChainParams.html#a4b142e94ae27f860522dd5efef41fb67">DataDir</a> () const</td></tr>
<tr class="separator:a4b142e94ae27f860522dd5efef41fb67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a790801bda78d70db56da89ca43934a63"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBaseChainParams.html#a790801bda78d70db56da89ca43934a63">RPCPort</a> () const</td></tr>
<tr class="separator:a790801bda78d70db56da89ca43934a63"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ae2c5dfdbbff4d5f92948258a7b4db47b"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBaseChainParams.html#ae2c5dfdbbff4d5f92948258a7b4db47b">MAIN</a> = &quot;main&quot;</td></tr>
<tr class="separator:ae2c5dfdbbff4d5f92948258a7b4db47b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d2f894965570dc74f1329c9953167c4"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBaseChainParams.html#a9d2f894965570dc74f1329c9953167c4">TESTNET</a> = &quot;test&quot;</td></tr>
<tr class="separator:a9d2f894965570dc74f1329c9953167c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49cecf92f25361a49999a88cc92c1809"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBaseChainParams.html#a49cecf92f25361a49999a88cc92c1809">REGTEST</a> = &quot;regtest&quot;</td></tr>
<tr class="separator:a49cecf92f25361a49999a88cc92c1809"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a4c0e84608b2fa636be3a3683653d9533"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBaseChainParams.html#a4c0e84608b2fa636be3a3683653d9533">CBaseChainParams</a> ()</td></tr>
<tr class="separator:a4c0e84608b2fa636be3a3683653d9533"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae020d8f669175bcac3ab44f9c095c977"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBaseChainParams.html#ae020d8f669175bcac3ab44f9c095c977">nRPCPort</a></td></tr>
<tr class="separator:ae020d8f669175bcac3ab44f9c095c977"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5868778f8c6c676aabc9fb2366d2447"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBaseChainParams.html#af5868778f8c6c676aabc9fb2366d2447">strDataDir</a></td></tr>
<tr class="separator:af5868778f8c6c676aabc9fb2366d2447"><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><a class="el" href="classCBaseChainParams.html">CBaseChainParams</a> defines the base parameters (shared between dash-cli and dashd) of a given instance of the Dash system. </p>
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00015">15</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4c0e84608b2fa636be3a3683653d9533"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c0e84608b2fa636be3a3683653d9533">&#9670;&nbsp;</a></span>CBaseChainParams()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CBaseChainParams::CBaseChainParams </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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00027">27</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4b142e94ae27f860522dd5efef41fb67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b142e94ae27f860522dd5efef41fb67">&#9670;&nbsp;</a></span>DataDir()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; CBaseChainParams::DataDir </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00023">23</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="util_8cpp_source.html#l00547">GetDataDir()</a>.</p>
</div>
</div>
<a id="a790801bda78d70db56da89ca43934a63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a790801bda78d70db56da89ca43934a63">&#9670;&nbsp;</a></span>RPCPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int CBaseChainParams::RPCPort </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00024">24</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae2c5dfdbbff4d5f92948258a7b4db47b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2c5dfdbbff4d5f92948258a7b4db47b">&#9670;&nbsp;</a></span>MAIN</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string CBaseChainParams::MAIN = &quot;main&quot;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>BIP70 chain name strings (main, test or regtest) </p>
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00019">19</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="chainparamsbase_8cpp_source.html#l00076">BaseParams()</a>, <a class="el" href="chainparamsbase_8cpp_source.html#l00093">ChainNameFromCommandLine()</a>, <a class="el" href="validation_8cpp_source.html#l03232">ContextualCheckBlockHeader()</a>, <a class="el" href="masternode_8cpp_source.html#l00359">CMasternodeBroadcast::Create()</a>, <a class="el" href="bitcoinunits_8cpp_source.html#l00069">BitcoinUnits::description()</a>, <a class="el" href="masternodeman_8cpp_source.html#l00399">CMasternodeMan::DsegUpdate()</a>, <a class="el" href="validation_8cpp_source.html#l01230">GetBlockSubsidy()</a>, <a class="el" href="pow_8cpp_source.html#l00172">GetNextWorkRequired()</a>, <a class="el" href="init_8cpp_source.html#l00384">HelpMessage()</a>, <a class="el" href="dash-cli_8cpp_source.html#l00030">HelpMessageCli()</a>, <a class="el" href="paymentserver_8cpp_source.html#l00205">PaymentServer::ipcParseCommandLine()</a>, <a class="el" href="activemasternode_8cpp_source.html#l00141">CActiveMasternode::ManageStateInitial()</a>, <a class="el" href="bitcoinunits_8cpp_source.html#l00043">BitcoinUnits::name()</a>, <a class="el" href="chainparams_8cpp_source.html#l00429">Params()</a>, <a class="el" href="masternodeman_8cpp_source.html#l00771">CMasternodeMan::ProcessMessage()</a>, <a class="el" href="masternodeconfig_8cpp_source.html#l00017">CMasternodeConfig::read()</a>, <a class="el" href="governance_8cpp_source.html#l01143">CGovernanceManager::RequestGovernanceObjectVotes()</a>, and <a class="el" href="masternode_8cpp_source.html#l00430">CMasternodeBroadcast::SimpleCheck()</a>.</p>
</div>
</div>
<a id="ae020d8f669175bcac3ab44f9c095c977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae020d8f669175bcac3ab44f9c095c977">&#9670;&nbsp;</a></span>nRPCPort</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int CBaseChainParams::nRPCPort</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00029">29</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="chainparamsbase_8cpp_source.html#l00033">CBaseMainParams::CBaseMainParams()</a>, <a class="el" href="chainparamsbase_8cpp_source.html#l00060">CBaseRegTestParams::CBaseRegTestParams()</a>, <a class="el" href="chainparamsbase_8cpp_source.html#l00046">CBaseTestNetParams::CBaseTestNetParams()</a>, and <a class="el" href="chainparamsbase_8h_source.html#l00024">RPCPort()</a>.</p>
</div>
</div>
<a id="a49cecf92f25361a49999a88cc92c1809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49cecf92f25361a49999a88cc92c1809">&#9670;&nbsp;</a></span>REGTEST</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string CBaseChainParams::REGTEST = &quot;regtest&quot;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00021">21</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="chainparamsbase_8cpp_source.html#l00076">BaseParams()</a>, <a class="el" href="chainparamsbase_8cpp_source.html#l00093">ChainNameFromCommandLine()</a>, <a class="el" href="pow_8cpp_source.html#l00172">GetNextWorkRequired()</a>, <a class="el" href="masternode_8cpp_source.html#l00278">CMasternode::IsValidNetAddr()</a>, <a class="el" href="activemasternode_8cpp_source.html#l00016">CActiveMasternode::ManageState()</a>, <a class="el" href="chainparams_8cpp_source.html#l00429">Params()</a>, <a class="el" href="masternodeman_8cpp_source.html#l00728">CMasternodeMan::ProcessMasternodeConnections()</a>, and <a class="el" href="masternode-sync_8cpp_source.html#l00152">CMasternodeSync::ProcessTick()</a>.</p>
</div>
</div>
<a id="af5868778f8c6c676aabc9fb2366d2447"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5868778f8c6c676aabc9fb2366d2447">&#9670;&nbsp;</a></span>strDataDir</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string CBaseChainParams::strDataDir</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00030">30</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="chainparamsbase_8cpp_source.html#l00060">CBaseRegTestParams::CBaseRegTestParams()</a>, <a class="el" href="chainparamsbase_8cpp_source.html#l00046">CBaseTestNetParams::CBaseTestNetParams()</a>, and <a class="el" href="chainparamsbase_8h_source.html#l00023">DataDir()</a>.</p>
</div>
</div>
<a id="a9d2f894965570dc74f1329c9953167c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d2f894965570dc74f1329c9953167c4">&#9670;&nbsp;</a></span>TESTNET</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string CBaseChainParams::TESTNET = &quot;test&quot;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="chainparamsbase_8h_source.html#l00020">20</a> of file <a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="chainparamsbase_8cpp_source.html#l00076">BaseParams()</a>, <a class="el" href="chainparamsbase_8cpp_source.html#l00093">ChainNameFromCommandLine()</a>, <a class="el" href="init_8cpp_source.html#l00384">HelpMessage()</a>, <a class="el" href="dash-cli_8cpp_source.html#l00030">HelpMessageCli()</a>, <a class="el" href="paymentserver_8cpp_source.html#l00205">PaymentServer::ipcParseCommandLine()</a>, and <a class="el" href="chainparams_8cpp_source.html#l00429">Params()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a></li>
<li>src/<a class="el" href="chainparamsbase_8cpp_source.html">chainparamsbase.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="classCBaseChainParams.html">CBaseChainParams</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:11 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>