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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_channel_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.channel_feature_hpp" title="Header &lt;boost/log/sources/channel_feature.hpp&gt;">
   9 <link rel="prev" href="../../../BOOST_LOG_DECLARE_WLOGGER_MT.html" title="Macro BOOST_LOG_DECLARE_WLOGGER_MT">
  10 <link rel="next" href="basic_channel_logger/make_default_channel_name.html" title="Struct make_default_channel_name">
  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_DECLARE_WLOGGER_MT.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../logging_sources.html#header.boost.log.sources.channel_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="basic_channel_logger/make_default_channel_name.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sources.basic_channel_logger"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template basic_channel_logger</span></h2>
  22 <p>boost::log::sources::basic_channel_logger &#8212; Channel 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.channel_feature_hpp" title="Header &lt;boost/log/sources/channel_feature.hpp&gt;">boost/log/sources/channel_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> ChannelT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="basic_channel_logger.html" title="Class template basic_channel_logger">basic_channel_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_channel_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_channel_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_channel_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">ChannelT</span>                                     <a name="boost.log.sources.basic_channel_logger.channel_type"></a><span class="identifier">channel_type</span><span class="special">;</span>       <span class="comment">// Channel type. </span>
  35   <span class="keyword">typedef</span> <span class="identifier">attributes</span><span class="special">::</span><span class="identifier">mutable_constant</span><span class="special">&lt;</span> <span class="identifier">channel_type</span> <span class="special">&gt;</span> <a name="boost.log.sources.basic_channel_logger.channel_attribute"></a><span class="identifier">channel_attribute</span><span class="special">;</span>  <span class="comment">// Channel attribute type. </span>
  36   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                  <a name="boost.log.sources.basic_channel_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_channel_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">// member classes/structs/unions</span>
  40
  41   <span class="comment">// Default channel name generator.</span>
  42
  43   <span class="keyword">struct</span> <a class="link" href="basic_channel_logger/make_default_channel_name.html" title="Struct make_default_channel_name">make_default_channel_name</a> <span class="special">{</span>
  44     <span class="comment">// types</span>
  45     <span class="keyword">typedef</span> <span class="identifier">channel_type</span> <a class="link" href="basic_channel_logger/make_default_channel_name.html#boost.log.sources.basic_channel_logger.make_default_channel_name.result_type"><span class="identifier">result_type</span></a><span class="special">;</span>
  46
  47     <span class="comment">// <a class="link" href="basic_channel_logger/make_default_channel_name.html#idp61262832-bb">public member functions</a></span>
  48     <span class="identifier">result_type</span> <a class="link" href="basic_channel_logger/make_default_channel_name.html#idp61263392-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49   <span class="special">}</span><span class="special">;</span>
  50
  51   <span class="comment">// <a class="link" href="basic_channel_logger.html#boost.log.sources.basic_channel_loggerconstruct-copy-destruct">construct/copy/destruct</a></span>
  52   <a class="link" href="basic_channel_logger.html#idp61279600-bb"><span class="identifier">basic_channel_logger</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  53   <a class="link" href="basic_channel_logger.html#idp61280368-bb"><span class="identifier">basic_channel_logger</span></a><span class="special">(</span><a class="link" href="basic_channel_logger.html" title="Class template basic_channel_logger">basic_channel_logger</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  54   <a class="link" href="basic_channel_logger.html#idp61282048-bb"><span class="identifier">basic_channel_logger</span></a><span class="special">(</span><a class="link" href="basic_channel_logger.html" title="Class template basic_channel_logger">basic_channel_logger</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <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_channel_logger.html#idp61283728-bb"><span class="identifier">basic_channel_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>
  56
  57   <span class="comment">// <a class="link" href="basic_channel_logger.html#idp61273888-bb">public member functions</a></span>
  58   <span class="identifier">channel_type</span> <a class="link" href="basic_channel_logger.html#idp61274448-bb"><span class="identifier">channel</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="keyword">void</span> <a class="link" href="basic_channel_logger.html#idp61276736-bb"><span class="identifier">channel</span></a><span class="special">(</span><span class="identifier">channel_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  60
  61   <span class="comment">// <a class="link" href="basic_channel_logger.html#idp61288416-bb">protected member functions</a></span>
  62   <span class="identifier">channel_attribute</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="basic_channel_logger.html#idp61288992-bb"><span class="identifier">get_channel_attribute</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63   <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_channel_logger.html#idp61290560-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>
  64   <span class="keyword">void</span> <a class="link" href="basic_channel_logger.html#idp61293808-bb"><span class="identifier">swap_unlocked</span></a><span class="special">(</span><a class="link" href="basic_channel_logger.html" title="Class template basic_channel_logger">basic_channel_logger</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  65
  66   <span class="comment">// <a class="link" href="basic_channel_logger.html#idp61296208-bb">private member functions</a></span>
  67   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">&gt;</span>
  68     <span class="identifier">record</span> <a class="link" href="basic_channel_logger.html#idp61296784-bb"><span class="identifier">open_record_with_channel_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="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  69   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span>
  70     <span class="identifier">record</span> <a class="link" href="basic_channel_logger.html#idp61301232-bb"><span class="identifier">open_record_with_channel_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="identifier">parameter</span><span class="special">::</span><span class="identifier">void_</span><span class="special">)</span><span class="special">;</span>
  71 <span class="special">}</span><span class="special">;</span></pre></div>
  72 <div class="refsect1">
  73 <a name="idp120223568"></a><h2>Description</h2>
  74 <div class="refsect2">
  75 <a name="idp120223984"></a><h3>
  76 <a name="boost.log.sources.basic_channel_loggerconstruct-copy-destruct"></a><code class="computeroutput">basic_channel_logger</code>
  77         public
  78        construct/copy/destruct</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1">
  80 <li class="listitem">
  81 <pre class="literallayout"><a name="idp61279600-bb"></a><span class="identifier">basic_channel_logger</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  82 <p>Default constructor. The constructed logger has the default-constructed channel name. </p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><a name="idp61280368-bb"></a><span class="identifier">basic_channel_logger</span><span class="special">(</span><a class="link" href="basic_channel_logger.html" title="Class template basic_channel_logger">basic_channel_logger</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  86 <p>Copy constructor </p>
  87 </li>
  88 <li class="listitem">
  89 <pre class="literallayout"><a name="idp61282048-bb"></a><span class="identifier">basic_channel_logger</span><span class="special">(</span><a class="link" href="basic_channel_logger.html" title="Class template basic_channel_logger">basic_channel_logger</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  90 <p>Move constructor </p>
  91 </li>
  92 <li class="listitem">
  93 <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="idp61283728-bb"></a><span class="identifier">basic_channel_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>
  94 <p>Constructor with arguments. Allows to register a channel name attribute on construction.</p>
  95 <p>
  96 </p>
  97 <div class="variablelist"><table border="0" class="variablelist compact">
  98 <colgroup>
  99 <col align="left" valign="top">
 100 <col>
 101 </colgroup>
 102 <tbody><tr>
 103 <td><p><span class="term">Parameters:</span></p></td>
 104 <td><div class="variablelist"><table border="0" class="variablelist compact">
 105 <colgroup>
 106 <col align="left" valign="top">
 107 <col>
 108 </colgroup>
 109 <tbody><tr>
 110 <td><p><span class="term"><code class="computeroutput">args</code></span></p></td>
 111 <td>
 112 <p>A set of named arguments. The following arguments are supported: </p>
 113 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="computeroutput">channel</code> - a string that represents the channel name </p></li></ul></div>
 114 <p>
 115 </p>
 116 </td>
 117 </tr></tbody>
 118 </table></div></td>
 119 </tr></tbody>
 120 </table></div>
 121 </li>
 122 </ol></div>
 123 </div>
 124 <div class="refsect2">
 125 <a name="idp120256064"></a><h3>
 126 <a name="idp61273888-bb"></a><code class="computeroutput">basic_channel_logger</code> public member functions</h3>
 127 <div class="orderedlist"><ol class="orderedlist" type="1">
 128 <li class="listitem">
 129 <pre class="literallayout"><span class="identifier">channel_type</span> <a name="idp61274448-bb"></a><span class="identifier">channel</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 130 <p>The observer of the channel name</p>
 131 <p>
 132 </p>
 133 <div class="variablelist"><table border="0" class="variablelist compact">
 134 <colgroup>
 135 <col align="left" valign="top">
 136 <col>
 137 </colgroup>
 138 <tbody><tr>
 139 <td><p><span class="term">Returns:</span></p></td>
 140 <td><p>The channel name that was set by the logger </p></td>
 141 </tr></tbody>
 142 </table></div>
 143 </li>
 144 <li class="listitem">
 145 <pre class="literallayout"><span class="keyword">void</span> <a name="idp61276736-bb"></a><span class="identifier">channel</span><span class="special">(</span><span class="identifier">channel_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> ch<span class="special">)</span><span class="special">;</span></pre>
 146 <p>The setter of the channel name</p>
 147 <p>
 148 </p>
 149 <div class="variablelist"><table border="0" class="variablelist compact">
 150 <colgroup>
 151 <col align="left" valign="top">
 152 <col>
 153 </colgroup>
 154 <tbody><tr>
 155 <td><p><span class="term">Parameters:</span></p></td>
 156 <td><div class="variablelist"><table border="0" class="variablelist compact">
 157 <colgroup>
 158 <col align="left" valign="top">
 159 <col>
 160 </colgroup>
 161 <tbody><tr>
 162 <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td>
 163 <td><p>The channel name to be set for the logger </p></td>
 164 </tr></tbody>
 165 </table></div></td>
 166 </tr></tbody>
 167 </table></div>
 168 </li>
 169 </ol></div>
 170 </div>
 171 <div class="refsect2">
 172 <a name="idp120275280"></a><h3>
 173 <a name="idp61288416-bb"></a><code class="computeroutput">basic_channel_logger</code> protected member functions</h3>
 174 <div class="orderedlist"><ol class="orderedlist" type="1">
 175 <li class="listitem">
 176 <pre class="literallayout"><span class="identifier">channel_attribute</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp61288992-bb"></a><span class="identifier">get_channel_attribute</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 177 <p>Channel attribute accessor </p>
 178 </li>
 179 <li class="listitem">
 180 <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="idp61290560-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>
 181 <p>Unlocked <code class="computeroutput">open_record</code> </p>
 182 </li>
 183 <li class="listitem">
 184 <pre class="literallayout"><span class="keyword">void</span> <a name="idp61293808-bb"></a><span class="identifier">swap_unlocked</span><span class="special">(</span><a class="link" href="basic_channel_logger.html" title="Class template basic_channel_logger">basic_channel_logger</a> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
 185 <p>Unlocked swap </p>
 186 </li>
 187 </ol></div>
 188 </div>
 189 <div class="refsect2">
 190 <a name="idp120300128"></a><h3>
 191 <a name="idp61296208-bb"></a><code class="computeroutput">basic_channel_logger</code> private member functions</h3>
 192 <div class="orderedlist"><ol class="orderedlist" type="1">
 193 <li class="listitem">
 194 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">&gt;</span>
 195   <span class="identifier">record</span> <a name="idp61296784-bb"></a><span class="identifier">open_record_with_channel_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="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span> ch<span class="special">)</span><span class="special">;</span></pre>The <code class="computeroutput">open_record</code> implementation for the case when the channel is specified in log statement. </li>
 196 <li class="listitem">
 197 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span>
 198   <span class="identifier">record</span> <a name="idp61301232-bb"></a><span class="identifier">open_record_with_channel_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>
 199                                            <span class="identifier">parameter</span><span class="special">::</span><span class="identifier">void_</span><span class="special">)</span><span class="special">;</span></pre>The <code class="computeroutput">open_record</code> implementation for the case when the channel is not specified in log statement. </li>
 200 </ol></div>
 201 </div>
 202 </div>
 203 </div>
 204 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 205 <td align="left"></td>
 206 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 207         Distributed under the Boost Software License, Version 1.0. (See accompanying
 208         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>).
 209       </p>
 210 </div></td>
 211 </tr></table>
 212 <hr>
 213 <div class="spirit-nav">
 214 <a accesskey="p" href="../../../BOOST_LOG_DECLARE_WLOGGER_MT.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../logging_sources.html#header.boost.log.sources.channel_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="basic_channel_logger/make_default_channel_name.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 215 </div>
 216 </body>
 217 </html>