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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template channel</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="basic_channel_logger/make_default_channel_name.html" title="Struct make_default_channel_name">
  10 <link rel="next" href="channel/apply.html" title="Struct template apply">
  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="basic_channel_logger/make_default_channel_name.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="channel/apply.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sources.channel"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Struct template channel</span></h2>
  22 <p>boost::log::sources::channel &#8212; Channel support feature. </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> ChannelT <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">&gt;</span>
  28 <span class="keyword">struct</span> <a class="link" href="channel.html" title="Struct template channel">channel</a> <span class="special">{</span>
  29   <span class="comment">// member classes/structs/unions</span>
  30   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BaseT<span class="special">&gt;</span>
  31   <span class="keyword">struct</span> <a class="link" href="channel/apply.html" title="Struct template apply">apply</a> <span class="special">{</span>
  32     <span class="comment">// types</span>
  33     <span class="keyword">typedef</span> <a class="link" href="basic_channel_logger.html" title="Class template basic_channel_logger">basic_channel_logger</a><span class="special">&lt;</span> <span class="identifier">BaseT</span><span class="special">,</span> <span class="identifier">ChannelT</span> <span class="special">&gt;</span> <a class="link" href="channel/apply.html#boost.log.sources.channel.apply.type"><span class="identifier">type</span></a><span class="special">;</span>
  34   <span class="special">}</span><span class="special">;</span>
  35 <span class="special">}</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idm45554738838704"></a><h2>Description</h2>
  38 <p>The logger with this feature automatically registers an attribute with the specified on construction value, which is a channel name. The channel name can be modified through the logger life time, either by calling the <code class="computeroutput">channel</code> method or by specifying the name in the logging statement.</p>
  39 <p>The type of the channel name can be customized by providing it as a template parameter to the feature template. By default, a string will be used. </p>
  40 </div>
  41 </div>
  42 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  43 <td align="left"></td>
  44 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  45         Distributed under the Boost Software License, Version 1.0. (See accompanying
  46         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>).
  47       </p>
  48 </div></td>
  49 </tr></table>
  50 <hr>
  51 <div class="spirit-nav">
  52 <a accesskey="p" href="basic_channel_logger/make_default_channel_name.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="channel/apply.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  53 </div>
  54 </body>
  55 </html>