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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class basic_sink_frontend</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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_formatte_idp37585568.html" title="Struct template basic_formatted_sink_backend">
  10 <link rel="next" href="basic_formatti_idp37644816.html" title="Class template basic_formatting_sink_frontend">
  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_formatte_idp37585568.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_idp37644816.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.basic_sink_frontend"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class basic_sink_frontend</span></h2>
  22 <p>boost::log::sinks::basic_sink_frontend &#8212; A base class for a logging sink frontend. </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>
  28 <span class="keyword">class</span> <a class="link" href="basic_sink_frontend.html" title="Class basic_sink_frontend">basic_sink_frontend</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">sink</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">exception_handler_type</span> <a name="boost.log.sinks.basic_sink_frontend.exception_handler_type"></a><span class="identifier">exception_handler_type</span><span class="special">;</span>  <span class="comment">// An exception handler type. </span>
  32
  33   <span class="comment">// <a class="link" href="basic_sink_frontend.html#boost.log.sinks.basic_sink_frontendconstruct-copy-destruct">construct/copy/destruct</a></span>
  34   <span class="keyword">explicit</span> <a class="link" href="basic_sink_frontend.html#idp37613792-bb"><span class="identifier">basic_sink_frontend</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
  35
  36   <span class="comment">// <a class="link" href="basic_sink_frontend.html#idp37601360-bb">public member functions</a></span>
  37   <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_sink_frontend.html#idp37601920-bb"><span class="identifier">set_filter</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>
  38   <span class="keyword">void</span> <a class="link" href="basic_sink_frontend.html#idp37604752-bb"><span class="identifier">reset_filter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  39   <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_sink_frontend.html#idp37606032-bb"><span class="identifier">set_exception_handler</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>
  40   <span class="keyword">void</span> <a class="link" href="basic_sink_frontend.html#idp37608864-bb"><span class="identifier">reset_exception_handler</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  41   <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="basic_sink_frontend.html#idp37610160-bb"><span class="identifier">will_consume</span></a><span class="special">(</span><span class="identifier">attribute_value_set</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="basic_sink_frontend.html#idp37616240-bb">protected member functions</a></span>
  44   <span class="identifier">mutex_type</span> <span class="special">&amp;</span> <a class="link" href="basic_sink_frontend.html#idp37616816-bb"><span class="identifier">frontend_mutex</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45   <span class="identifier">exception_handler_type</span> <span class="special">&amp;</span> <a class="link" href="basic_sink_frontend.html#idp37618256-bb"><span class="identifier">exception_handler</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  46   <span class="identifier">exception_handler_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="basic_sink_frontend.html#idp37619440-bb"><span class="identifier">exception_handler</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <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>
  48     <span class="keyword">void</span> <a class="link" href="basic_sink_frontend.html#idp37620896-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>
  49   <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>
  50     <span class="keyword">bool</span> <a class="link" href="basic_sink_frontend.html#idp37625520-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>
  51   <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>
  52     <span class="keyword">void</span> <a class="link" href="basic_sink_frontend.html#idp37630624-bb"><span class="identifier">flush_backend</span></a><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>
  53
  54   <span class="comment">// <a class="link" href="basic_sink_frontend.html#idp37634752-bb">private member functions</a></span>
  55   <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>
  56     <span class="keyword">void</span> <a class="link" href="basic_sink_frontend.html#idp37635328-bb"><span class="identifier">flush_backend_impl</span></a><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="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span><span class="special">;</span>
  57   <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>
  58     <span class="keyword">void</span> <a class="link" href="basic_sink_frontend.html#idp37639984-bb"><span class="identifier">flush_backend_impl</span></a><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="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span><span class="special">;</span>
  59 <span class="special">}</span><span class="special">;</span></pre></div>
  60 <div class="refsect1">
  61 <a name="idp106777552"></a><h2>Description</h2>
  62 <div class="refsect2">
  63 <a name="idp106777968"></a><h3>
  64 <a name="boost.log.sinks.basic_sink_frontendconstruct-copy-destruct"></a><code class="computeroutput">basic_sink_frontend</code>
  65         public
  66        construct/copy/destruct</h3>
  67 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  68 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp37613792-bb"></a><span class="identifier">basic_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>
  69 </p>
  70 <div class="variablelist"><table border="0" class="variablelist compact">
  71 <colgroup>
  72 <col align="left" valign="top">
  73 <col>
  74 </colgroup>
  75 <tbody><tr>
  76 <td><p><span class="term">Parameters:</span></p></td>
  77 <td><div class="variablelist"><table border="0" class="variablelist compact">
  78 <colgroup>
  79 <col align="left" valign="top">
  80 <col>
  81 </colgroup>
  82 <tbody><tr>
  83 <td><p><span class="term"><code class="computeroutput">cross_thread</code></span></p></td>
  84 <td><p>The flag indicates whether the sink passes log records between different threads </p></td>
  85 </tr></tbody>
  86 </table></div></td>
  87 </tr></tbody>
  88 </table></div>
  89 </li></ol></div>
  90 </div>
  91 <div class="refsect2">
  92 <a name="idp106788864"></a><h3>
  93 <a name="idp37601360-bb"></a><code class="computeroutput">basic_sink_frontend</code> public member functions</h3>
  94 <div class="orderedlist"><ol class="orderedlist" type="1">
  95 <li class="listitem">
  96 <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="idp37601920-bb"></a><span class="identifier">set_filter</span><span class="special">(</span><span class="identifier">FunT</span> <span class="keyword">const</span> <span class="special">&amp;</span> filter<span class="special">)</span><span class="special">;</span></pre>
  97 <p>The method sets sink-specific filter functional object </p>
  98 </li>
  99 <li class="listitem">
 100 <pre class="literallayout"><span class="keyword">void</span> <a name="idp37604752-bb"></a><span class="identifier">reset_filter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 101 <p>The method resets the filter </p>
 102 </li>
 103 <li class="listitem">
 104 <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="idp37606032-bb"></a><span class="identifier">set_exception_handler</span><span class="special">(</span><span class="identifier">FunT</span> <span class="keyword">const</span> <span class="special">&amp;</span> handler<span class="special">)</span><span class="special">;</span></pre>
 105 <p>The method sets an exception handler function </p>
 106 </li>
 107 <li class="listitem">
 108 <pre class="literallayout"><span class="keyword">void</span> <a name="idp37608864-bb"></a><span class="identifier">reset_exception_handler</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 109 <p>The method resets the exception handler function </p>
 110 </li>
 111 <li class="listitem">
 112 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp37610160-bb"></a><span class="identifier">will_consume</span><span class="special">(</span><span class="identifier">attribute_value_set</span> <span class="keyword">const</span> <span class="special">&amp;</span> attrs<span class="special">)</span><span class="special">;</span></pre>
 113 <p>The method returns <code class="computeroutput">true</code> if no filter is set or the attribute values pass the filter</p>
 114 <p>
 115 </p>
 116 <div class="variablelist"><table border="0" class="variablelist compact">
 117 <colgroup>
 118 <col align="left" valign="top">
 119 <col>
 120 </colgroup>
 121 <tbody><tr>
 122 <td><p><span class="term">Parameters:</span></p></td>
 123 <td><div class="variablelist"><table border="0" class="variablelist compact">
 124 <colgroup>
 125 <col align="left" valign="top">
 126 <col>
 127 </colgroup>
 128 <tbody><tr>
 129 <td><p><span class="term"><code class="computeroutput">attrs</code></span></p></td>
 130 <td><p>A set of attribute values of a logging record </p></td>
 131 </tr></tbody>
 132 </table></div></td>
 133 </tr></tbody>
 134 </table></div>
 135 </li>
 136 </ol></div>
 137 </div>
 138 <div class="refsect2">
 139 <a name="idp106830128"></a><h3>
 140 <a name="idp37616240-bb"></a><code class="computeroutput">basic_sink_frontend</code> protected member functions</h3>
 141 <div class="orderedlist"><ol class="orderedlist" type="1">
 142 <li class="listitem">
 143 <pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">&amp;</span> <a name="idp37616816-bb"></a><span class="identifier">frontend_mutex</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns reference to the frontend mutex. </li>
 144 <li class="listitem">
 145 <pre class="literallayout"><span class="identifier">exception_handler_type</span> <span class="special">&amp;</span> <a name="idp37618256-bb"></a><span class="identifier">exception_handler</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns reference to the exception handler. </li>
 146 <li class="listitem">
 147 <pre class="literallayout"><span class="identifier">exception_handler_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp37619440-bb"></a><span class="identifier">exception_handler</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns reference to the exception handler. </li>
 148 <li class="listitem">
 149 <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>
 150   <span class="keyword">void</span> <a name="idp37620896-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>
 151                    <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>
 152 <li class="listitem">
 153 <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>
 154   <span class="keyword">bool</span> <a name="idp37625520-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>
 155                        <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>
 156 <li class="listitem">
 157 <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>
 158   <span class="keyword">void</span> <a name="idp37630624-bb"></a><span class="identifier">flush_backend</span><span class="special">(</span><span class="identifier">BackendMutexT</span> <span class="special">&amp;</span> backend_mutex<span class="special">,</span> <span class="identifier">BackendT</span> <span class="special">&amp;</span> backend<span class="special">)</span><span class="special">;</span></pre>Flushes record buffers in the backend, if one supports it. </li>
 159 </ol></div>
 160 </div>
 161 <div class="refsect2">
 162 <a name="idp106891392"></a><h3>
 163 <a name="idp37634752-bb"></a><code class="computeroutput">basic_sink_frontend</code> private member functions</h3>
 164 <div class="orderedlist"><ol class="orderedlist" type="1">
 165 <li class="listitem">
 166 <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>
 167   <span class="keyword">void</span> <a name="idp37635328-bb"></a><span class="identifier">flush_backend_impl</span><span class="special">(</span><span class="identifier">BackendMutexT</span> <span class="special">&amp;</span> backend_mutex<span class="special">,</span> <span class="identifier">BackendT</span> <span class="special">&amp;</span> backend<span class="special">,</span>
 168                           <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span><span class="special">;</span></pre>Flushes record buffers in the backend (the actual implementation) </li>
 169 <li class="listitem">
 170 <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>
 171   <span class="keyword">void</span> <a name="idp37639984-bb"></a><span class="identifier">flush_backend_impl</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="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span><span class="special">;</span></pre>Flushes record buffers in the backend (stub for backends that don't support flushing) </li>
 172 </ol></div>
 173 </div>
 174 </div>
 175 </div>
 176 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 177 <td align="left"></td>
 178 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2014 Andrey Semashev<p>
 179         Distributed under the Boost Software License, Version 1.0. (See accompanying
 180         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>).
 181       </p>
 182 </div></td>
 183 </tr></table>
 184 <hr>
 185 <div class="spirit-nav">
 186 <a accesskey="p" href="basic_formatte_idp37585568.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_idp37644816.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 187 </div>
 188 </body>
 189 </html>