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


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct template basic_formatted_sink_backend</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.basic_sink_backend_hpp" title="Header &lt;boost/log/sinks/basic_sink_backend.hpp&gt;">
<link rel="prev" href="basic_sink_backend.html" title="Struct template basic_sink_backend">
<link rel="next" href="basic_sink_frontend.html" title="Class basic_sink_frontend">
</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="basic_sink_backend.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.basic_sink_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_sink_frontend.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.log.sinks.basic_formatte_idp37585568"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template basic_formatted_sink_backend</span></h2>
<p>boost::log::sinks::basic_formatted_sink_backend &#8212; A base class for a logging sink backend with message formatting support. </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.basic_sink_backend_hpp" title="Header &lt;boost/log/sinks/basic_sink_backend.hpp&gt;">boost/log/sinks/basic_sink_backend.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> 
         <span class="keyword">typename</span> FrontendRequirementsT <span class="special">=</span> <a class="link" href="synchronized_feeding.html" title="Struct synchronized_feeding">synchronized_feeding</a><span class="special">&gt;</span> 
<span class="keyword">struct</span> <a class="link" href="basic_formatte_idp37585568.html" title="Struct template basic_formatted_sink_backend">basic_formatted_sink_backend</a> <span class="special">:</span> <span class="keyword">public</span> basic_sink_backend&lt; combine_requirements&lt; FrontendRequirementsT, formatted_records &gt;::type &gt;
<span class="special">{</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <span class="identifier">CharT</span>                            <a name="boost.log.sinks.basic_formatte_idp37585568.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>              <span class="comment">// Character type. </span>
  <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.sinks.basic_formatte_idp37585568.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>            <span class="comment">// Formatted string type. </span>
  <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">frontend_requirements</span> <a name="boost.log.sinks.basic_formatte_idp37585568.frontend_requirements"></a><span class="identifier">frontend_requirements</span><span class="special">;</span>  <span class="comment">// Frontend requirements. </span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp106621296"></a><h2>Description</h2>
<p>The <code class="computeroutput"><a class="link" href="basic_formatte_idp37585568.html" title="Struct template basic_formatted_sink_backend">basic_formatted_sink_backend</a></code> class template indicates to the frontend that the backend requires logging record formatting.</p>
<p>The class allows to request encoding conversion in case if the sink backend requires the formatted string in some particular encoding (e.g. if underlying API supports only narrow or wide characters). In order to perform conversion one should specify the desired final character type in the <code class="computeroutput">TargetCharT</code> template parameter. </p>
</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-2014 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="basic_sink_backend.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.basic_sink_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_sink_frontend.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>