libs/log/doc/html/boost/log/sink_factory.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template sink_factory</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="../../utilities.html#header.boost.log.utility.setup.from_settings_hpp" title="Header &lt;boost/log/utility/setup/from_settings.hpp&gt;">
   9 <link rel="prev" href="parse_fo_idm45711342876384.html" title="Function template parse_formatter">
  10 <link rel="next" href="init_from_settings.html" title="Function template init_from_settings">
  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="parse_fo_idm45711342876384.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.setup.from_settings_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="init_from_settings.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sink_factory"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Struct template sink_factory</span></h2>
  22 <p>boost::log::sink_factory</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="../../utilities.html#header.boost.log.utility.setup.from_settings_hpp" title="Header &lt;boost/log/utility/setup/from_settings.hpp&gt;">boost/log/utility/setup/from_settings.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">struct</span> <a class="link" href="sink_factory.html" title="Struct template sink_factory">sink_factory</a> <span class="special">{</span>
  29   <span class="comment">// types</span>
  30   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                               <a name="boost.log.sink_factory.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>         <span class="comment">// Character type. </span>
  31   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span>      <a name="boost.log.sink_factory.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>       <span class="comment">// String type. </span>
  32   <span class="keyword">typedef</span> <a class="link" href="basic_settings_section.html" title="Class template basic_settings_section">basic_settings_section</a><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.sink_factory.settings_section"></a><span class="identifier">settings_section</span><span class="special">;</span>  <span class="comment">// Settings section type. </span>
  33
  34   <span class="comment">// <a class="link" href="sink_factory.html#boost.log.sink_factoryconstruct-copy-destruct">construct/copy/destruct</a></span>
  35   <a class="link" href="sink_factory.html#idm45711342855952-bb"><span class="identifier">sink_factory</span></a><span class="special">(</span><a class="link" href="sink_factory.html" title="Struct template sink_factory">sink_factory</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  36   <a class="link" href="sink_factory.html" title="Struct template sink_factory">sink_factory</a> <span class="special">&amp;</span> <a class="link" href="sink_factory.html#idm45711342854416-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="sink_factory.html" title="Struct template sink_factory">sink_factory</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  37   <a class="link" href="sink_factory.html#idm45711342856944-bb"><span class="special">~</span><span class="identifier">sink_factory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  38
  39   <span class="comment">// <a class="link" href="sink_factory.html#idm45711342860944-bb">public member functions</a></span>
  40   <span class="keyword">virtual</span> <span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">sinks</span><span class="special">::</span><span class="identifier">sink</span> <span class="special">&gt;</span> <a class="link" href="sink_factory.html#idm45711342860384-bb"><span class="identifier">create_sink</span></a><span class="special">(</span><span class="identifier">settings_section</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  41 <span class="special">}</span><span class="special">;</span></pre></div>
  42 <div class="refsect1">
  43 <a name="idm45554721411568"></a><h2>Description</h2>
  44 <p>Sink factory base interface </p>
  45 <div class="refsect2">
  46 <a name="idm45554721410848"></a><h3>
  47 <a name="boost.log.sink_factoryconstruct-copy-destruct"></a><code class="computeroutput">sink_factory</code>
  48         public
  49        construct/copy/destruct</h3>
  50 <div class="orderedlist"><ol class="orderedlist" type="1">
  51 <li class="listitem"><pre class="literallayout"><a name="idm45711342855952-bb"></a><span class="identifier">sink_factory</span><span class="special">(</span><a class="link" href="sink_factory.html" title="Struct template sink_factory">sink_factory</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  52 <li class="listitem"><pre class="literallayout"><a class="link" href="sink_factory.html" title="Struct template sink_factory">sink_factory</a> <span class="special">&amp;</span> <a name="idm45711342854416-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="sink_factory.html" title="Struct template sink_factory">sink_factory</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  53 <li class="listitem">
  54 <pre class="literallayout"><a name="idm45711342856944-bb"></a><span class="special">~</span><span class="identifier">sink_factory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  55 <p>Default constructor</p>
  56 <p>Virtual destructor </p>
  57 </li>
  58 </ol></div>
  59 </div>
  60 <div class="refsect2">
  61 <a name="idm45554721387904"></a><h3>
  62 <a name="idm45711342860944-bb"></a><code class="computeroutput">sink_factory</code> public member functions</h3>
  63 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  64 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">sinks</span><span class="special">::</span><span class="identifier">sink</span> <span class="special">&gt;</span>
  65 <a name="idm45711342860384-bb"></a><span class="identifier">create_sink</span><span class="special">(</span><span class="identifier">settings_section</span> <span class="keyword">const</span> <span class="special">&amp;</span> settings<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre>
  66 <p>The function creates a formatter for the specified attribute.</p>
  67 <p>
  68 </p>
  69 <div class="variablelist"><table border="0" class="variablelist compact">
  70 <colgroup>
  71 <col align="left" valign="top">
  72 <col>
  73 </colgroup>
  74 <tbody><tr>
  75 <td><p><span class="term">Parameters:</span></p></td>
  76 <td><div class="variablelist"><table border="0" class="variablelist compact">
  77 <colgroup>
  78 <col align="left" valign="top">
  79 <col>
  80 </colgroup>
  81 <tbody><tr>
  82 <td><p><span class="term"><code class="computeroutput">settings</code></span></p></td>
  83 <td><p>Sink parameters </p></td>
  84 </tr></tbody>
  85 </table></div></td>
  86 </tr></tbody>
  87 </table></div>
  88 </li></ol></div>
  89 </div>
  90 </div>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  95         Distributed under the Boost Software License, Version 1.0. (See accompanying
  96         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>).
  97       </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="parse_fo_idm45711342876384.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.setup.from_settings_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="init_from_settings.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>