mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
429 lines
24 KiB
HTML
429 lines
24 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::Logs::File 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_1Logs.html">Logs</a></li><li class="navelem"><a class="el" href="classripple_1_1Logs_1_1File.html">File</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classripple_1_1Logs_1_1File-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ripple::Logs::File Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Manages a system file containing logged output.
|
|
<a href="classripple_1_1Logs_1_1File.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::Logs::File:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1Logs_1_1File__coll__graph.png" border="0" usemap="#ripple_1_1Logs_1_1File_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="ripple_1_1Logs_1_1File_coll__map" id="ripple_1_1Logs_1_1File_coll__map">
|
|
<area shape="rect" title="Manages a system file containing logged output." alt="" coords="19,199,146,225"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="5,95,160,136"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/io/basic_ofstream.html" title="STL class." alt="" coords="28,5,137,32"/>
|
|
</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:a7d75e7ebc83bf98c2483cea01e0b2a95"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a7d75e7ebc83bf98c2483cea01e0b2a95">File</a> ()</td></tr>
|
|
<tr class="memdesc:a7d75e7ebc83bf98c2483cea01e0b2a95"><td class="mdescLeft"> </td><td class="mdescRight">Construct with no associated system file. <a href="classripple_1_1Logs_1_1File.html#a7d75e7ebc83bf98c2483cea01e0b2a95">More...</a><br /></td></tr>
|
|
<tr class="separator:a7d75e7ebc83bf98c2483cea01e0b2a95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa963f20a769070622dca7afbaaab1840"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#aa963f20a769070622dca7afbaaab1840">~File</a> ()=default</td></tr>
|
|
<tr class="memdesc:aa963f20a769070622dca7afbaaab1840"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the object. <a href="classripple_1_1Logs_1_1File.html#aa963f20a769070622dca7afbaaab1840">More...</a><br /></td></tr>
|
|
<tr class="separator:aa963f20a769070622dca7afbaaab1840"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25b17b94c2d8bbdfd5299b1e7f6e75af"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a25b17b94c2d8bbdfd5299b1e7f6e75af">isOpen</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a25b17b94c2d8bbdfd5299b1e7f6e75af"><td class="mdescLeft"> </td><td class="mdescRight">Determine if a system file is associated with the log. <a href="classripple_1_1Logs_1_1File.html#a25b17b94c2d8bbdfd5299b1e7f6e75af">More...</a><br /></td></tr>
|
|
<tr class="separator:a25b17b94c2d8bbdfd5299b1e7f6e75af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebb8ad8ba4e14c10a4b024ee51d05c74"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#aebb8ad8ba4e14c10a4b024ee51d05c74">open</a> (boost::filesystem::path const &path)</td></tr>
|
|
<tr class="memdesc:aebb8ad8ba4e14c10a4b024ee51d05c74"><td class="mdescLeft"> </td><td class="mdescRight">Associate a system file with the log. <a href="classripple_1_1Logs_1_1File.html#aebb8ad8ba4e14c10a4b024ee51d05c74">More...</a><br /></td></tr>
|
|
<tr class="separator:aebb8ad8ba4e14c10a4b024ee51d05c74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a305145e14e8a66e68d7f871d21d413ea"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a305145e14e8a66e68d7f871d21d413ea">closeAndReopen</a> ()</td></tr>
|
|
<tr class="memdesc:a305145e14e8a66e68d7f871d21d413ea"><td class="mdescLeft"> </td><td class="mdescRight">Close and re-open the system file associated with the log This assists in interoperating with external log management tools. <a href="classripple_1_1Logs_1_1File.html#a305145e14e8a66e68d7f871d21d413ea">More...</a><br /></td></tr>
|
|
<tr class="separator:a305145e14e8a66e68d7f871d21d413ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ad01ad8aea8b12a3649c27668ea3767"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a6ad01ad8aea8b12a3649c27668ea3767">close</a> ()</td></tr>
|
|
<tr class="memdesc:a6ad01ad8aea8b12a3649c27668ea3767"><td class="mdescLeft"> </td><td class="mdescRight">Close the system file if it is open. <a href="classripple_1_1Logs_1_1File.html#a6ad01ad8aea8b12a3649c27668ea3767">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ad01ad8aea8b12a3649c27668ea3767"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7236fb8359c84fcae3ad95c9fccb805e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a7236fb8359c84fcae3ad95c9fccb805e">write</a> (char const *text)</td></tr>
|
|
<tr class="memdesc:a7236fb8359c84fcae3ad95c9fccb805e"><td class="mdescLeft"> </td><td class="mdescRight">write to the log file. <a href="classripple_1_1Logs_1_1File.html#a7236fb8359c84fcae3ad95c9fccb805e">More...</a><br /></td></tr>
|
|
<tr class="separator:a7236fb8359c84fcae3ad95c9fccb805e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a754b98f236e6f03194eebcb469685e0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a754b98f236e6f03194eebcb469685e0e">writeln</a> (char const *text)</td></tr>
|
|
<tr class="memdesc:a754b98f236e6f03194eebcb469685e0e"><td class="mdescLeft"> </td><td class="mdescRight">write to the log file and append an end of line marker. <a href="classripple_1_1Logs_1_1File.html#a754b98f236e6f03194eebcb469685e0e">More...</a><br /></td></tr>
|
|
<tr class="separator:a754b98f236e6f03194eebcb469685e0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
|
|
<tr class="memitem:a238ac82b799d069cbb52bedd46df13bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a238ac82b799d069cbb52bedd46df13bf">write</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &str)</td></tr>
|
|
<tr class="memdesc:a238ac82b799d069cbb52bedd46df13bf"><td class="mdescLeft"> </td><td class="mdescRight">Write to the log file using <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class.">std::string</a>. <a href="classripple_1_1Logs_1_1File.html#a238ac82b799d069cbb52bedd46df13bf">More...</a><br /></td></tr>
|
|
<tr class="separator:a238ac82b799d069cbb52bedd46df13bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d73645be41bb9616ff6c2fb0c397e5c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a4d73645be41bb9616ff6c2fb0c397e5c">writeln</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &str)</td></tr>
|
|
<tr class="separator:a4d73645be41bb9616ff6c2fb0c397e5c"><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:a3b7be698cff7949c9e56525a50d4896f"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ofstream.html">std::ofstream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a3b7be698cff7949c9e56525a50d4896f">m_stream</a></td></tr>
|
|
<tr class="separator:a3b7be698cff7949c9e56525a50d4896f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ce9ffe636436c5fde2f440ca0dc31af"><td class="memItemLeft" align="right" valign="top">boost::filesystem::path </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Logs_1_1File.html#a7ce9ffe636436c5fde2f440ca0dc31af">m_path</a></td></tr>
|
|
<tr class="separator:a7ce9ffe636436c5fde2f440ca0dc31af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Manages a system file containing logged output. </p>
|
|
<p>The system file remains open during program execution. Interfaces are provided for interoperating with standard log management tools like logrotate(8): <a href="http://linuxcommand.org/man_pages/logrotate8.html">http://linuxcommand.org/man_pages/logrotate8.html</a> </p><dl class="section note"><dt>Note</dt><dd>None of the listed interfaces are thread-safe. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8h_source.html#l00079">79</a> of file <a class="el" href="Log_8h_source.html">Log.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a7d75e7ebc83bf98c2483cea01e0b2a95"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d75e7ebc83bf98c2483cea01e0b2a95">◆ </a></span>File()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::Logs::File::File </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct with no associated system file. </p>
|
|
<p>A system file may be associated later with <a class="el" href="classripple_1_1Logs_1_1File.html#aebb8ad8ba4e14c10a4b024ee51d05c74">open</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1Logs_1_1File.html#aebb8ad8ba4e14c10a4b024ee51d05c74" title="Associate a system file with the log.">open</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8cpp_source.html#l00052">52</a> of file <a class="el" href="Log_8cpp_source.html">Log.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa963f20a769070622dca7afbaaab1840"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa963f20a769070622dca7afbaaab1840">◆ </a></span>~File()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::Logs::File::~File </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroy the object. </p>
|
|
<p>If a system file is associated, it will be flushed and closed. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a25b17b94c2d8bbdfd5299b1e7f6e75af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25b17b94c2d8bbdfd5299b1e7f6e75af">◆ </a></span>isOpen()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::Logs::File::isOpen </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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determine if a system file is associated with the log. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if a system file is associated and opened for writing. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8cpp_source.html#l00057">57</a> of file <a class="el" href="Log_8cpp_source.html">Log.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aebb8ad8ba4e14c10a4b024ee51d05c74"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebb8ad8ba4e14c10a4b024ee51d05c74">◆ </a></span>open()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::Logs::File::open </td>
|
|
<td>(</td>
|
|
<td class="paramtype">boost::filesystem::path const & </td>
|
|
<td class="paramname"><em>path</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Associate a system file with the log. </p>
|
|
<p>If the file does not exist an attempt is made to create it and open it for writing. If the file already exists an attempt is made to open it for appending. If a system file is already associated with the log, it is closed first. </p><dl class="section return"><dt>Returns</dt><dd><code>true</code> if the file was opened. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8cpp_source.html#l00063">63</a> of file <a class="el" href="Log_8cpp_source.html">Log.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a305145e14e8a66e68d7f871d21d413ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a305145e14e8a66e68d7f871d21d413ea">◆ </a></span>closeAndReopen()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::Logs::File::closeAndReopen </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Close and re-open the system file associated with the log This assists in interoperating with external log management tools. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the file was opened. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8cpp_source.html#l00086">86</a> of file <a class="el" href="Log_8cpp_source.html">Log.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ad01ad8aea8b12a3649c27668ea3767"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ad01ad8aea8b12a3649c27668ea3767">◆ </a></span>close()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::Logs::File::close </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Close the system file if it is open. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8cpp_source.html#l00094">94</a> of file <a class="el" href="Log_8cpp_source.html">Log.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7236fb8359c84fcae3ad95c9fccb805e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7236fb8359c84fcae3ad95c9fccb805e">◆ </a></span>write() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::Logs::File::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char const * </td>
|
|
<td class="paramname"><em>text</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>write to the log file. </p>
|
|
<p>Does nothing if there is no associated system file. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8cpp_source.html#l00100">100</a> of file <a class="el" href="Log_8cpp_source.html">Log.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a754b98f236e6f03194eebcb469685e0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a754b98f236e6f03194eebcb469685e0e">◆ </a></span>writeln() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::Logs::File::writeln </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char const * </td>
|
|
<td class="paramname"><em>text</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>write to the log file and append an end of line marker. </p>
|
|
<p>Does nothing if there is no associated system file. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8cpp_source.html#l00107">107</a> of file <a class="el" href="Log_8cpp_source.html">Log.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a238ac82b799d069cbb52bedd46df13bf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a238ac82b799d069cbb52bedd46df13bf">◆ </a></span>write() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::Logs::File::write </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>str</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write to the log file using <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class.">std::string</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8h_source.html#l00137">137</a> of file <a class="el" href="Log_8h_source.html">Log.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d73645be41bb9616ff6c2fb0c397e5c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d73645be41bb9616ff6c2fb0c397e5c">◆ </a></span>writeln() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::Logs::File::writeln </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>str</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Log_8h_source.html#l00143">143</a> of file <a class="el" href="Log_8h_source.html">Log.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a3b7be698cff7949c9e56525a50d4896f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3b7be698cff7949c9e56525a50d4896f">◆ </a></span>m_stream</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/memory/unique_ptr.html">std::unique_ptr</a><<a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ofstream.html">std::ofstream</a>> ripple::Logs::File::m_stream</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="Log_8h_source.html#l00150">150</a> of file <a class="el" href="Log_8h_source.html">Log.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7ce9ffe636436c5fde2f440ca0dc31af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ce9ffe636436c5fde2f440ca0dc31af">◆ </a></span>m_path</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::filesystem::path ripple::Logs::File::m_path</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="Log_8h_source.html#l00151">151</a> of file <a class="el" href="Log_8h_source.html">Log.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>
|