mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
149 lines
18 KiB
HTML
149 lines
18 KiB
HTML
<!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: DatabaseCon.cpp Source File</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&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&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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_d7c39fc6a58949d9b8efa0ea0aabeed8.html">core</a></li><li class="navelem"><a class="el" href="dir_46cfd23d8d12b129f8fcd173d5f01b52.html">impl</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">DatabaseCon.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <ripple/core/DatabaseCon.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <ripple/core/SociDB.h></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <ripple/basics/contract.h></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/basics/Log.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="namespaceripple.html#a129731ebc636b1fda10c420163892260"> 28</a></span> <a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html">DatabaseCon::Setup</a> <a class="code" href="namespaceripple.html#a129731ebc636b1fda10c420163892260">setup_DatabaseCon</a> (<a class="code" href="classripple_1_1Config.html">Config</a> <span class="keyword">const</span>& c)</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html">DatabaseCon::Setup</a> setup;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  setup.<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html#aa0a5722c0cae142b105e970a77594b6c">startUp</a> = c.<a class="code" href="classripple_1_1Config.html#afcaabfcf92819db93bab0540ce159d89">START_UP</a>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  setup.<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html#ac8430db645f0c35a70b27a794c8c73ab">standAlone</a> = c.<a class="code" href="classripple_1_1Config.html#a55cd8ef67ffbf6a137e0dd71bc8151c6">standalone</a>();</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  setup.<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html#a0af8b51b7fba3f82bc144cad8d83cb64">dataDir</a> = c.<a class="code" href="classripple_1_1BasicConfig.html#ae2c21d011e6424d4917db175ef9df301">legacy</a> (<span class="stringliteral">"database_path"</span>);</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">if</span> (!setup.<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html#ac8430db645f0c35a70b27a794c8c73ab">standAlone</a> && setup.<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html#a0af8b51b7fba3f82bc144cad8d83cb64">dataDir</a>.empty())</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  Throw<std::runtime_error>(</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="stringliteral">"database_path must be set."</span>);</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  }</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">return</span> setup;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classripple_1_1DatabaseCon.html#a041741f7c254fa37958c92c087a20718"> 44</a></span> <span class="keywordtype">void</span> <a class="code" href="classripple_1_1DatabaseCon.html#a041741f7c254fa37958c92c087a20718">DatabaseCon::setupCheckpointing</a> (<a class="code" href="classripple_1_1JobQueue.html">JobQueue</a>* q, <a class="code" href="classripple_1_1Logs.html">Logs</a>& l)</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span> (! q)</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  Throw<std::logic_error> (<span class="stringliteral">"No JobQueue"</span>);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classripple_1_1DatabaseCon.html#a525ff8b626d6717999cb28a091624978">checkpointer_</a> = <a class="code" href="namespaceripple.html#acf4bc1f754b3ec1bdb66f7b5fb20253f">makeCheckpointer</a> (<a class="code" href="classripple_1_1DatabaseCon.html#a70795c77da7df71d71717e7f25e6328e">session_</a>, *q, l);</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> }</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> } <span class="comment">// ripple</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1Logs_html"><div class="ttname"><a href="classripple_1_1Logs.html">ripple::Logs</a></div><div class="ttdoc">Manages partitions for logging.</div><div class="ttdef"><b>Definition:</b> <a href="Log_8h_source.html#l00049">Log.h:49</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1DatabaseCon_1_1Setup_html"><div class="ttname"><a href="structripple_1_1DatabaseCon_1_1Setup.html">ripple::DatabaseCon::Setup</a></div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8h_source.html#l00080">DatabaseCon.h:80</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1DatabaseCon_1_1Setup_html_aa0a5722c0cae142b105e970a77594b6c"><div class="ttname"><a href="structripple_1_1DatabaseCon_1_1Setup.html#aa0a5722c0cae142b105e970a77594b6c">ripple::DatabaseCon::Setup::startUp</a></div><div class="ttdeci">Config::StartUpType startUp</div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8h_source.html#l00084">DatabaseCon.h:84</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1DatabaseCon_1_1Setup_html_a0af8b51b7fba3f82bc144cad8d83cb64"><div class="ttname"><a href="structripple_1_1DatabaseCon_1_1Setup.html#a0af8b51b7fba3f82bc144cad8d83cb64">ripple::DatabaseCon::Setup::dataDir</a></div><div class="ttdeci">boost::filesystem::path dataDir</div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8h_source.html#l00086">DatabaseCon.h:86</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1DatabaseCon_html_a041741f7c254fa37958c92c087a20718"><div class="ttname"><a href="classripple_1_1DatabaseCon.html#a041741f7c254fa37958c92c087a20718">ripple::DatabaseCon::setupCheckpointing</a></div><div class="ttdeci">void setupCheckpointing(JobQueue *, Logs &)</div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8cpp_source.html#l00044">DatabaseCon.cpp:44</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a129731ebc636b1fda10c420163892260"><div class="ttname"><a href="namespaceripple.html#a129731ebc636b1fda10c420163892260">ripple::setup_DatabaseCon</a></div><div class="ttdeci">DatabaseCon::Setup setup_DatabaseCon(Config const &c)</div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8cpp_source.html#l00028">DatabaseCon.cpp:28</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1DatabaseCon_1_1Setup_html_ac8430db645f0c35a70b27a794c8c73ab"><div class="ttname"><a href="structripple_1_1DatabaseCon_1_1Setup.html#ac8430db645f0c35a70b27a794c8c73ab">ripple::DatabaseCon::Setup::standAlone</a></div><div class="ttdeci">bool standAlone</div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8h_source.html#l00085">DatabaseCon.h:85</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Config_html"><div class="ttname"><a href="classripple_1_1Config.html">ripple::Config</a></div><div class="ttdef"><b>Definition:</b> <a href="Config_8h_source.html#l00067">Config.h:67</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_acf4bc1f754b3ec1bdb66f7b5fb20253f"><div class="ttname"><a href="namespaceripple.html#acf4bc1f754b3ec1bdb66f7b5fb20253f">ripple::makeCheckpointer</a></div><div class="ttdeci">std::unique_ptr< Checkpointer > makeCheckpointer(soci::session &session, JobQueue &queue, Logs &logs)</div><div class="ttdoc">Returns a new checkpointer which makes checkpoints of a soci database every checkpointPageCount pages...</div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8cpp_source.html#l00269">SociDB.cpp:269</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1DatabaseCon_html_a70795c77da7df71d71717e7f25e6328e"><div class="ttname"><a href="classripple_1_1DatabaseCon.html#a70795c77da7df71d71717e7f25e6328e">ripple::DatabaseCon::session_</a></div><div class="ttdeci">soci::session session_</div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8h_source.html#l00154">DatabaseCon.h:154</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Config_html_a55cd8ef67ffbf6a137e0dd71bc8151c6"><div class="ttname"><a href="classripple_1_1Config.html#a55cd8ef67ffbf6a137e0dd71bc8151c6">ripple::Config::standalone</a></div><div class="ttdeci">bool standalone() const</div><div class="ttdef"><b>Definition:</b> <a href="Config_8h_source.html#l00204">Config.h:204</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1BasicConfig_html_ae2c21d011e6424d4917db175ef9df301"><div class="ttname"><a href="classripple_1_1BasicConfig.html#ae2c21d011e6424d4917db175ef9df301">ripple::BasicConfig::legacy</a></div><div class="ttdeci">void legacy(std::string const &section, std::string value)</div><div class="ttdoc">Set a value that is not a key/value pair.</div><div class="ttdef"><b>Definition:</b> <a href="BasicConfig_8cpp_source.html#l00173">BasicConfig.cpp:173</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Config_html_afcaabfcf92819db93bab0540ce159d89"><div class="ttname"><a href="classripple_1_1Config.html#afcaabfcf92819db93bab0540ce159d89">ripple::Config::START_UP</a></div><div class="ttdeci">StartUpType START_UP</div><div class="ttdef"><b>Definition:</b> <a href="Config_8h_source.html#l00128">Config.h:128</a></div></div>
|
|
<div class="ttc" id="amemory_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1JobQueue_html"><div class="ttname"><a href="classripple_1_1JobQueue.html">ripple::JobQueue</a></div><div class="ttdoc">A pool of threads to perform work.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00056">JobQueue.h:56</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1DatabaseCon_html_a525ff8b626d6717999cb28a091624978"><div class="ttname"><a href="classripple_1_1DatabaseCon.html#a525ff8b626d6717999cb28a091624978">ripple::DatabaseCon::checkpointer_</a></div><div class="ttdeci">std::unique_ptr< Checkpointer > checkpointer_</div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8h_source.html#l00155">DatabaseCon.h:155</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|