libs/log/doc/html/log/reference.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Reference</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   9 <link rel="prev" href="rationale/msvc_link_fails_lnk1123.html" title="Why MSVC 2010 fails to link the library with error LNK1123: failure during conversion to COFF: file invalid or corrupt?">
  10 <link rel="next" href="../boost/log/bad_alloc.html" title="Class bad_alloc">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="rationale/msvc_link_fails_lnk1123.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../boost/log/bad_alloc.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="section">
  19 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  20 <a name="log.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
  21 </h2></div></div></div>
  22 <div class="toc"><dl class="toc">
  23 <dt><span class="section"><a href="reference.html#top_level_headers">Top level headers</a></span></dt>
  24 <dt><span class="section"><a href="../core_components.html">Core components</a></span></dt>
  25 <dt><span class="section"><a href="../attributes.html">Attributes</a></span></dt>
  26 <dt><span class="section"><a href="../expressions.html">Expressions</a></span></dt>
  27 <dt><span class="section"><a href="../logging_sources.html">Logging sources</a></span></dt>
  28 <dt><span class="section"><a href="../sinks.html">Sinks</a></span></dt>
  29 <dt><span class="section"><a href="../utilities.html">Utilities</a></span></dt>
  30 <dt><span class="section"><a href="../other_libraries_support_layer.html">Other libraries support layer</a></span></dt>
  31 </dl></div>
  32 <div class="section">
  33 <div class="titlepage"><div><div><h3 class="title">
  34 <a name="top_level_headers"></a>Top level headers</h3></div></div></div>
  35 <div class="toc"><dl class="toc">
  36 <dt><span class="section"><a href="reference.html#header.boost.log.attributes_hpp">Header &lt;boost/log/attributes.hpp&gt;</a></span></dt>
  37 <dt><span class="section"><a href="reference.html#header.boost.log.common_hpp">Header &lt;boost/log/common.hpp&gt;</a></span></dt>
  38 <dt><span class="section"><a href="reference.html#header.boost.log.core_hpp">Header &lt;boost/log/core.hpp&gt;</a></span></dt>
  39 <dt><span class="section"><a href="reference.html#header.boost.log.exceptions_hpp">Header &lt;boost/log/exceptions.hpp&gt;</a></span></dt>
  40 <dt><span class="section"><a href="reference.html#header.boost.log.expressions_hpp">Header &lt;boost/log/expressions.hpp&gt;</a></span></dt>
  41 <dt><span class="section"><a href="reference.html#header.boost.log.sinks_hpp">Header &lt;boost/log/sinks.hpp&gt;</a></span></dt>
  42 <dt><span class="section"><a href="reference.html#header.boost.log.trivial_hpp">Header &lt;boost/log/trivial.hpp&gt;</a></span></dt>
  43 </dl></div>
  44 <div class="section">
  45 <div class="titlepage"><div><div><h4 class="title">
  46 <a name="header.boost.log.attributes_hpp"></a>Header &lt;<a href="../../../../../boost/log/attributes.hpp" target="_top">boost/log/attributes.hpp</a>&gt;</h4></div></div></div>
  47 <p>Andrey Semashev </p>
  48 <p>
  49
  50 </p>
  51 <p>13.07.2009</p>
  52 <p>
  53
  54 This header includes other Boost.Log headers with all attributes. </p>
  55 </div>
  56 <div class="section">
  57 <div class="titlepage"><div><div><h4 class="title">
  58 <a name="header.boost.log.common_hpp"></a>Header &lt;<a href="../../../../../boost/log/common.hpp" target="_top">boost/log/common.hpp</a>&gt;</h4></div></div></div>
  59 <p>Andrey Semashev </p>
  60 <p>
  61
  62 </p>
  63 <p>14.03.2009</p>
  64 <p>
  65
  66 This header includes other Boost.Log headers that are commonly used in logging applications. Note that the header does not include any headers required to setup the library, as usually they aren't needed in more than one translation unit of the application. </p>
  67 </div>
  68 <div class="section">
  69 <div class="titlepage"><div><div><h4 class="title">
  70 <a name="header.boost.log.core_hpp"></a>Header &lt;<a href="../../../../../boost/log/core.hpp" target="_top">boost/log/core.hpp</a>&gt;</h4></div></div></div>
  71 <p>Andrey Semashev </p>
  72 <p>
  73
  74 </p>
  75 <p>19.04.2007</p>
  76 <p>
  77
  78 This header includes Boost.Log headers related to the logging core. </p>
  79 </div>
  80 <div class="section">
  81 <div class="titlepage"><div><div><h4 class="title">
  82 <a name="header.boost.log.exceptions_hpp"></a>Header &lt;<a href="../../../../../boost/log/exceptions.hpp" target="_top">boost/log/exceptions.hpp</a>&gt;</h4></div></div></div>
  83 <p>Andrey Semashev </p>
  84 <p>
  85
  86 </p>
  87 <p>31.10.2009</p>
  88 <p>
  89
  90 The header contains exception classes declarations. </p>
  91 <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  92   <span class="keyword">namespace</span> <span class="identifier">log</span> <span class="special">{</span>
  93     <span class="keyword">class</span> <a class="link" href="../boost/log/bad_alloc.html" title="Class bad_alloc">bad_alloc</a><span class="special">;</span>
  94     <span class="keyword">class</span> <a class="link" href="../boost/log/capacity_limit_reached.html" title="Class capacity_limit_reached">capacity_limit_reached</a><span class="special">;</span>
  95     <span class="keyword">class</span> <a class="link" href="../boost/log/conversion_error.html" title="Class conversion_error">conversion_error</a><span class="special">;</span>
  96     <span class="keyword">class</span> <a class="link" href="../boost/log/invalid_type.html" title="Class invalid_type">invalid_type</a><span class="special">;</span>
  97     <span class="keyword">class</span> <a class="link" href="../boost/log/invalid_value.html" title="Class invalid_value">invalid_value</a><span class="special">;</span>
  98     <span class="keyword">class</span> <a class="link" href="../boost/log/limitation_error.html" title="Class limitation_error">limitation_error</a><span class="special">;</span>
  99     <span class="keyword">class</span> <a class="link" href="../boost/log/logic_error.html" title="Class logic_error">logic_error</a><span class="special">;</span>
 100     <span class="keyword">class</span> <a class="link" href="../boost/log/missing_value.html" title="Class missing_value">missing_value</a><span class="special">;</span>
 101     <span class="keyword">class</span> <a class="link" href="../boost/log/odr_violation.html" title="Class odr_violation">odr_violation</a><span class="special">;</span>
 102     <span class="keyword">class</span> <a class="link" href="../boost/log/parse_error.html" title="Class parse_error">parse_error</a><span class="special">;</span>
 103     <span class="keyword">class</span> <a class="link" href="../boost/log/runtime_error.html" title="Class runtime_error">runtime_error</a><span class="special">;</span>
 104     <span class="keyword">class</span> <a class="link" href="../boost/log/setup_error.html" title="Class setup_error">setup_error</a><span class="special">;</span>
 105     <span class="keyword">class</span> <a class="link" href="../boost/log/system_error.html" title="Class system_error">system_error</a><span class="special">;</span>
 106     <span class="keyword">class</span> <a class="link" href="../boost/log/unexpected_call.html" title="Class unexpected_call">unexpected_call</a><span class="special">;</span>
 107   <span class="special">}</span>
 108 <span class="special">}</span></pre>
 109 </div>
 110 <div class="section">
 111 <div class="titlepage"><div><div><h4 class="title">
 112 <a name="header.boost.log.expressions_hpp"></a>Header &lt;<a href="../../../../../boost/log/expressions.hpp" target="_top">boost/log/expressions.hpp</a>&gt;</h4></div></div></div>
 113 <p>Andrey Semashev </p>
 114 <p>
 115
 116 </p>
 117 <p>10.11.2012</p>
 118 <p>
 119
 120 This header includes other Boost.Log headers with all template expression tools. </p>
 121 </div>
 122 <div class="section">
 123 <div class="titlepage"><div><div><h4 class="title">
 124 <a name="header.boost.log.sinks_hpp"></a>Header &lt;<a href="../../../../../boost/log/sinks.hpp" target="_top">boost/log/sinks.hpp</a>&gt;</h4></div></div></div>
 125 <p>Andrey Semashev </p>
 126 <p>
 127
 128 </p>
 129 <p>13.07.2009</p>
 130 <p>
 131
 132 This header includes other Boost.Log headers with all sinks. </p>
 133 </div>
 134 <div class="section">
 135 <div class="titlepage"><div><div><h4 class="title">
 136 <a name="header.boost.log.trivial_hpp"></a>Header &lt;<a href="../../../../../boost/log/trivial.hpp" target="_top">boost/log/trivial.hpp</a>&gt;</h4></div></div></div>
 137 <p>Andrey Semashev </p>
 138 <p>
 139
 140 </p>
 141 <p>07.11.2009</p>
 142 <p>
 143
 144 This header defines tools for trivial logging support </p>
 145 <pre class="synopsis">
 146
 147 <a class="link" href="../BOOST_LOG_TRIVIAL.html" title="Macro BOOST_LOG_TRIVIAL">BOOST_LOG_TRIVIAL</a>(lvl)</pre>
 148 <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
 149   <span class="keyword">namespace</span> <span class="identifier">log</span> <span class="special">{</span>
 150     <span class="keyword">namespace</span> <span class="identifier">trivial</span> <span class="special">{</span>
 151       <span class="keyword">struct</span> <a class="link" href="../boost/log/trivial/logger.html" title="Struct logger">logger</a><span class="special">;</span>
 152
 153       <span class="comment">// Trivial severity levels. </span>
 154       <span class="keyword">enum</span> <a name="boost.log.trivial.severity_level"></a>severity_level <span class="special">{</span> trace, debug, info, warning, error, fatal <span class="special">}</span><span class="special">;</span>
 155
 156       <span class="keyword">typedef</span> <span class="identifier">sources</span><span class="special">::</span><span class="identifier">severity_logger_mt</span><span class="special">&lt;</span> <span class="identifier">severity_level</span> <span class="special">&gt;</span> <a name="boost.log.trivial.logger_type"></a><span class="identifier">logger_type</span><span class="special">;</span>  <span class="comment">// Trivial logger type. </span>
 157       <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span> <span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span> <a class="link" href="../boost/log/trivial/to_string.html" title="Function template to_string"><span class="identifier">to_string</span></a><span class="special">(</span><span class="identifier">severity_level</span><span class="special">)</span><span class="special">;</span>
 158       <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
 159         <span class="keyword">bool</span> <a class="link" href="../boost/log/trivial/from_string.html" title="Function template from_string"><span class="identifier">from_string</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">severity_level</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 160       <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> TraitsT<span class="special">&gt;</span>
 161         <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
 162         <a class="link" href="../boost/log/trivial/operator_idm45711350676720.html" title="Function template operator&lt;&lt;"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">severity_level</span><span class="special">)</span><span class="special">;</span>
 163       <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> TraitsT<span class="special">&gt;</span>
 164         <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
 165         <a class="link" href="../boost/log/trivial/operator_idm45711350673136.html" title="Function template operator&gt;&gt;"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">severity_level</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 166     <span class="special">}</span>
 167   <span class="special">}</span>
 168 <span class="special">}</span></pre>
 169 </div>
 170 </div>
 171 </div>
 172 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 173 <td align="left"></td>
 174 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 175         Distributed under the Boost Software License, Version 1.0. (See accompanying
 176         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
 177       </p>
 178 </div></td>
 179 </tr></table>
 180 <hr>
 181 <div class="spirit-nav">
 182 <a accesskey="p" href="rationale/msvc_link_fails_lnk1123.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../boost/log/bad_alloc.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 183 </div>
 184 </body>
 185 </html>