libs/log/doc/html/boost/log/sources/basic_severity_logger.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_severity_logger</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="../../../logging_sources.html#header.boost.log.sources.severity_feature_hpp" title="Header &lt;boost/log/sources/severity_feature.hpp&gt;">
   9 <link rel="prev" href="../../../BOOST_LOG_CHANNEL_SEV.html" title="Macro BOOST_LOG_CHANNEL_SEV">
  10 <link rel="next" href="severity.html" title="Struct template severity">
  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="../../../BOOST_LOG_CHANNEL_SEV.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../logging_sources.html#header.boost.log.sources.severity_feature_hpp"><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="severity.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sources.basic_severity_logger"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template basic_severity_logger</span></h2>
  22 <p>boost::log::sources::basic_severity_logger &#8212; Severity level feature implementation. </p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../logging_sources.html#header.boost.log.sources.severity_feature_hpp" title="Header &lt;boost/log/sources/severity_feature.hpp&gt;">boost/log/sources/severity_feature.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BaseT<span class="special">,</span> <span class="keyword">typename</span> LevelT <span class="special">=</span> <span class="keyword">int</span><span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="basic_severity_logger.html" title="Class template basic_severity_logger">basic_severity_logger</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">BaseT</span> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// types</span>
  31   <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">char_type</span>                                                                     <a name="boost.log.sources.basic_severity_logger.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>           <span class="comment">// Character type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">final_type</span>                                                                    <a name="boost.log.sources.basic_severity_logger.final_type"></a><span class="identifier">final_type</span><span class="special">;</span>          <span class="comment">// Final type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">threading_model</span>                                                               <a name="boost.log.sources.basic_severity_logger.threading_model"></a><span class="identifier">threading_model</span><span class="special">;</span>     <span class="comment">// Threading model being used. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">LevelT</span>                                                                                   <a name="boost.log.sources.basic_severity_logger.severity_level"></a><span class="identifier">severity_level</span><span class="special">;</span>      <span class="comment">// Severity level type. </span>
  35   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                              <a name="boost.log.sources.basic_severity_logger.severity_attribute"></a><span class="identifier">severity_attribute</span><span class="special">;</span>  <span class="comment">// Severity attribute type. </span>
  36   <span class="keyword">typedef</span> <span class="identifier">strictest_lock</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">open_record_lock</span><span class="special">,</span> <span class="identifier">no_lock</span><span class="special">&lt;</span> <span class="identifier">threading_model</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.log.sources.basic_severity_logger.open_record_lock"></a><span class="identifier">open_record_lock</span><span class="special">;</span>    <span class="comment">// Lock requirement for the <code class="computeroutput">open_record_unlocked</code> method. </span>
  37   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                              <a name="boost.log.sources.basic_severity_logger.swap_lock"></a><span class="identifier">swap_lock</span><span class="special">;</span>           <span class="comment">// Lock requirement for the <code class="computeroutput">swap_unlocked</code> method. </span>
  38
  39   <span class="comment">// <a class="link" href="basic_severity_logger.html#boost.log.sources.basic_severity_loggerconstruct-copy-destruct">construct/copy/destruct</a></span>
  40   <a class="link" href="basic_severity_logger.html#idm45711346876704-bb"><span class="identifier">basic_severity_logger</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="basic_severity_logger.html#idm45711346875888-bb"><span class="identifier">basic_severity_logger</span></a><span class="special">(</span><a class="link" href="basic_severity_logger.html" title="Class template basic_severity_logger">basic_severity_logger</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42   <a class="link" href="basic_severity_logger.html#idm45711346874208-bb"><span class="identifier">basic_severity_logger</span></a><span class="special">(</span><a class="link" href="basic_severity_logger.html" title="Class template basic_severity_logger">basic_severity_logger</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  43   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="basic_severity_logger.html#idm45711346872528-bb"><span class="identifier">basic_severity_logger</span></a><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="basic_severity_logger.html#idm45711346878976-bb">public member functions</a></span>
  46   <span class="identifier">severity_level</span> <a class="link" href="basic_severity_logger.html#idm45711346878416-bb"><span class="identifier">default_severity</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="basic_severity_logger.html#idm45711346867712-bb">protected member functions</a></span>
  49   <span class="identifier">severity_attribute</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="basic_severity_logger.html#idm45711346867136-bb"><span class="identifier">get_severity_attribute</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span> <span class="identifier">record</span> <a class="link" href="basic_severity_logger.html#idm45711346865568-bb"><span class="identifier">open_record_unlocked</span></a><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  51   <span class="keyword">void</span> <a class="link" href="basic_severity_logger.html#idm45711346862320-bb"><span class="identifier">swap_unlocked</span></a><span class="special">(</span><a class="link" href="basic_severity_logger.html" title="Class template basic_severity_logger">basic_severity_logger</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52 <span class="special">}</span><span class="special">;</span></pre></div>
  53 <div class="refsect1">
  54 <a name="idm45554736765904"></a><h2>Description</h2>
  55 <div class="refsect2">
  56 <a name="idm45554736765488"></a><h3>
  57 <a name="boost.log.sources.basic_severity_loggerconstruct-copy-destruct"></a><code class="computeroutput">basic_severity_logger</code>
  58         public
  59        construct/copy/destruct</h3>
  60 <div class="orderedlist"><ol class="orderedlist" type="1">
  61 <li class="listitem">
  62 <pre class="literallayout"><a name="idm45711346876704-bb"></a><span class="identifier">basic_severity_logger</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  63 <p>Default constructor. The constructed logger will have a severity attribute registered. The default level for log records will be 0. </p>
  64 </li>
  65 <li class="listitem">
  66 <pre class="literallayout"><a name="idm45711346875888-bb"></a><span class="identifier">basic_severity_logger</span><span class="special">(</span><a class="link" href="basic_severity_logger.html" title="Class template basic_severity_logger">basic_severity_logger</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  67 <p>Copy constructor </p>
  68 </li>
  69 <li class="listitem">
  70 <pre class="literallayout"><a name="idm45711346874208-bb"></a><span class="identifier">basic_severity_logger</span><span class="special">(</span><a class="link" href="basic_severity_logger.html" title="Class template basic_severity_logger">basic_severity_logger</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  71 <p>Move constructor </p>
  72 </li>
  73 <li class="listitem">
  74 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span> <span class="keyword">explicit</span> <a name="idm45711346872528-bb"></a><span class="identifier">basic_severity_logger</span><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre>
  75 <p>Constructor with named arguments. Allows to setup the default level for log records.</p>
  76 <p>
  77 </p>
  78 <div class="variablelist"><table border="0" class="variablelist compact">
  79 <colgroup>
  80 <col align="left" valign="top">
  81 <col>
  82 </colgroup>
  83 <tbody><tr>
  84 <td><p><span class="term">Parameters:</span></p></td>
  85 <td><div class="variablelist"><table border="0" class="variablelist compact">
  86 <colgroup>
  87 <col align="left" valign="top">
  88 <col>
  89 </colgroup>
  90 <tbody><tr>
  91 <td><p><span class="term"><code class="computeroutput">args</code></span></p></td>
  92 <td>
  93 <p>A set of named arguments. The following arguments are supported: </p>
  94 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="computeroutput">severity</code> - default severity value </p></li></ul></div>
  95 <p>
  96 </p>
  97 </td>
  98 </tr></tbody>
  99 </table></div></td>
 100 </tr></tbody>
 101 </table></div>
 102 </li>
 103 </ol></div>
 104 </div>
 105 <div class="refsect2">
 106 <a name="idm45554736733552"></a><h3>
 107 <a name="idm45711346878976-bb"></a><code class="computeroutput">basic_severity_logger</code> public member functions</h3>
 108 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 109 <pre class="literallayout"><span class="identifier">severity_level</span> <a name="idm45711346878416-bb"></a><span class="identifier">default_severity</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 110 <p>Default severity value getter </p>
 111 </li></ol></div>
 112 </div>
 113 <div class="refsect2">
 114 <a name="idm45554736726080"></a><h3>
 115 <a name="idm45711346867712-bb"></a><code class="computeroutput">basic_severity_logger</code> protected member functions</h3>
 116 <div class="orderedlist"><ol class="orderedlist" type="1">
 117 <li class="listitem">
 118 <pre class="literallayout"><span class="identifier">severity_attribute</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45711346867136-bb"></a><span class="identifier">get_severity_attribute</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 119 <p>Severity attribute accessor </p>
 120 </li>
 121 <li class="listitem">
 122 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span> <span class="identifier">record</span> <a name="idm45711346865568-bb"></a><span class="identifier">open_record_unlocked</span><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre>
 123 <p>Unlocked <code class="computeroutput">open_record</code> </p>
 124 </li>
 125 <li class="listitem">
 126 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346862320-bb"></a><span class="identifier">swap_unlocked</span><span class="special">(</span><a class="link" href="basic_severity_logger.html" title="Class template basic_severity_logger">basic_severity_logger</a> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>Unlocked <code class="computeroutput">swap</code>. </li>
 127 </ol></div>
 128 </div>
 129 </div>
 130 </div>
 131 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 132 <td align="left"></td>
 133 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 134         Distributed under the Boost Software License, Version 1.0. (See accompanying
 135         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>).
 136       </p>
 137 </div></td>
 138 </tr></table>
 139 <hr>
 140 <div class="spirit-nav">
 141 <a accesskey="p" href="../../../BOOST_LOG_CHANNEL_SEV.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../logging_sources.html#header.boost.log.sources.severity_feature_hpp"><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="severity.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 142 </div>
 143 </body>
 144 </html>