blob: b54857054be697fb33669a01134f62e1a3b2984f [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template file_name_composer_adapter</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
<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;">
<link rel="prev" href="../text_file_backend.html" title="Class text_file_backend">
<link rel="next" href="as_file_name_composer.html" title="Function template as_file_name_composer">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../text_file_backend.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>
</div>
<div class="refentry">
<a name="boost.log.sinks.file.file_name_composer_adapter"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template file_name_composer_adapter</span></h2>
<p>boost::log::sinks::file::file_name_composer_adapter</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<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;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FormatterT<span class="special">&gt;</span>
<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>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<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>
<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>
<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>
<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>
<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>
<span class="keyword">explicit</span> <a class="link" href="file_name_composer_adapter.html#idp44942224-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>
<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>
<a class="link" href="file_name_composer_adapter.html#idp44944880-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>
<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#idp44946576-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>
<span class="comment">// <a class="link" href="file_name_composer_adapter.html#idp44939232-bb">public member functions</a></span>
<span class="identifier">result_type</span> <a class="link" href="file_name_composer_adapter.html#idp44939792-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>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp126681568"></a><h2>Description</h2>
<p>An adapter class that allows to use regular formatters as file name generators. </p>
<div class="refsect2">
<a name="idp126682240"></a><h3>
<a name="boost.log.sinks.file.file_name_composer_adapterconstruct-copy-destruct"></a><code class="computeroutput">file_name_composer_adapter</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp44942224-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>
<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>
<p>Initializing constructor </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp44944880-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>
<p>Copy constructor </p>
</li>
<li class="listitem">
<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>
<a name="idp44946576-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>
<p>Assignment </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp126712976"></a><h3>
<a name="idp44939232-bb"></a><code class="computeroutput">file_name_composer_adapter</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp44939792-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>
<p>The operator generates a file name based on the log record </p>
</li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2007-2015 Andrey
Semashev<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>).
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../text_file_backend.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>
</div>
</body>
</html>