libs/log/doc/html/boost/log/register_sink__idp40286112.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template register_sink_factory</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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="register_sink__idp40280352.html" title="Function template register_sink_factory">
  10 <link rel="next" href="register_sink__idp40292016.html" title="Function template register_sink_factory">
  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="register_sink__idp40280352.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="register_sink__idp40292016.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.register_sink__idp40286112"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Function template register_sink_factory</span></h2>
  22 <p>boost::log::register_sink_factory &#8212; The function registers a factory for a custom sink. </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>
  28 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FactoryT<span class="special">&gt;</span>
  29   <span class="identifier">enable_if</span><span class="special">&lt;</span> <span class="identifier">is_base_and_derived</span><span class="special">&lt;</span> <a class="link" href="sink_factory.html" title="Struct template sink_factory">sink_factory</a><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">FactoryT</span><span class="special">::</span><span class="identifier">char_type</span> <span class="special">&gt;</span><span class="special">,</span> <span class="identifier">FactoryT</span> <span class="special">&gt;&gt;</span><span class="special">::</span><span class="identifier">type</span>
  30   <span class="identifier">register_sink_factory</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> sink_name<span class="special">,</span>
  31                         <span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">FactoryT</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> factory<span class="special">)</span><span class="special">;</span></pre></div>
  32 <div class="refsect1">
  33 <a name="idp118338624"></a><h2>Description</h2>
  34 <p>The function registers a factory for a sink. The factory will be called to create sink instance when the parser discovers the specified sink type in the settings file. The factory must accept a map of parameters [parameter name -&gt; parameter value] that it may use to initialize the sink. The factory must return a non-NULL pointer to the constructed sink instance.</p>
  35 <p>
  36 </p>
  37 <div class="variablelist"><table border="0" class="variablelist compact">
  38 <colgroup>
  39 <col align="left" valign="top">
  40 <col>
  41 </colgroup>
  42 <tbody><tr>
  43 <td><p><span class="term">Parameters:</span></p></td>
  44 <td><div class="variablelist"><table border="0" class="variablelist compact">
  45 <colgroup>
  46 <col align="left" valign="top">
  47 <col>
  48 </colgroup>
  49 <tbody>
  50 <tr>
  51 <td><p><span class="term"><code class="computeroutput">factory</code></span></p></td>
  52 <td><p>Pointer to the custom sink factory. Must not be NULL. </p></td>
  53 </tr>
  54 <tr>
  55 <td><p><span class="term"><code class="computeroutput">sink_name</code></span></p></td>
  56 <td><p>The custom sink name. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td>
  57 </tr>
  58 </tbody>
  59 </table></div></td>
  60 </tr></tbody>
  61 </table></div>
  62 </div>
  63 </div>
  64 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  65 <td align="left"></td>
  66 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2014 Andrey Semashev<p>
  67         Distributed under the Boost Software License, Version 1.0. (See accompanying
  68         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>).
  69       </p>
  70 </div></td>
  71 </tr></table>
  72 <hr>
  73 <div class="spirit-nav">
  74 <a accesskey="p" href="register_sink__idp40280352.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="register_sink__idp40292016.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  75 </div>
  76 </body>
  77 </html>