libs/log/doc/html/boost/log/sinks/text_multifile_backend.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class text_multifile_backend</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="../../../sinks.html#header.boost.log.sinks.text_multifile_backend_hpp" title="Header &lt;boost/log/sinks/text_multifile_backend.hpp&gt;">
   9 <link rel="prev" href="file/as_file_name_composer.html" title="Function template as_file_name_composer">
  10 <link rel="next" href="basic_text_ostream_backend.html" title="Class template basic_text_ostream_backend">
  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="file/as_file_name_composer.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.text_multifile_backend_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_text_ostream_backend.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.text_multifile_backend"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class text_multifile_backend</span></h2>
  22 <p>boost::log::sinks::text_multifile_backend &#8212; An implementation of a text multiple files logging sink backend. </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="../../../sinks.html#header.boost.log.sinks.text_multifile_backend_hpp" title="Header &lt;boost/log/sinks/text_multifile_backend.hpp&gt;">boost/log/sinks/text_multifile_backend.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">class</span> <a class="link" href="text_multifile_backend.html" title="Class text_multifile_backend">text_multifile_backend</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">basic_formatted_sink_backend</span><span class="special">&lt;</span> <span class="keyword">char</span> <span class="special">&gt;</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.sinks.text_multifile_backend.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">string_type</span> <a name="boost.log.sinks.text_multifile_backend.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>              <span class="comment">// String type to be used as a message text holder. </span>
  33   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>            <a name="boost.log.sinks.text_multifile_backend.file_name_composer_type"></a><span class="identifier">file_name_composer_type</span><span class="special">;</span>  <span class="comment">// File name composer functor type. </span>
  34
  35   <span class="comment">// <a class="link" href="text_multifile_backend.html#boost.log.sinks.text_multifile_backendconstruct-copy-destruct">construct/copy/destruct</a></span>
  36   <a class="link" href="text_multifile_backend.html#idm45711345529792-bb"><span class="identifier">text_multifile_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  37   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span><span class="special">...</span> ArgsT<span class="special">&gt;</span>
  38     <span class="keyword">explicit</span> <a class="link" href="text_multifile_backend.html#idm45711345528944-bb"><span class="identifier">text_multifile_backend</span></a><span class="special">(</span><span class="identifier">ArgsT</span><span class="special">...</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="text_multifile_backend.html#idm45711345523472-bb"><span class="special">~</span><span class="identifier">text_multifile_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="text_multifile_backend.html#idm45711345540016-bb">public member functions</a></span>
  42   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ComposerT<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="text_multifile_backend.html#idm45711345539456-bb"><span class="identifier">set_file_name_composer</span></a><span class="special">(</span><span class="identifier">ComposerT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  43   <span class="keyword">void</span> <a class="link" href="text_multifile_backend.html#idm45711345535856-bb"><span class="identifier">set_auto_newline_mode</span></a><span class="special">(</span><span class="identifier">auto_newline_mode</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">void</span> <a class="link" href="text_multifile_backend.html#idm45711345532624-bb"><span class="identifier">consume</span></a><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idm45554730943248"></a><h2>Description</h2>
  48 <p>The sink backend puts formatted log records to one of the text files. The particular file is chosen upon each record's attribute values, which allows to distribute records into individual files or to group records related to some entity or process in a separate file. </p>
  49 <div class="refsect2">
  50 <a name="idm45554730942288"></a><h3>
  51 <a name="boost.log.sinks.text_multifile_backendconstruct-copy-destruct"></a><code class="computeroutput">text_multifile_backend</code>
  52         public
  53        construct/copy/destruct</h3>
  54 <div class="orderedlist"><ol class="orderedlist" type="1">
  55 <li class="listitem">
  56 <pre class="literallayout"><a name="idm45711345529792-bb"></a><span class="identifier">text_multifile_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  57 <p>Default constructor. The constructed sink backend has no file name composer and thus will not write any files. All other parameters are set to their defaults. </p>
  58 </li>
  59 <li class="listitem">
  60 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span><span class="special">...</span> ArgsT<span class="special">&gt;</span>
  61   <span class="keyword">explicit</span> <a name="idm45711345528944-bb"></a><span class="identifier">text_multifile_backend</span><span class="special">(</span><span class="identifier">ArgsT</span><span class="special">...</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre>
  62 <p>Constructor. Creates a sink backend with the specified named parameters. The following named parameters are supported:</p>
  63 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="computeroutput">auto_newline_mode</code> - Specifies automatic trailing newline insertion mode. Must be a value of the <code class="computeroutput">auto_newline_mode</code> enum. By default, is <code class="computeroutput">auto_newline_mode::insert_if_missing</code>. </p></li></ul></div>
  64 <p>
  65 </p>
  66 </li>
  67 <li class="listitem">
  68 <pre class="literallayout"><a name="idm45711345523472-bb"></a><span class="special">~</span><span class="identifier">text_multifile_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  69 <p>Destructor </p>
  70 </li>
  71 </ol></div>
  72 </div>
  73 <div class="refsect2">
  74 <a name="idm45554730918016"></a><h3>
  75 <a name="idm45711345540016-bb"></a><code class="computeroutput">text_multifile_backend</code> public member functions</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1">
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ComposerT<span class="special">&gt;</span>
  79   <span class="keyword">void</span> <a name="idm45711345539456-bb"></a><span class="identifier">set_file_name_composer</span><span class="special">(</span><span class="identifier">ComposerT</span> <span class="keyword">const</span> <span class="special">&amp;</span> composer<span class="special">)</span><span class="special">;</span></pre>
  80 <p>The method sets file name composer functional object. Log record formatters are accepted, too.</p>
  81 <p>
  82 </p>
  83 <div class="variablelist"><table border="0" class="variablelist compact">
  84 <colgroup>
  85 <col align="left" valign="top">
  86 <col>
  87 </colgroup>
  88 <tbody><tr>
  89 <td><p><span class="term">Parameters:</span></p></td>
  90 <td><div class="variablelist"><table border="0" class="variablelist compact">
  91 <colgroup>
  92 <col align="left" valign="top">
  93 <col>
  94 </colgroup>
  95 <tbody><tr>
  96 <td><p><span class="term"><code class="computeroutput">composer</code></span></p></td>
  97 <td><p>File name composer functor </p></td>
  98 </tr></tbody>
  99 </table></div></td>
 100 </tr></tbody>
 101 </table></div>
 102 </li>
 103 <li class="listitem">
 104 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711345535856-bb"></a><span class="identifier">set_auto_newline_mode</span><span class="special">(</span><span class="identifier">auto_newline_mode</span> mode<span class="special">)</span><span class="special">;</span></pre>
 105 <p>Selects whether a trailing newline should be automatically inserted after every log record. See <code class="computeroutput">auto_newline_mode</code> description for the possible modes of operation.</p>
 106 <p>
 107 </p>
 108 <div class="variablelist"><table border="0" class="variablelist compact">
 109 <colgroup>
 110 <col align="left" valign="top">
 111 <col>
 112 </colgroup>
 113 <tbody><tr>
 114 <td><p><span class="term">Parameters:</span></p></td>
 115 <td><div class="variablelist"><table border="0" class="variablelist compact">
 116 <colgroup>
 117 <col align="left" valign="top">
 118 <col>
 119 </colgroup>
 120 <tbody><tr>
 121 <td><p><span class="term"><code class="computeroutput">mode</code></span></p></td>
 122 <td><p>The trailing newline insertion mode. </p></td>
 123 </tr></tbody>
 124 </table></div></td>
 125 </tr></tbody>
 126 </table></div>
 127 </li>
 128 <li class="listitem">
 129 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711345532624-bb"></a><span class="identifier">consume</span><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span> rec<span class="special">,</span> <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> formatted_message<span class="special">)</span><span class="special">;</span></pre>
 130 <p>The method writes the message to the sink </p>
 131 </li>
 132 </ol></div>
 133 </div>
 134 </div>
 135 </div>
 136 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 137 <td align="left"></td>
 138 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 139         Distributed under the Boost Software License, Version 1.0. (See accompanying
 140         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>).
 141       </p>
 142 </div></td>
 143 </tr></table>
 144 <hr>
 145 <div class="spirit-nav">
 146 <a accesskey="p" href="file/as_file_name_composer.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.text_multifile_backend_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_text_ostream_backend.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 147 </div>
 148 </body>
 149 </html>