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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class sink</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.sink_hpp" title="Header &lt;boost/log/sinks/sink.hpp&gt;">
   9 <link rel="prev" href="../../../BOOST_LO_idm45711345907968.html" title="Macro BOOST_LOG_COMBINE_REQUIREMENTS_LIMIT">
  10 <link rel="next" href="synchronous_sink.html" title="Class template synchronous_sink">
  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="../../../BOOST_LO_idm45711345907968.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.sink_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="synchronous_sink.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.sink"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class sink</span></h2>
  22 <p>boost::log::sinks::sink &#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.sink_hpp" title="Header &lt;boost/log/sinks/sink.hpp&gt;">boost/log/sinks/sink.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">class</span> <a class="link" href="sink.html" title="Class sink">sink</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="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.log.sinks.sink.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="sink.html#boost.log.sinks.sinkconstruct-copy-destruct">construct/copy/destruct</a></span>
  34   <span class="keyword">explicit</span> <a class="link" href="sink.html#idm45711345884992-bb"><span class="identifier">sink</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
  35   <a class="link" href="sink.html#idm45711345882624-bb"><span class="identifier">sink</span></a><span class="special">(</span><a class="link" href="sink.html" title="Class sink">sink</a> <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>
  36   <a class="link" href="sink.html" title="Class sink">sink</a> <span class="special">&amp;</span> <a class="link" href="sink.html#idm45711345881088-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="sink.html" title="Class sink">sink</a> <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>
  37   <a class="link" href="sink.html#idm45711345883328-bb"><span class="special">~</span><span class="identifier">sink</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  38
  39   <span class="comment">// <a class="link" href="sink.html#idm45711345901040-bb">public member functions</a></span>
  40   <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="sink.html#idm45711345900480-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> <span class="number">0</span><span class="special">;</span>
  41   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="sink.html#idm45711345896736-bb"><span class="identifier">consume</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="special">=</span> <span class="number">0</span><span class="special">;</span>
  42   <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="sink.html#idm45711345893488-bb"><span class="identifier">try_consume</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="special">;</span>
  43   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="sink.html#idm45711345888944-bb"><span class="identifier">flush</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  44   <span class="keyword">bool</span> <a class="link" href="sink.html#idm45711345886896-bb"><span class="identifier">is_cross_thread</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idm45554732698736"></a><h2>Description</h2>
  48 <div class="refsect2">
  49 <a name="idm45554732698320"></a><h3>
  50 <a name="boost.log.sinks.sinkconstruct-copy-destruct"></a><code class="computeroutput">sink</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="idm45711345884992-bb"></a><span class="identifier">sink</span><span class="special">(</span><span class="keyword">bool</span> cross_thread<span class="special">)</span><span class="special">;</span></pre>
  56 <p>Default constructor </p>
  57 </li>
  58 <li class="listitem"><pre class="literallayout"><a name="idm45711345882624-bb"></a><span class="identifier">sink</span><span class="special">(</span><a class="link" href="sink.html" title="Class sink">sink</a> <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></pre></li>
  59 <li class="listitem"><pre class="literallayout"><a class="link" href="sink.html" title="Class sink">sink</a> <span class="special">&amp;</span> <a name="idm45711345881088-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="sink.html" title="Class sink">sink</a> <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></pre></li>
  60 <li class="listitem">
  61 <pre class="literallayout"><a name="idm45711345883328-bb"></a><span class="special">~</span><span class="identifier">sink</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  62 <p>Virtual destructor </p>
  63 </li>
  64 </ol></div>
  65 </div>
  66 <div class="refsect2">
  67 <a name="idm45554732670304"></a><h3>
  68 <a name="idm45711345901040-bb"></a><code class="computeroutput">sink</code> public member functions</h3>
  69 <div class="orderedlist"><ol class="orderedlist" type="1">
  70 <li class="listitem">
  71 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idm45711345900480-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> attributes<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre>
  72 <p>The method returns <code class="computeroutput">true</code> if no filter is set or the attribute values pass the filter</p>
  73 <p>
  74 </p>
  75 <div class="variablelist"><table border="0" class="variablelist compact">
  76 <colgroup>
  77 <col align="left" valign="top">
  78 <col>
  79 </colgroup>
  80 <tbody><tr>
  81 <td><p><span class="term">Parameters:</span></p></td>
  82 <td><div class="variablelist"><table border="0" class="variablelist compact">
  83 <colgroup>
  84 <col align="left" valign="top">
  85 <col>
  86 </colgroup>
  87 <tbody><tr>
  88 <td><p><span class="term"><code class="computeroutput">attributes</code></span></p></td>
  89 <td><p>A set of attribute values of a logging record </p></td>
  90 </tr></tbody>
  91 </table></div></td>
  92 </tr></tbody>
  93 </table></div>
  94 </li>
  95 <li class="listitem">
  96 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45711345896736-bb"></a><span class="identifier">consume</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="special">=</span> <span class="number">0</span><span class="special">;</span></pre>
  97 <p>The method puts logging record to the sink</p>
  98 <p>
  99 </p>
 100 <div class="variablelist"><table border="0" class="variablelist compact">
 101 <colgroup>
 102 <col align="left" valign="top">
 103 <col>
 104 </colgroup>
 105 <tbody><tr>
 106 <td><p><span class="term">Parameters:</span></p></td>
 107 <td><div class="variablelist"><table border="0" class="variablelist compact">
 108 <colgroup>
 109 <col align="left" valign="top">
 110 <col>
 111 </colgroup>
 112 <tbody><tr>
 113 <td><p><span class="term"><code class="computeroutput">rec</code></span></p></td>
 114 <td><p>Logging record to consume </p></td>
 115 </tr></tbody>
 116 </table></div></td>
 117 </tr></tbody>
 118 </table></div>
 119 </li>
 120 <li class="listitem">
 121 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idm45711345893488-bb"></a><span class="identifier">try_consume</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="special">;</span></pre>
 122 <p>The method attempts to put logging record to the sink. The method may be used by the core in order to determine the most efficient order of sinks to feed records to in case of heavy contention. Sink implementations may implement try/backoff logic in order to improve overall logging throughput.</p>
 123 <p>
 124
 125 </p>
 126 <div class="variablelist"><table border="0" class="variablelist compact">
 127 <colgroup>
 128 <col align="left" valign="top">
 129 <col>
 130 </colgroup>
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term">Parameters:</span></p></td>
 134 <td><div class="variablelist"><table border="0" class="variablelist compact">
 135 <colgroup>
 136 <col align="left" valign="top">
 137 <col>
 138 </colgroup>
 139 <tbody><tr>
 140 <td><p><span class="term"><code class="computeroutput">rec</code></span></p></td>
 141 <td><p>Logging record to consume </p></td>
 142 </tr></tbody>
 143 </table></div></td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term">Returns:</span></p></td>
 147 <td><p><code class="computeroutput">true</code>, if the record was consumed, <code class="computeroutput">false</code>, if not. </p></td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </li>
 152 <li class="listitem">
 153 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45711345888944-bb"></a><span class="identifier">flush</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre>
 154 <p>The method performs flushing of any internal buffers that may hold log records. The method may take considerable time to complete and may block both the calling thread and threads attempting to put new records into the sink while this call is in progress. </p>
 155 </li>
 156 <li class="listitem">
 157 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711345886896-bb"></a><span class="identifier">is_cross_thread</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 158 <p>The method indicates that the sink passes log records between different threads. This information is needed by the logging core to detach log records from all thread-specific resources before passing it to the sink. </p>
 159 </li>
 160 </ol></div>
 161 </div>
 162 </div>
 163 </div>
 164 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 165 <td align="left"></td>
 166 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 167         Distributed under the Boost Software License, Version 1.0. (See accompanying
 168         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>).
 169       </p>
 170 </div></td>
 171 </tr></table>
 172 <hr>
 173 <div class="spirit-nav">
 174 <a accesskey="p" href="../../../BOOST_LO_idm45711345907968.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.sink_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="synchronous_sink.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 175 </div>
 176 </body>
 177 </html>