libs/log/doc/html/boost/log/sinks/file/file_name_composer_adapter.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template file_name_composer_adapter</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="../text_ipc_idm45711345576928.html" title="Class template text_ipc_message_queue_backend">
  10 <link rel="next" href="as_file_name_composer.html" title="Function template as_file_name_composer">
  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="../text_ipc_idm45711345576928.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="as_file_name_composer.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.file.file_name_composer_adapter"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template file_name_composer_adapter</span></h2>
  22 <p>boost::log::sinks::file::file_name_composer_adapter</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><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FormatterT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="file_name_composer_adapter.html" title="Class template file_name_composer_adapter">file_name_composer_adapter</a> <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">filesystem</span><span class="special">::</span><span class="identifier">path</span>                             <a name="boost.log.sinks.file.file_name_composer_adapter.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>       <span class="comment">// Functor result type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">result_type</span><span class="special">::</span><span class="identifier">string_type</span><span class="special">::</span><span class="identifier">value_type</span>         <a name="boost.log.sinks.file.file_name_composer_adapter.native_char_type"></a><span class="identifier">native_char_type</span><span class="special">;</span>  <span class="comment">// File name character type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">FormatterT</span>                                   <a name="boost.log.sinks.file.file_name_composer_adapter.formatter_type"></a><span class="identifier">formatter_type</span><span class="special">;</span>    <span class="comment">// The adopted formatter type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">basic_formatting_ostream</span><span class="special">&lt;</span> <span class="identifier">native_char_type</span> <span class="special">&gt;</span> <a name="boost.log.sinks.file.file_name_composer_adapter.stream_type"></a><span class="identifier">stream_type</span><span class="special">;</span>       <span class="comment">// Formatting stream type. </span>
  35
  36   <span class="comment">// <a class="link" href="file_name_composer_adapter.html#boost.log.sinks.file.file_name_composer_adapterconstruct-copy-destruct">construct/copy/destruct</a></span>
  37   <span class="keyword">explicit</span> <a class="link" href="file_name_composer_adapter.html#idm45711345512832-bb"><span class="identifier">file_name_composer_adapter</span></a><span class="special">(</span><span class="identifier">formatter_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  38                                       <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="file_name_composer_adapter.html#idm45711345510176-bb"><span class="identifier">file_name_composer_adapter</span></a><span class="special">(</span><a class="link" href="file_name_composer_adapter.html" title="Class template file_name_composer_adapter">file_name_composer_adapter</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="file_name_composer_adapter.html" title="Class template file_name_composer_adapter">file_name_composer_adapter</a> <span class="special">&amp;</span> <a class="link" href="file_name_composer_adapter.html#idm45711345508480-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="file_name_composer_adapter.html" title="Class template file_name_composer_adapter">file_name_composer_adapter</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="file_name_composer_adapter.html#idm45711345515824-bb">public member functions</a></span>
  43   <span class="identifier">result_type</span> <a class="link" href="file_name_composer_adapter.html#idm45711345515264-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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="keyword">const</span><span class="special">;</span>
  44 <span class="special">}</span><span class="special">;</span></pre></div>
  45 <div class="refsect1">
  46 <a name="idm45554731078160"></a><h2>Description</h2>
  47 <p>An adapter class that allows to use regular formatters as file name generators. </p>
  48 <div class="refsect2">
  49 <a name="idm45554731077392"></a><h3>
  50 <a name="boost.log.sinks.file.file_name_composer_adapterconstruct-copy-destruct"></a><code class="computeroutput">file_name_composer_adapter</code>
  51         public
  52        construct/copy/destruct</h3>
  53 <div class="orderedlist"><ol class="orderedlist" type="1">
  54 <li class="listitem">
  55 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711345512832-bb"></a><span class="identifier">file_name_composer_adapter</span><span class="special">(</span><span class="identifier">formatter_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> formatter<span class="special">,</span>
  56                                     <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="keyword">const</span> <span class="special">&amp;</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
  57 <p>Initializing constructor </p>
  58 </li>
  59 <li class="listitem">
  60 <pre class="literallayout"><a name="idm45711345510176-bb"></a><span class="identifier">file_name_composer_adapter</span><span class="special">(</span><a class="link" href="file_name_composer_adapter.html" title="Class template file_name_composer_adapter">file_name_composer_adapter</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  61 <p>Copy constructor </p>
  62 </li>
  63 <li class="listitem">
  64 <pre class="literallayout"><a class="link" href="file_name_composer_adapter.html" title="Class template file_name_composer_adapter">file_name_composer_adapter</a> <span class="special">&amp;</span>
  65 <a name="idm45711345508480-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="file_name_composer_adapter.html" title="Class template file_name_composer_adapter">file_name_composer_adapter</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  66 <p>Assignment </p>
  67 </li>
  68 </ol></div>
  69 </div>
  70 <div class="refsect2">
  71 <a name="idm45554731046592"></a><h3>
  72 <a name="idm45711345515824-bb"></a><code class="computeroutput">file_name_composer_adapter</code> public member functions</h3>
  73 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  74 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45711345515264-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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="keyword">const</span><span class="special">;</span></pre>
  75 <p>The operator generates a file name based on the log record </p>
  76 </li></ol></div>
  77 </div>
  78 </div>
  79 </div>
  80 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  81 <td align="left"></td>
  82 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  83         Distributed under the Boost Software License, Version 1.0. (See accompanying
  84         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>).
  85       </p>
  86 </div></td>
  87 </tr></table>
  88 <hr>
  89 <div class="spirit-nav">
  90 <a accesskey="p" href="../text_ipc_idm45711345576928.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="as_file_name_composer.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  91 </div>
  92 </body>
  93 </html>