ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-28 06:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1DBConfig.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

257 lines
14 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::DBConfig 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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1DBConfig.html">DBConfig</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1DBConfig-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::DBConfig Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classripple_1_1DBConfig.html" title="DBConfig is used when a client wants to delay opening a soci::session after parsing the config parame...">DBConfig</a> is used when a client wants to delay opening a soci::session after parsing the config parameters.
<a href="classripple_1_1DBConfig.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SociDB_8h_source.html">SociDB.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::DBConfig:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1DBConfig__coll__graph.png" border="0" usemap="#aripple_1_1DBConfig_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1DBConfig_coll__map" id="aripple_1_1DBConfig_coll__map">
<area shape="rect" title="DBConfig is used when a client wants to delay opening a soci::session after parsing the config parame..." alt="" coords="11,183,138,208"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="31,95,118,120"/>
<area shape="poly" title=" " alt="" coords="77,134,77,182,72,182,72,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="5,5,144,45"/>
<area shape="poly" title=" " alt="" coords="77,59,77,94,72,94,72,59"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1f5fc79c99b7423a2bb3debca76fcb3a" id="r_a1f5fc79c99b7423a2bb3debca76fcb3a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DBConfig.html#a1f5fc79c99b7423a2bb3debca76fcb3a">DBConfig</a> (<a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a> const &amp;config, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;dbName)</td></tr>
<tr class="separator:a1f5fc79c99b7423a2bb3debca76fcb3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed2ed3f2db1359839b19308edf21f625" id="r_aed2ed3f2db1359839b19308edf21f625"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DBConfig.html#aed2ed3f2db1359839b19308edf21f625">connectionString</a> () const</td></tr>
<tr class="separator:aed2ed3f2db1359839b19308edf21f625"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8776b912e0e9f2b61a2d28ce10c6695" id="r_ad8776b912e0e9f2b61a2d28ce10c6695"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DBConfig.html#ad8776b912e0e9f2b61a2d28ce10c6695">open</a> (soci::session &amp;s) const</td></tr>
<tr class="separator:ad8776b912e0e9f2b61a2d28ce10c6695"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a6076a52e29d46143d573841049c5eaeb" id="r_a6076a52e29d46143d573841049c5eaeb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DBConfig.html#a6076a52e29d46143d573841049c5eaeb">DBConfig</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;dbPath)</td></tr>
<tr class="separator:a6076a52e29d46143d573841049c5eaeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a2cfa66b7cdca2c584a46a4ffc9936fab" id="r_a2cfa66b7cdca2c584a46a4ffc9936fab"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DBConfig.html#a2cfa66b7cdca2c584a46a4ffc9936fab">connectionString_</a></td></tr>
<tr class="separator:a2cfa66b7cdca2c584a46a4ffc9936fab"><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="classripple_1_1DBConfig.html" title="DBConfig is used when a client wants to delay opening a soci::session after parsing the config parame...">DBConfig</a> is used when a client wants to delay opening a soci::session after parsing the config parameters. </p>
<p>If a client want to open a session immediately, use the free function "open" below. </p>
<p class="definition">Definition at line <a class="el" href="SociDB_8h_source.html#l00041">41</a> of file <a class="el" href="SociDB_8h_source.html">SociDB.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6076a52e29d46143d573841049c5eaeb" name="a6076a52e29d46143d573841049c5eaeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6076a52e29d46143d573841049c5eaeb">&#9670;&#160;</a></span>DBConfig() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::DBConfig::DBConfig </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>dbPath</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SociDB_8cpp_source.html#l00060">60</a> of file <a class="el" href="SociDB_8cpp_source.html">SociDB.cpp</a>.</p>
</div>
</div>
<a id="a1f5fc79c99b7423a2bb3debca76fcb3a" name="a1f5fc79c99b7423a2bb3debca76fcb3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f5fc79c99b7423a2bb3debca76fcb3a">&#9670;&#160;</a></span>DBConfig() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::DBConfig::DBConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a> const &amp;&#160;</td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>dbName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SociDB_8cpp_source.html#l00064">64</a> of file <a class="el" href="SociDB_8cpp_source.html">SociDB.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aed2ed3f2db1359839b19308edf21f625" name="aed2ed3f2db1359839b19308edf21f625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed2ed3f2db1359839b19308edf21f625">&#9670;&#160;</a></span>connectionString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::DBConfig::connectionString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SociDB_8cpp_source.html#l00070">70</a> of file <a class="el" href="SociDB_8cpp_source.html">SociDB.cpp</a>.</p>
</div>
</div>
<a id="ad8776b912e0e9f2b61a2d28ce10c6695" name="ad8776b912e0e9f2b61a2d28ce10c6695"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8776b912e0e9f2b61a2d28ce10c6695">&#9670;&#160;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::DBConfig::open </td>
<td>(</td>
<td class="paramtype">soci::session &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SociDB_8cpp_source.html#l00076">76</a> of file <a class="el" href="SociDB_8cpp_source.html">SociDB.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2cfa66b7cdca2c584a46a4ffc9936fab" name="a2cfa66b7cdca2c584a46a4ffc9936fab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cfa66b7cdca2c584a46a4ffc9936fab">&#9670;&#160;</a></span>connectionString_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::DBConfig::connectionString_</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="SociDB_8h_source.html#l00043">43</a> of file <a class="el" href="SociDB_8h_source.html">SociDB.h</a>.</p>
</div>
</div>
</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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink