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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_formatting_sink_frontend</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.basic_sink_frontend_hpp" title="Header &lt;boost/log/sinks/basic_sink_frontend.hpp&gt;">
   9 <link rel="prev" href="basic_sink_frontend.html" title="Class basic_sink_frontend">
  10 <link rel="next" href="basic_formatti_idp64489728/formatting_context.html" title="Struct formatting_context">
  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="basic_sink_frontend.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.basic_sink_frontend_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_formatti_idp64489728/formatting_context.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.basic_formatti_idp64489728"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template basic_formatting_sink_frontend</span></h2>
  22 <p>boost::log::sinks::basic_formatting_sink_frontend &#8212; A base class for a logging sink frontend with formatting support. </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.basic_sink_frontend_hpp" title="Header &lt;boost/log/sinks/basic_sink_frontend.hpp&gt;">boost/log/sinks/basic_sink_frontend.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="basic_formatti_idp64489728.html" title="Class template basic_formatting_sink_frontend">basic_formatting_sink_frontend</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">basic_sink_frontend</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">CharT</span>                          <a name="boost.log.sinks.basic_formatti_idp64489728.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">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_formatti_idp64489728.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>     <span class="comment">// Formatted string type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">basic_formatter</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span>   <a name="boost.log.sinks.basic_formatti_idp64489728.formatter_type"></a><span class="identifier">formatter_type</span><span class="special">;</span>  <span class="comment">// Formatter function object type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">formatter_type</span><span class="special">::</span><span class="identifier">stream_type</span>    <a name="boost.log.sinks.basic_formatti_idp64489728.stream_type"></a><span class="identifier">stream_type</span><span class="special">;</span>     <span class="comment">// Output stream type. </span>
  35
  36   <span class="comment">// member classes/structs/unions</span>
  37
  38   <span class="keyword">struct</span> <a class="link" href="basic_formatti_idp64489728/formatting_context.html" title="Struct formatting_context">formatting_context</a> <span class="special">{</span>
  39     <span class="comment">// member classes/structs/unions</span>
  40
  41     <span class="keyword">class</span> <a class="link" href="basic_formatti_idp64489728/formatting_context/cleanup_guard.html" title="Class cleanup_guard">cleanup_guard</a> <span class="special">{</span>
  42     <span class="keyword">public</span><span class="special">:</span>
  43       <span class="comment">// <a class="link" href="basic_formatti_idp64489728/formatting_context/cleanup_guard.html#boost.log.sinks.basic_formatti_idp64489728.formatting_context.cleanup_guardconstruct-copy-destruct">construct/copy/destruct</a></span>
  44       <span class="keyword">explicit</span> <a class="link" href="basic_formatti_idp64489728/formatting_context/cleanup_guard.html#idp64493408-bb"><span class="identifier">cleanup_guard</span></a><span class="special">(</span><span class="identifier">formatting_context</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  45       <a class="link" href="basic_formatti_idp64489728/formatting_context/cleanup_guard.html#idp64495216-bb"><span class="identifier">cleanup_guard</span></a><span class="special">(</span><span class="identifier">cleanup_guard</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  46       <span class="identifier">cleanup_guard</span> <span class="special">&amp;</span> <a class="link" href="basic_formatti_idp64489728/formatting_context/cleanup_guard.html#idp64496464-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">cleanup_guard</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  47       <a class="link" href="basic_formatti_idp64489728/formatting_context/cleanup_guard.html#idp64494928-bb"><span class="special">~</span><span class="identifier">cleanup_guard</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48     <span class="special">}</span><span class="special">;</span>
  49     <span class="comment">// <a class="link" href="basic_formatti_idp64489728/formatting_context.html#boost.log.sinks.basic_formatti_idp64489728.formatting_contextconstruct-copy-destruct">construct/copy/destruct</a></span>
  50     <a class="link" href="basic_formatti_idp64489728/formatting_context.html#idp64503280-bb"><span class="identifier">formatting_context</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51     <a class="link" href="basic_formatti_idp64489728/formatting_context.html#idp64503568-bb"><span class="identifier">formatting_context</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</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>
  52                        <span class="identifier">formatter_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  53
  54     <span class="comment">// public data members</span>
  55     <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">m_Version</span><span class="special">;</span>    <span class="comment">// Object version. </span>
  56     <span class="identifier">string_type</span> <span class="identifier">m_FormattedRecord</span><span class="special">;</span>    <span class="comment">// Formatted log record storage. </span>
  57     <span class="identifier">stream_type</span> <span class="identifier">m_FormattingStream</span><span class="special">;</span>    <span class="comment">// Formatting stream. </span>
  58     <span class="identifier">formatter_type</span> <span class="identifier">m_Formatter</span><span class="special">;</span>    <span class="comment">// Formatter functor. </span>
  59   <span class="special">}</span><span class="special">;</span>
  60
  61   <span class="comment">// <a class="link" href="basic_formatti_idp64489728.html#boost.log.sinks.basic_formatti_idp64489728construct-copy-destruct">construct/copy/destruct</a></span>
  62   <span class="keyword">explicit</span> <a class="link" href="basic_formatti_idp64489728.html#idp64518944-bb"><span class="identifier">basic_formatting_sink_frontend</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
  63
  64   <span class="comment">// <a class="link" href="basic_formatti_idp64489728.html#idp64510528-bb">public member functions</a></span>
  65   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="basic_formatti_idp64489728.html#idp64511088-bb"><span class="identifier">set_formatter</span></a><span class="special">(</span><span class="identifier">FunT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  66   <span class="keyword">void</span> <a class="link" href="basic_formatti_idp64489728.html#idp64513936-bb"><span class="identifier">reset_formatter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  67   <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <a class="link" href="basic_formatti_idp64489728.html#idp64515216-bb"><span class="identifier">getloc</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  68   <span class="keyword">void</span> <a class="link" href="basic_formatti_idp64489728.html#idp64516800-bb"><span class="identifier">imbue</span></a><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="special">;</span>
  69
  70   <span class="comment">// <a class="link" href="basic_formatti_idp64489728.html#idp64521392-bb">protected member functions</a></span>
  71   <span class="identifier">formatter_type</span> <span class="special">&amp;</span> <a class="link" href="basic_formatti_idp64489728.html#idp64521968-bb"><span class="identifier">formatter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  72   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BackendMutexT<span class="special">,</span> <span class="keyword">typename</span> BackendT<span class="special">&gt;</span>
  73     <span class="keyword">void</span> <a class="link" href="basic_formatti_idp64489728.html#idp64523120-bb"><span class="identifier">feed_record</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">BackendMutexT</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">BackendT</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  74   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BackendMutexT<span class="special">,</span> <span class="keyword">typename</span> BackendT<span class="special">&gt;</span>
  75     <span class="keyword">bool</span> <a class="link" href="basic_formatti_idp64489728.html#idp64527744-bb"><span class="identifier">try_feed_record</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">BackendMutexT</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">BackendT</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  76 <span class="special">}</span><span class="special">;</span></pre></div>
  77 <div class="refsect1">
  78 <a name="idp124715040"></a><h2>Description</h2>
  79 <div class="refsect2">
  80 <a name="idp124715456"></a><h3>
  81 <a name="boost.log.sinks.basic_formatti_idp64489728construct-copy-destruct"></a><code class="computeroutput">basic_formatting_sink_frontend</code>
  82         public
  83        construct/copy/destruct</h3>
  84 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  85 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp64518944-bb"></a><span class="identifier">basic_formatting_sink_frontend</span><span class="special">(</span><span class="keyword">bool</span> cross_thread<span class="special">)</span><span class="special">;</span></pre>Initializing constructor. <p>
  86 </p>
  87 <div class="variablelist"><table border="0" class="variablelist compact">
  88 <colgroup>
  89 <col align="left" valign="top">
  90 <col>
  91 </colgroup>
  92 <tbody><tr>
  93 <td><p><span class="term">Parameters:</span></p></td>
  94 <td><div class="variablelist"><table border="0" class="variablelist compact">
  95 <colgroup>
  96 <col align="left" valign="top">
  97 <col>
  98 </colgroup>
  99 <tbody><tr>
 100 <td><p><span class="term"><code class="computeroutput">cross_thread</code></span></p></td>
 101 <td><p>The flag indicates whether the sink passes log records between different threads </p></td>
 102 </tr></tbody>
 103 </table></div></td>
 104 </tr></tbody>
 105 </table></div>
 106 </li></ol></div>
 107 </div>
 108 <div class="refsect2">
 109 <a name="idp124726240"></a><h3>
 110 <a name="idp64510528-bb"></a><code class="computeroutput">basic_formatting_sink_frontend</code> public member functions</h3>
 111 <div class="orderedlist"><ol class="orderedlist" type="1">
 112 <li class="listitem">
 113 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp64511088-bb"></a><span class="identifier">set_formatter</span><span class="special">(</span><span class="identifier">FunT</span> <span class="keyword">const</span> <span class="special">&amp;</span> formatter<span class="special">)</span><span class="special">;</span></pre>
 114 <p>The method sets sink-specific formatter function object </p>
 115 </li>
 116 <li class="listitem">
 117 <pre class="literallayout"><span class="keyword">void</span> <a name="idp64513936-bb"></a><span class="identifier">reset_formatter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 118 <p>The method resets the formatter </p>
 119 </li>
 120 <li class="listitem">
 121 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <a name="idp64515216-bb"></a><span class="identifier">getloc</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 122 <p>The method returns the current locale used for formatting </p>
 123 </li>
 124 <li class="listitem">
 125 <pre class="literallayout"><span class="keyword">void</span> <a name="idp64516800-bb"></a><span class="identifier">imbue</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> loc<span class="special">)</span><span class="special">;</span></pre>
 126 <p>The method sets the locale used for formatting </p>
 127 </li>
 128 </ol></div>
 129 </div>
 130 <div class="refsect2">
 131 <a name="idp124756304"></a><h3>
 132 <a name="idp64521392-bb"></a><code class="computeroutput">basic_formatting_sink_frontend</code> protected member functions</h3>
 133 <div class="orderedlist"><ol class="orderedlist" type="1">
 134 <li class="listitem">
 135 <pre class="literallayout"><span class="identifier">formatter_type</span> <span class="special">&amp;</span> <a name="idp64521968-bb"></a><span class="identifier">formatter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns reference to the formatter. </li>
 136 <li class="listitem">
 137 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BackendMutexT<span class="special">,</span> <span class="keyword">typename</span> BackendT<span class="special">&gt;</span>
 138   <span class="keyword">void</span> <a name="idp64523120-bb"></a><span class="identifier">feed_record</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">BackendMutexT</span> <span class="special">&amp;</span> backend_mutex<span class="special">,</span>
 139                    <span class="identifier">BackendT</span> <span class="special">&amp;</span> backend<span class="special">)</span><span class="special">;</span></pre>Feeds log record to the backend. </li>
 140 <li class="listitem">
 141 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BackendMutexT<span class="special">,</span> <span class="keyword">typename</span> BackendT<span class="special">&gt;</span>
 142   <span class="keyword">bool</span> <a name="idp64527744-bb"></a><span class="identifier">try_feed_record</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">BackendMutexT</span> <span class="special">&amp;</span> backend_mutex<span class="special">,</span>
 143                        <span class="identifier">BackendT</span> <span class="special">&amp;</span> backend<span class="special">)</span><span class="special">;</span></pre>Attempts to feeds log record to the backend, does not block if <span class="emphasis"><em>backend_mutex</em></span> is locked. </li>
 144 </ol></div>
 145 </div>
 146 </div>
 147 </div>
 148 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 149 <td align="left"></td>
 150 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 151         Distributed under the Boost Software License, Version 1.0. (See accompanying
 152         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>).
 153       </p>
 154 </div></td>
 155 </tr></table>
 156 <hr>
 157 <div class="spirit-nav">
 158 <a accesskey="p" href="basic_sink_frontend.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.basic_sink_frontend_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_formatti_idp64489728/formatting_context.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 159 </div>
 160 </body>
 161 </html>