| <!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>iceberg-cpp: iceberg::Logger 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">iceberg-cpp |
| </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&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&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="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1Logger.html">Logger</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classiceberg_1_1Logger-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::Logger Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Pluggable logging sink. |
| <a href="classiceberg_1_1Logger.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="logger_8h_source.html">logger.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::Logger:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1Logger.png" usemap="#iceberg::Logger_map" alt=""/> |
| <map id="iceberg::Logger_map" name="iceberg::Logger_map"> |
| <area href="classiceberg_1_1CerrLogger.html" title="Logger that writes one line per record to std::cerr." alt="iceberg::CerrLogger" shape="rect" coords="0,56,127,80"/> |
| </map> |
| </div></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:afb2309f921f8ebb7aa88ada353f37877" id="r_afb2309f921f8ebb7aa88ada353f37877"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Logger.html#afb2309f921f8ebb7aa88ada353f37877">Initialize</a> (const std::unordered_map< std::string, std::string > &properties)</td></tr> |
| <tr class="memdesc:afb2309f921f8ebb7aa88ada353f37877"><td class="mdescLeft"> </td><td class="mdescRight">Property-based setup, called by <a class="el" href="classiceberg_1_1Loggers.html#af1c99e12e428d980dcf180b2219d01b7" title="Construct and initialize a logger from properties.">Loggers::Load()</a> before first use. <br /></td></tr> |
| <tr class="separator:afb2309f921f8ebb7aa88ada353f37877"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae94e42dfc0fe122f056c54049f6b751f" id="r_ae94e42dfc0fe122f056c54049f6b751f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Logger.html#ae94e42dfc0fe122f056c54049f6b751f">ShouldLog</a> (<a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> <a class="el" href="classiceberg_1_1Logger.html#a8d7d6a59ecbb0a1ba0ca79cbbb079540">level</a>) const noexcept=0</td></tr> |
| <tr class="memdesc:ae94e42dfc0fe122f056c54049f6b751f"><td class="mdescLeft"> </td><td class="mdescRight">Cheap check whether a record at <code>level</code> would be emitted. <br /></td></tr> |
| <tr class="separator:ae94e42dfc0fe122f056c54049f6b751f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2cea7121351c84e8fe25a4fb2a1e52a3" id="r_a2cea7121351c84e8fe25a4fb2a1e52a3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Logger.html#a2cea7121351c84e8fe25a4fb2a1e52a3">Log</a> (<a class="el" href="structiceberg_1_1LogMessage.html">LogMessage</a> &&message) noexcept=0</td></tr> |
| <tr class="memdesc:a2cea7121351c84e8fe25a4fb2a1e52a3"><td class="mdescLeft"> </td><td class="mdescRight">Emit one (already-formatted) record, taking ownership. Must not throw. <br /></td></tr> |
| <tr class="separator:a2cea7121351c84e8fe25a4fb2a1e52a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a929efd366d31507b1d0fb0f20cc981ac" id="r_a929efd366d31507b1d0fb0f20cc981ac"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Logger.html#a929efd366d31507b1d0fb0f20cc981ac">SetLevel</a> (<a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> <a class="el" href="classiceberg_1_1Logger.html#a8d7d6a59ecbb0a1ba0ca79cbbb079540">level</a>) noexcept=0</td></tr> |
| <tr class="memdesc:a929efd366d31507b1d0fb0f20cc981ac"><td class="mdescLeft"> </td><td class="mdescRight">Set the minimum level this logger emits. <br /></td></tr> |
| <tr class="separator:a929efd366d31507b1d0fb0f20cc981ac"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d7d6a59ecbb0a1ba0ca79cbbb079540" id="r_a8d7d6a59ecbb0a1ba0ca79cbbb079540"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Logger.html#a8d7d6a59ecbb0a1ba0ca79cbbb079540">level</a> () const noexcept=0</td></tr> |
| <tr class="memdesc:a8d7d6a59ecbb0a1ba0ca79cbbb079540"><td class="mdescLeft"> </td><td class="mdescRight">Return the minimum level this logger emits. <br /></td></tr> |
| <tr class="separator:a8d7d6a59ecbb0a1ba0ca79cbbb079540"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a1b632c1d153e90cf3faef8a29e6419" id="r_a2a1b632c1d153e90cf3faef8a29e6419"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Logger.html#a2a1b632c1d153e90cf3faef8a29e6419">Flush</a> () noexcept</td></tr> |
| <tr class="memdesc:a2a1b632c1d153e90cf3faef8a29e6419"><td class="mdescLeft"> </td><td class="mdescRight">Flush any buffered output. Must not throw; best-effort on the fatal path. <br /></td></tr> |
| <tr class="separator:a2a1b632c1d153e90cf3faef8a29e6419"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af869669496ecfff9c7de9b737bdbb404" id="r_af869669496ecfff9c7de9b737bdbb404"><td class="memItemLeft" align="right" valign="top"><a id="af869669496ecfff9c7de9b737bdbb404" name="af869669496ecfff9c7de9b737bdbb404"></a> |
| virtual bool </td><td class="memItemRight" valign="bottom"><b>IsNoop</b> () const</td></tr> |
| <tr class="memdesc:af869669496ecfff9c7de9b737bdbb404"><td class="mdescLeft"> </td><td class="mdescRight">Return true if this logger is a no-op. <br /></td></tr> |
| <tr class="separator:af869669496ecfff9c7de9b737bdbb404"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a8f82381c82fb655b0441d2292787630b" id="r_a8f82381c82fb655b0441d2292787630b"><td class="memItemLeft" align="right" valign="top"><a id="a8f82381c82fb655b0441d2292787630b" name="a8f82381c82fb655b0441d2292787630b"></a> |
| static std::shared_ptr< <a class="el" href="classiceberg_1_1Logger.html">Logger</a> > </td><td class="memItemRight" valign="bottom"><b>Noop</b> ()</td></tr> |
| <tr class="memdesc:a8f82381c82fb655b0441d2292787630b"><td class="mdescLeft"> </td><td class="mdescRight">Return a shared, immortal no-op logger singleton. <br /></td></tr> |
| <tr class="separator:a8f82381c82fb655b0441d2292787630b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Pluggable logging sink. </p> |
| <p><a class="el" href="classiceberg_1_1Logger.html#ae94e42dfc0fe122f056c54049f6b751f" title="Cheap check whether a record at level would be emitted.">ShouldLog()</a> is the single authority for runtime filtering – the logging path calls it on every (compile-time-enabled) statement, so level changes by any path take effect immediately. Implementations must be thread-safe and must not throw. They must also obey:</p><ul> |
| <li>No reentrancy: <a class="el" href="classiceberg_1_1Logger.html#a2cea7121351c84e8fe25a4fb2a1e52a3" title="Emit one (already-formatted) record, taking ownership. Must not throw.">Log()</a>/Flush() must not call the logging API or <a class="el" href="namespaceiceberg.html#ae57e7ff8b112264aeee1c3f1a3699368" title="Return the process-global default logger (never null).">GetDefaultLogger()</a> (UB – deadlock with mutex-based sinks).</li> |
| <li><a class="el" href="classiceberg_1_1Logger.html#a8d7d6a59ecbb0a1ba0ca79cbbb079540" title="Return the minimum level this logger emits.">level()</a> is an accessor consistent with ShouldLog (used by SetDefaultLevel and introspection); ShouldLog may implement finer logic than a level compare. </li> |
| </ul> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2a1b632c1d153e90cf3faef8a29e6419" name="a2a1b632c1d153e90cf3faef8a29e6419"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2a1b632c1d153e90cf3faef8a29e6419">◆ </a></span>Flush()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void iceberg::Logger::Flush </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Flush any buffered output. Must not throw; best-effort on the fatal path. </p> |
| |
| <p>Reimplemented in <a class="el" href="classiceberg_1_1CerrLogger.html#a40deb0defa4c4fd1aaeba3a3980466a3">iceberg::CerrLogger</a>.</p> |
| |
| </div> |
| </div> |
| <a id="afb2309f921f8ebb7aa88ada353f37877" name="afb2309f921f8ebb7aa88ada353f37877"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afb2309f921f8ebb7aa88ada353f37877">◆ </a></span>Initialize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Status iceberg::Logger::Initialize </td> |
| <td>(</td> |
| <td class="paramtype">const std::unordered_map< std::string, std::string > & </td> |
| <td class="paramname"><em>properties</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Property-based setup, called by <a class="el" href="classiceberg_1_1Loggers.html#af1c99e12e428d980dcf180b2219d01b7" title="Construct and initialize a logger from properties.">Loggers::Load()</a> before first use. </p> |
| <p>The base implementation applies the "level" property (parsed via LogLevelFromString); an unrecognized value is an InvalidArgument error. The spdlog backend overrides this to also apply "pattern" and then delegates to this base for "level"; <a class="el" href="classiceberg_1_1CerrLogger.html" title="Logger that writes one line per record to std::cerr.">CerrLogger</a> uses the base as-is (fixed layout). </p> |
| |
| </div> |
| </div> |
| <a id="a8d7d6a59ecbb0a1ba0ca79cbbb079540" name="a8d7d6a59ecbb0a1ba0ca79cbbb079540"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8d7d6a59ecbb0a1ba0ca79cbbb079540">◆ </a></span>level()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> iceberg::Logger::level </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">pure virtual</span><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return the minimum level this logger emits. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1CerrLogger.html#a6f5492fa7db6c8420b615f4d53440476">iceberg::CerrLogger</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2cea7121351c84e8fe25a4fb2a1e52a3" name="a2cea7121351c84e8fe25a4fb2a1e52a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2cea7121351c84e8fe25a4fb2a1e52a3">◆ </a></span>Log()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void iceberg::Logger::Log </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structiceberg_1_1LogMessage.html">LogMessage</a> && </td> |
| <td class="paramname"><em>message</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Emit one (already-formatted) record, taking ownership. Must not throw. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1CerrLogger.html#a990162c7376b0511aa6522fe64bf5a8c">iceberg::CerrLogger</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a929efd366d31507b1d0fb0f20cc981ac" name="a929efd366d31507b1d0fb0f20cc981ac"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a929efd366d31507b1d0fb0f20cc981ac">◆ </a></span>SetLevel()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void iceberg::Logger::SetLevel </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> </td> |
| <td class="paramname"><em>level</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the minimum level this logger emits. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1CerrLogger.html#aa53823148c9833d542e1a391acaa0496">iceberg::CerrLogger</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae94e42dfc0fe122f056c54049f6b751f" name="ae94e42dfc0fe122f056c54049f6b751f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae94e42dfc0fe122f056c54049f6b751f">◆ </a></span>ShouldLog()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool iceberg::Logger::ShouldLog </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> </td> |
| <td class="paramname"><em>level</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Cheap check whether a record at <code>level</code> would be emitted. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1CerrLogger.html#a558618170d6e63857d529f7679742472">iceberg::CerrLogger</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/logging/<a class="el" href="logger_8h_source.html">logger.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
