This commit is contained in:
bthomee
2025-08-19 09:49:50 -07:00
parent bb5efdeec8
commit e7f4ae8bed
14888 changed files with 259444 additions and 168566 deletions

View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: SociDB.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,7 +29,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -46,6 +46,11 @@ $(function() {
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -114,14 +119,17 @@ $(function() {
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>&gt;</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a>&gt;</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="foldopen" id="foldopen00047" data-start="{" data-end="}">
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="namespacesqlite__api.html"> 47</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacesqlite__api.html">sqlite_api</a> {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword">struct </span>sqlite3;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>}</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">class </span>BasicConfig;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="foldopen" id="foldopen00060" data-start="{" data-end="};">
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classripple_1_1DBConfig.html"> 60</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1DBConfig.html">DBConfig</a></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>{</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classripple_1_1DBConfig.html#a2cfa66b7cdca2c584a46a4ffc9936fab"> 62</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code hl_variable" href="classripple_1_1DBConfig.html#a2cfa66b7cdca2c584a46a4ffc9936fab">connectionString_</a>;</div>
@@ -134,6 +142,7 @@ $(function() {
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_enumvalue" href="namespaceripple.html#a77adb10ef53a2e25195ccd38b46bfe9ba7cef8a734855777c2a9d0caf42666e69">open</a>(soci::session&amp; s) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>};</div>
</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><a class="code hl_enumvalue" href="namespaceripple.html#a77adb10ef53a2e25195ccd38b46bfe9ba7cef8a734855777c2a9d0caf42666e69">open</a>(soci::session&amp; s, <a class="code hl_class" href="classripple_1_1BasicConfig.html">BasicConfig</a> <span class="keyword">const</span>&amp; config, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; dbName);</div>
@@ -158,6 +167,7 @@ $(function() {
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><a class="code hl_function" href="namespaceripple.html#a60e89f0668645858d48dfd3f67b1a639">convert</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; from, soci::blob&amp; to);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="foldopen" id="foldopen00117" data-start="{" data-end="};">
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="classripple_1_1Checkpointer.html"> 117</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1Checkpointer.html">Checkpointer</a> : <span class="keyword">public</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html">std::enable_shared_from_this</a>&lt;Checkpointer&gt;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>{</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="keyword">public</span>:</div>
@@ -171,6 +181,7 @@ $(function() {
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"><a class="line" href="classripple_1_1Checkpointer.html#abf74aac56ba440b454e166fc2b6fa2b1"> 128</a></span> <a class="code hl_function" href="classripple_1_1Checkpointer.html#abf74aac56ba440b454e166fc2b6fa2b1">checkpoint</a>() = 0;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span>};</div>
</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Checkpointer&gt;</a></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><a class="code hl_function" href="namespaceripple.html#ad2d44b45d5ba8217592f9e6c021f9de6">makeCheckpointer</a>(</div>
@@ -187,27 +198,27 @@ $(function() {
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
<div class="ttc" id="aclassripple_1_1BasicConfig_html"><div class="ttname"><a href="classripple_1_1BasicConfig.html">ripple::BasicConfig</a></div><div class="ttdoc">Holds unparsed configuration information.</div><div class="ttdef"><b>Definition:</b> <a href="BasicConfig_8h_source.html#l00217">BasicConfig.h:218</a></div></div>
<div class="ttc" id="aclassripple_1_1Checkpointer_html"><div class="ttname"><a href="classripple_1_1Checkpointer.html">ripple::Checkpointer</a></div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8h_source.html#l00117">SociDB.h:118</a></div></div>
<div class="ttc" id="aclassripple_1_1BasicConfig_html"><div class="ttname"><a href="classripple_1_1BasicConfig.html">ripple::BasicConfig</a></div><div class="ttdoc">Holds unparsed configuration information.</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8h_source.html#l00217">BasicConfig.h:218</a></div></div>
<div class="ttc" id="aclassripple_1_1Checkpointer_html"><div class="ttname"><a href="classripple_1_1Checkpointer.html">ripple::Checkpointer</a></div><div class="ttdef"><b>Definition</b> <a href="SociDB_8h_source.html#l00117">SociDB.h:118</a></div></div>
<div class="ttc" id="aclassripple_1_1Checkpointer_html_ab8c932260edaa5bf115d7b009ecbf8f8"><div class="ttname"><a href="classripple_1_1Checkpointer.html#ab8c932260edaa5bf115d7b009ecbf8f8">ripple::Checkpointer::~Checkpointer</a></div><div class="ttdeci">virtual ~Checkpointer()=default</div></div>
<div class="ttc" id="aclassripple_1_1Checkpointer_html_ab9829ee8efc00bb2ec7df2671a3c2bb9"><div class="ttname"><a href="classripple_1_1Checkpointer.html#ab9829ee8efc00bb2ec7df2671a3c2bb9">ripple::Checkpointer::id</a></div><div class="ttdeci">virtual std::uintptr_t id() const =0</div></div>
<div class="ttc" id="aclassripple_1_1Checkpointer_html_abf74aac56ba440b454e166fc2b6fa2b1"><div class="ttname"><a href="classripple_1_1Checkpointer.html#abf74aac56ba440b454e166fc2b6fa2b1">ripple::Checkpointer::checkpoint</a></div><div class="ttdeci">virtual void checkpoint()=0</div></div>
<div class="ttc" id="aclassripple_1_1Checkpointer_html_ac79d028cdf7b9b29451942566f0192bd"><div class="ttname"><a href="classripple_1_1Checkpointer.html#ac79d028cdf7b9b29451942566f0192bd">ripple::Checkpointer::schedule</a></div><div class="ttdeci">virtual void schedule()=0</div></div>
<div class="ttc" id="aclassripple_1_1DBConfig_html"><div class="ttname"><a href="classripple_1_1DBConfig.html">ripple::DBConfig</a></div><div class="ttdoc">DBConfig is used when a client wants to delay opening a soci::session after parsing the config parame...</div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8h_source.html#l00060">SociDB.h:61</a></div></div>
<div class="ttc" id="aclassripple_1_1DBConfig_html_a2cfa66b7cdca2c584a46a4ffc9936fab"><div class="ttname"><a href="classripple_1_1DBConfig.html#a2cfa66b7cdca2c584a46a4ffc9936fab">ripple::DBConfig::connectionString_</a></div><div class="ttdeci">std::string connectionString_</div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8h_source.html#l00062">SociDB.h:62</a></div></div>
<div class="ttc" id="aclassripple_1_1DBConfig_html_aed2ed3f2db1359839b19308edf21f625"><div class="ttname"><a href="classripple_1_1DBConfig.html#aed2ed3f2db1359839b19308edf21f625">ripple::DBConfig::connectionString</a></div><div class="ttdeci">std::string connectionString() const</div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8cpp_source.html#l00089">SociDB.cpp:89</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#l00057">JobQueue.h:58</a></div></div>
<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#l00051">Log.h:52</a></div></div>
<div class="ttc" id="aclassripple_1_1DBConfig_html"><div class="ttname"><a href="classripple_1_1DBConfig.html">ripple::DBConfig</a></div><div class="ttdoc">DBConfig is used when a client wants to delay opening a soci::session after parsing the config parame...</div><div class="ttdef"><b>Definition</b> <a href="SociDB_8h_source.html#l00060">SociDB.h:61</a></div></div>
<div class="ttc" id="aclassripple_1_1DBConfig_html_a2cfa66b7cdca2c584a46a4ffc9936fab"><div class="ttname"><a href="classripple_1_1DBConfig.html#a2cfa66b7cdca2c584a46a4ffc9936fab">ripple::DBConfig::connectionString_</a></div><div class="ttdeci">std::string connectionString_</div><div class="ttdef"><b>Definition</b> <a href="SociDB_8h_source.html#l00062">SociDB.h:62</a></div></div>
<div class="ttc" id="aclassripple_1_1DBConfig_html_aed2ed3f2db1359839b19308edf21f625"><div class="ttname"><a href="classripple_1_1DBConfig.html#aed2ed3f2db1359839b19308edf21f625">ripple::DBConfig::connectionString</a></div><div class="ttdeci">std::string connectionString() const</div><div class="ttdef"><b>Definition</b> <a href="SociDB_8cpp_source.html#l00089">SociDB.cpp:89</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#l00057">JobQueue.h:58</a></div></div>
<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#l00051">Log.h:52</a></div></div>
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
<div class="ttc" id="aenable_shared_from_this_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html">std::enable_shared_from_this</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</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="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_a3063535903fec75ab36b634cb531c835"><div class="ttname"><a href="namespaceripple.html#a3063535903fec75ab36b634cb531c835">ripple::getKBUsedAll</a></div><div class="ttdeci">std::uint32_t getKBUsedAll(soci::session &amp;s)</div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8cpp_source.html#l00133">SociDB.cpp:133</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5b44737567b195859f7664079bb61e1a"><div class="ttname"><a href="namespaceripple.html#a5b44737567b195859f7664079bb61e1a">ripple::getKBUsedDB</a></div><div class="ttdeci">std::uint32_t getKBUsedDB(soci::session &amp;s)</div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8cpp_source.html#l00142">SociDB.cpp:142</a></div></div>
<div class="ttc" id="anamespaceripple_html_a60e89f0668645858d48dfd3f67b1a639"><div class="ttname"><a href="namespaceripple.html#a60e89f0668645858d48dfd3f67b1a639">ripple::convert</a></div><div class="ttdeci">void convert(soci::blob &amp;from, std::vector&lt; std::uint8_t &gt; &amp;to)</div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8cpp_source.html#l00157">SociDB.cpp:157</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="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_a3063535903fec75ab36b634cb531c835"><div class="ttname"><a href="namespaceripple.html#a3063535903fec75ab36b634cb531c835">ripple::getKBUsedAll</a></div><div class="ttdeci">std::uint32_t getKBUsedAll(soci::session &amp;s)</div><div class="ttdef"><b>Definition</b> <a href="SociDB_8cpp_source.html#l00133">SociDB.cpp:133</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5b44737567b195859f7664079bb61e1a"><div class="ttname"><a href="namespaceripple.html#a5b44737567b195859f7664079bb61e1a">ripple::getKBUsedDB</a></div><div class="ttdeci">std::uint32_t getKBUsedDB(soci::session &amp;s)</div><div class="ttdef"><b>Definition</b> <a href="SociDB_8cpp_source.html#l00142">SociDB.cpp:142</a></div></div>
<div class="ttc" id="anamespaceripple_html_a60e89f0668645858d48dfd3f67b1a639"><div class="ttname"><a href="namespaceripple.html#a60e89f0668645858d48dfd3f67b1a639">ripple::convert</a></div><div class="ttdeci">void convert(soci::blob &amp;from, std::vector&lt; std::uint8_t &gt; &amp;to)</div><div class="ttdef"><b>Definition</b> <a href="SociDB_8cpp_source.html#l00157">SociDB.cpp:157</a></div></div>
<div class="ttc" id="anamespaceripple_html_a77adb10ef53a2e25195ccd38b46bfe9ba7cef8a734855777c2a9d0caf42666e69"><div class="ttname"><a href="namespaceripple.html#a77adb10ef53a2e25195ccd38b46bfe9ba7cef8a734855777c2a9d0caf42666e69">ripple::ConsensusPhase::open</a></div><div class="ttdeci">@ open</div><div class="ttdoc">We haven't closed our ledger yet, but others might have.</div></div>
<div class="ttc" id="anamespaceripple_html_ad2d44b45d5ba8217592f9e6c021f9de6"><div class="ttname"><a href="namespaceripple.html#ad2d44b45d5ba8217592f9e6c021f9de6">ripple::makeCheckpointer</a></div><div class="ttdeci">std::shared_ptr&lt; Checkpointer &gt; makeCheckpointer(std::uintptr_t id, std::weak_ptr&lt; soci::session &gt; session, JobQueue &amp;queue, Logs &amp;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#l00336">SociDB.cpp:336</a></div></div>
<div class="ttc" id="anamespacesqlite__api_html"><div class="ttname"><a href="namespacesqlite__api.html">sqlite_api</a></div><div class="ttdef"><b>Definition:</b> <a href="SociDB_8h_source.html#l00047">SociDB.h:47</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad2d44b45d5ba8217592f9e6c021f9de6"><div class="ttname"><a href="namespaceripple.html#ad2d44b45d5ba8217592f9e6c021f9de6">ripple::makeCheckpointer</a></div><div class="ttdeci">std::shared_ptr&lt; Checkpointer &gt; makeCheckpointer(std::uintptr_t id, std::weak_ptr&lt; soci::session &gt; session, JobQueue &amp;queue, Logs &amp;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#l00336">SociDB.cpp:336</a></div></div>
<div class="ttc" id="anamespacesqlite__api_html"><div class="ttname"><a href="namespacesqlite__api.html">sqlite_api</a></div><div class="ttdef"><b>Definition</b> <a href="SociDB_8h_source.html#l00047">SociDB.h:47</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="astring_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/string.html">string</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a></div></div>
@@ -215,7 +226,7 @@ $(function() {
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>