| <!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/logging/cerr_logger.h Source File</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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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()" |
| 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_e261caeeda3f8e02492ad86220e1178e.html">logging</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">cerr_logger.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="cerr__logger_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <atomic></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <mutex></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="log__level_8h.html">iceberg/logging/log_level.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="logger_8h.html">iceberg/logging/logger.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="foldopen" id="foldopen00040" data-start="{" data-end="};"> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classiceberg_1_1CerrLogger.html"> 40</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1CerrLogger.html">CerrLogger</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1Logger.html">Logger</a> {</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1CerrLogger.html">CerrLogger</a>(<a class="code hl_enumeration" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> level = LogLevel::kInfo) : level_(level) {}</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="foldopen" id="foldopen00044" data-start="{" data-end="}"> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classiceberg_1_1CerrLogger.html#a558618170d6e63857d529f7679742472"> 44</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1CerrLogger.html#a558618170d6e63857d529f7679742472">ShouldLog</a>(<a class="code hl_enumeration" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> level) <span class="keyword">const</span> <span class="keyword">noexcept</span> <span class="keyword">override</span> {</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">return</span> level >= level_.load(std::memory_order_relaxed);</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div> |
| </div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classiceberg_1_1CerrLogger.html#a990162c7376b0511aa6522fe64bf5a8c"> 47</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1CerrLogger.html#a990162c7376b0511aa6522fe64bf5a8c">Log</a>(<a class="code hl_class" href="structiceberg_1_1LogMessage.html">LogMessage</a>&& message) <span class="keyword">noexcept</span> <span class="keyword">override</span>;</div> |
| <div class="foldopen" id="foldopen00048" data-start="{" data-end="}"> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classiceberg_1_1CerrLogger.html#aa53823148c9833d542e1a391acaa0496"> 48</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1CerrLogger.html#aa53823148c9833d542e1a391acaa0496">SetLevel</a>(<a class="code hl_enumeration" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> level) <span class="keyword">noexcept</span> <span class="keyword">override</span> {</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> level_.store(level, std::memory_order_relaxed);</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div> |
| </div> |
| <div class="foldopen" id="foldopen00051" data-start="{" data-end="}"> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classiceberg_1_1CerrLogger.html#a6f5492fa7db6c8420b615f4d53440476"> 51</a></span> <a class="code hl_enumeration" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> <a class="code hl_function" href="classiceberg_1_1CerrLogger.html#a6f5492fa7db6c8420b615f4d53440476">level</a>() const noexcept<span class="keyword"> override </span>{</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">return</span> level_.load(std::memory_order_relaxed);</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div> |
| </div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classiceberg_1_1CerrLogger.html#a40deb0defa4c4fd1aaeba3a3980466a3"> 54</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1CerrLogger.html#a40deb0defa4c4fd1aaeba3a3980466a3">Flush</a>() noexcept override;</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> private:</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_namespace" href="namespacestd.html">std</a>::atomic<<a class="code hl_enumeration" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a>> level_;</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_namespace" href="namespacestd.html">std</a>::mutex mutex_;</div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>};</div> |
| </div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1CerrLogger_html"><div class="ttname"><a href="classiceberg_1_1CerrLogger.html">iceberg::CerrLogger</a></div><div class="ttdoc">Logger that writes one line per record to std::cerr.</div><div class="ttdef"><b>Definition</b> cerr_logger.h:40</div></div> |
| <div class="ttc" id="aclassiceberg_1_1CerrLogger_html_a40deb0defa4c4fd1aaeba3a3980466a3"><div class="ttname"><a href="classiceberg_1_1CerrLogger.html#a40deb0defa4c4fd1aaeba3a3980466a3">iceberg::CerrLogger::Flush</a></div><div class="ttdeci">void Flush() noexcept override</div><div class="ttdoc">Flush any buffered output. Must not throw; best-effort on the fatal path.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1CerrLogger_html_a558618170d6e63857d529f7679742472"><div class="ttname"><a href="classiceberg_1_1CerrLogger.html#a558618170d6e63857d529f7679742472">iceberg::CerrLogger::ShouldLog</a></div><div class="ttdeci">bool ShouldLog(LogLevel level) const noexcept override</div><div class="ttdoc">Cheap check whether a record at level would be emitted.</div><div class="ttdef"><b>Definition</b> cerr_logger.h:44</div></div> |
| <div class="ttc" id="aclassiceberg_1_1CerrLogger_html_a6f5492fa7db6c8420b615f4d53440476"><div class="ttname"><a href="classiceberg_1_1CerrLogger.html#a6f5492fa7db6c8420b615f4d53440476">iceberg::CerrLogger::level</a></div><div class="ttdeci">LogLevel level() const noexcept override</div><div class="ttdoc">Return the minimum level this logger emits.</div><div class="ttdef"><b>Definition</b> cerr_logger.h:51</div></div> |
| <div class="ttc" id="aclassiceberg_1_1CerrLogger_html_a990162c7376b0511aa6522fe64bf5a8c"><div class="ttname"><a href="classiceberg_1_1CerrLogger.html#a990162c7376b0511aa6522fe64bf5a8c">iceberg::CerrLogger::Log</a></div><div class="ttdeci">void Log(LogMessage &&message) noexcept override</div><div class="ttdoc">Emit one (already-formatted) record, taking ownership. Must not throw.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1CerrLogger_html_aa53823148c9833d542e1a391acaa0496"><div class="ttname"><a href="classiceberg_1_1CerrLogger.html#aa53823148c9833d542e1a391acaa0496">iceberg::CerrLogger::SetLevel</a></div><div class="ttdeci">void SetLevel(LogLevel level) noexcept override</div><div class="ttdoc">Set the minimum level this logger emits.</div><div class="ttdef"><b>Definition</b> cerr_logger.h:48</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Logger_html"><div class="ttname"><a href="classiceberg_1_1Logger.html">iceberg::Logger</a></div><div class="ttdoc">Pluggable logging sink.</div><div class="ttdef"><b>Definition</b> logger.h:146</div></div> |
| <div class="ttc" id="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div> |
| <div class="ttc" id="alog__level_8h_html"><div class="ttname"><a href="log__level_8h.html">log_level.h</a></div><div class="ttdoc">Severity levels for the logging system.</div></div> |
| <div class="ttc" id="alogger_8h_html"><div class="ttname"><a href="logger_8h.html">logger.h</a></div><div class="ttdoc">Pluggable logging interface and the process-global default logger.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_ab9922ae0d07dc85678a1a86c872e387b"><div class="ttname"><a href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">iceberg::LogLevel</a></div><div class="ttdeci">LogLevel</div><div class="ttdoc">Logging severity level, ordered from most to least verbose.</div><div class="ttdef"><b>Definition</b> log_level.h:38</div></div> |
| <div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div> |
| <div class="ttc" id="astructiceberg_1_1LogMessage_html"><div class="ttname"><a href="structiceberg_1_1LogMessage.html">iceberg::LogMessage</a></div><div class="ttdoc">A single log record handed to a Logger.</div><div class="ttdef"><b>Definition</b> logger.h:65</div></div> |
| </div><!-- fragment --></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> |
