mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-24 04:55:52 +00:00
501 lines
28 KiB
HTML
501 lines
28 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: ripple::BasicConfig 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 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classripple_1_1BasicConfig-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ripple::BasicConfig Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Holds unparsed configuration information.
|
|
<a href="classripple_1_1BasicConfig.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::BasicConfig:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1BasicConfig__inherit__graph.png" border="0" usemap="#ripple_1_1BasicConfig_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="ripple_1_1BasicConfig_inherit__map" id="ripple_1_1BasicConfig_inherit__map">
|
|
<area shape="rect" title="Holds unparsed configuration information." alt="" coords="5,5,148,32"/>
|
|
<area shape="rect" href="classripple_1_1Config.html" title=" " alt="" coords="23,80,131,107"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::BasicConfig:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1BasicConfig__coll__graph.png" border="0" usemap="#ripple_1_1BasicConfig_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="ripple_1_1BasicConfig_coll__map" id="ripple_1_1BasicConfig_coll__map">
|
|
<area shape="rect" title="Holds unparsed configuration information." alt="" coords="15,436,158,463"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="5,317,168,373"/>
|
|
<area shape="rect" href="classripple_1_1Section.html" title="Holds a collection of configuration values." alt="" coords="108,228,223,255"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="200,109,363,151"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="105,5,191,32"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="387,117,573,143"/>
|
|
</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 name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a09b31b8ed3c769b4c23b040c3d4798ed"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a09b31b8ed3c769b4c23b040c3d4798ed">exists</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &name) const</td></tr>
|
|
<tr class="memdesc:a09b31b8ed3c769b4c23b040c3d4798ed"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if a section with the given name exists. <a href="classripple_1_1BasicConfig.html#a09b31b8ed3c769b4c23b040c3d4798ed">More...</a><br /></td></tr>
|
|
<tr class="separator:a09b31b8ed3c769b4c23b040c3d4798ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9bc9bfdd56fde61573aae73511504c9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#ac9bc9bfdd56fde61573aae73511504c9">overwrite</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">section</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &key, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &value)</td></tr>
|
|
<tr class="memdesc:ac9bc9bfdd56fde61573aae73511504c9"><td class="mdescLeft"> </td><td class="mdescRight">Overwrite a key/value pair with a command line argument If the section does not exist it is created. <a href="classripple_1_1BasicConfig.html#ac9bc9bfdd56fde61573aae73511504c9">More...</a><br /></td></tr>
|
|
<tr class="separator:ac9bc9bfdd56fde61573aae73511504c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a556417c29df26f83f08f81c64f2375b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a556417c29df26f83f08f81c64f2375b8">deprecatedClearSection</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">section</a>)</td></tr>
|
|
<tr class="memdesc:a556417c29df26f83f08f81c64f2375b8"><td class="mdescLeft"> </td><td class="mdescRight">Remove all the key/value pairs from the section. <a href="classripple_1_1BasicConfig.html#a556417c29df26f83f08f81c64f2375b8">More...</a><br /></td></tr>
|
|
<tr class="separator:a556417c29df26f83f08f81c64f2375b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2c21d011e6424d4917db175ef9df301"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#ae2c21d011e6424d4917db175ef9df301">legacy</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">section</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> value)</td></tr>
|
|
<tr class="memdesc:ae2c21d011e6424d4917db175ef9df301"><td class="mdescLeft"> </td><td class="mdescRight">Set a value that is not a key/value pair. <a href="classripple_1_1BasicConfig.html#ae2c21d011e6424d4917db175ef9df301">More...</a><br /></td></tr>
|
|
<tr class="separator:ae2c21d011e6424d4917db175ef9df301"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad56c45fbeee36f3ee87a1f9411dfb49c"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#ad56c45fbeee36f3ee87a1f9411dfb49c">legacy</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &sectionName) const</td></tr>
|
|
<tr class="memdesc:ad56c45fbeee36f3ee87a1f9411dfb49c"><td class="mdescLeft"> </td><td class="mdescRight">Get the legacy value of a section. <a href="classripple_1_1BasicConfig.html#ad56c45fbeee36f3ee87a1f9411dfb49c">More...</a><br /></td></tr>
|
|
<tr class="separator:ad56c45fbeee36f3ee87a1f9411dfb49c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e4703f27a2669c445f7c1e22871e974"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a3e4703f27a2669c445f7c1e22871e974">had_trailing_comments</a> () const</td></tr>
|
|
<tr class="separator:a3e4703f27a2669c445f7c1e22871e974"><td class="memSeparator" colspan="2"> </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:aa86db3273a1ea032a13c58220255d6e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#aa86db3273a1ea032a13c58220255d6e6">build</a> (<a class="el" href="namespaceripple.html#a055e8fa202b98cbf0b9abb812e093b4e">IniFileSections</a> const &ifs)</td></tr>
|
|
<tr class="separator:aa86db3273a1ea032a13c58220255d6e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a9ea715907c7a350de242c3b8391fd333"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="el" href="classripple_1_1Section.html">Section</a>, boost::beast::iless > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a9ea715907c7a350de242c3b8391fd333">map_</a></td></tr>
|
|
<tr class="separator:a9ea715907c7a350de242c3b8391fd333"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a949212869155daca6e6c4052fa790fa0"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a949212869155daca6e6c4052fa790fa0">operator<<</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &ss, <a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a> const &c)</td></tr>
|
|
<tr class="separator:a949212869155daca6e6c4052fa790fa0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Holds unparsed configuration information. </p>
|
|
<p>The raw data sections are processed with intermediate parsers specific to each module instead of being all parsed in a central location. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8h_source.html#l00215">215</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a09b31b8ed3c769b4c23b040c3d4798ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a09b31b8ed3c769b4c23b040c3d4798ed">◆ </a></span>exists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::BasicConfig::exists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns <code>true</code> if a section with the given name exists. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00121">121</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60aca585d76b1121dd4f72b358729456"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60aca585d76b1121dd4f72b358729456">◆ </a></span>section() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Section.html">Section</a> & ripple::BasicConfig::section </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the section with the given name. </p>
|
|
<p>If the section does not exist, an empty section is returned. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00127">127</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a69db08289110c1ef0d82f741f7951baa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69db08289110c1ef0d82f741f7951baa">◆ </a></span>section() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Section.html">Section</a> const & ripple::BasicConfig::section </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00133">133</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afbda2d17637bb43f071f8ff626707db1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afbda2d17637bb43f071f8ff626707db1">◆ </a></span>operator[]() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Section.html">Section</a> const& ripple::BasicConfig::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8h_source.html#l00236">236</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2a962a9fc649f1af2fa5a516aad5ea2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2a962a9fc649f1af2fa5a516aad5ea2">◆ </a></span>operator[]() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Section.html">Section</a>& ripple::BasicConfig::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8h_source.html#l00242">242</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9bc9bfdd56fde61573aae73511504c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9bc9bfdd56fde61573aae73511504c9">◆ </a></span>overwrite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::BasicConfig::overwrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>section</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 & </td>
|
|
<td class="paramname"><em>key</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 & </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overwrite a key/value pair with a command line argument If the section does not exist it is created. </p>
|
|
<p>The previous value, if any, is overwritten. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00143">143</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a556417c29df26f83f08f81c64f2375b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a556417c29df26f83f08f81c64f2375b8">◆ </a></span>deprecatedClearSection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::BasicConfig::deprecatedClearSection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>section</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove all the key/value pairs from the section. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00156">156</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2c21d011e6424d4917db175ef9df301"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2c21d011e6424d4917db175ef9df301">◆ </a></span>legacy() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::BasicConfig::legacy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>section</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> </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a value that is not a key/value pair. </p>
|
|
<p>The value is stored as the section's first value and may be retrieved through section::legacy.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">section</td><td>Name of the section to modify. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Contents of the legacy value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00164">164</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad56c45fbeee36f3ee87a1f9411dfb49c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad56c45fbeee36f3ee87a1f9411dfb49c">◆ </a></span>legacy() <span class="overload">[2/2]</span></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::BasicConfig::legacy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>sectionName</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the legacy value of a section. </p>
|
|
<p>A section with a single-line value may be retrieved as a legacy value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sectionName</td><td>Retrieve the contents of this section's legacy value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Contents of the legacy value. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00170">170</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e4703f27a2669c445f7c1e22871e974"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e4703f27a2669c445f7c1e22871e974">◆ </a></span>had_trailing_comments()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::BasicConfig::had_trailing_comments </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="BasicConfig_8h_source.html#l00292">292</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa86db3273a1ea032a13c58220255d6e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa86db3273a1ea032a13c58220255d6e6">◆ </a></span>build()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::BasicConfig::build </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a055e8fa202b98cbf0b9abb812e093b4e">IniFileSections</a> const & </td>
|
|
<td class="paramname"><em>ifs</em></td><td>)</td>
|
|
<td></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="BasicConfig_8cpp_source.html#l00176">176</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a id="a949212869155daca6e6c4052fa790fa0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a949212869155daca6e6c4052fa790fa0">◆ </a></span>operator<<</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/io/basic_ostream.html">std::ostream</a>& operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & </td>
|
|
<td class="paramname"><em>ss</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a> const & </td>
|
|
<td class="paramname"><em>c</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00189">189</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a9ea715907c7a350de242c3b8391fd333"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ea715907c7a350de242c3b8391fd333">◆ </a></span>map_</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/container/map.html">std::map</a><<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="el" href="classripple_1_1Section.html">Section</a>, boost::beast::iless> ripple::BasicConfig::map_</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="BasicConfig_8h_source.html#l00218">218</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- 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>
|