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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template unlocked_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.unlocked_frontend_hpp" title="Header &lt;boost/log/sinks/unlocked_frontend.hpp&gt;">
   9 <link rel="prev" href="unbounded_ordering_queue.html" title="Class template unbounded_ordering_queue">
  10 <link rel="next" href="../../../utilities.html" title="Utilities">
  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="unbounded_ordering_queue.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.unlocked_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="../../../utilities.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.unlocked_sink"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template unlocked_sink</span></h2>
  22 <p>boost::log::sinks::unlocked_sink &#8212; Non-blocking 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.unlocked_frontend_hpp" title="Header &lt;boost/log/sinks/unlocked_frontend.hpp&gt;">boost/log/sinks/unlocked_frontend.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SinkBackendT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="unlocked_sink.html" title="Class template unlocked_sink">unlocked_sink</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">SinkBackendT</span>                    <a name="boost.log.sinks.unlocked_sink.sink_backend_type"></a><span class="identifier">sink_backend_type</span><span class="special">;</span>   <span class="comment">// Sink implementation type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">sink_backend_type</span> <span class="special">&gt;</span> <a name="boost.log.sinks.unlocked_sink.locked_backend_ptr"></a><span class="identifier">locked_backend_ptr</span><span class="special">;</span>  <span class="comment">// Type of pointer to the backend. </span>
  33
  34   <span class="comment">// <a class="link" href="unlocked_sink.html#boost.log.sinks.unlocked_sinkconstruct-copy-destruct">construct/copy/destruct</a></span>
  35   <a class="link" href="unlocked_sink.html#idp65303424-bb"><span class="identifier">unlocked_sink</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  36   <span class="keyword">explicit</span> <a class="link" href="unlocked_sink.html#idp65304224-bb"><span class="identifier">unlocked_sink</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">sink_backend_type</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  37   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="unlocked_sink.html#idp65307808-bb"><span class="identifier">unlocked_sink</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  38
  39   <span class="comment">// <a class="link" href="unlocked_sink.html#idp65296608-bb">public member functions</a></span>
  40   <span class="identifier">locked_backend_ptr</span> <a class="link" href="unlocked_sink.html#idp65297168-bb"><span class="identifier">locked_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  41   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unlocked_sink.html#idp65299248-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>
  42   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unlocked_sink.html#idp65301488-bb"><span class="identifier">flush</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  43 <span class="special">}</span><span class="special">;</span></pre></div>
  44 <div class="refsect1">
  45 <a name="idp128792864"></a><h2>Description</h2>
  46 <p>The sink frontend does not perform thread synchronization and simply passes logging records to the sink backend. </p>
  47 <div class="refsect2">
  48 <a name="idp128793664"></a><h3>
  49 <a name="boost.log.sinks.unlocked_sinkconstruct-copy-destruct"></a><code class="computeroutput">unlocked_sink</code>
  50         public
  51        construct/copy/destruct</h3>
  52 <div class="orderedlist"><ol class="orderedlist" type="1">
  53 <li class="listitem">
  54 <pre class="literallayout"><a name="idp65303424-bb"></a><span class="identifier">unlocked_sink</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  55 <p>Default constructor. Constructs the sink backend instance. Requires the backend to be default-constructible. </p>
  56 </li>
  57 <li class="listitem">
  58 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp65304224-bb"></a><span class="identifier">unlocked_sink</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">sink_backend_type</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> backend<span class="special">)</span><span class="special">;</span></pre>
  59 <p>Constructor attaches user-constructed backend instance</p>
  60 <p>
  61
  62 </p>
  63 <div class="variablelist"><table border="0" class="variablelist compact">
  64 <colgroup>
  65 <col align="left" valign="top">
  66 <col>
  67 </colgroup>
  68 <tbody>
  69 <tr>
  70 <td><p><span class="term">Parameters:</span></p></td>
  71 <td><div class="variablelist"><table border="0" class="variablelist compact">
  72 <colgroup>
  73 <col align="left" valign="top">
  74 <col>
  75 </colgroup>
  76 <tbody><tr>
  77 <td><p><span class="term"><code class="computeroutput">backend</code></span></p></td>
  78 <td><p>Pointer to the backend instance</p></td>
  79 </tr></tbody>
  80 </table></div></td>
  81 </tr>
  82 <tr>
  83 <td><p><span class="term">Requires:</span></p></td>
  84 <td><p><span class="emphasis"><em>backend</em></span> is not <code class="computeroutput">NULL</code>. </p></td>
  85 </tr>
  86 </tbody>
  87 </table></div>
  88 </li>
  89 <li class="listitem">
  90 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">&gt;</span> <span class="keyword">explicit</span> <a name="idp65307808-bb"></a><span class="identifier">unlocked_sink</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre>
  91 <p>Constructor that passes arbitrary named parameters to the interprocess sink backend constructor. Refer to the backend documentation for the list of supported parameters. </p>
  92 </li>
  93 </ol></div>
  94 </div>
  95 <div class="refsect2">
  96 <a name="idp128823248"></a><h3>
  97 <a name="idp65296608-bb"></a><code class="computeroutput">unlocked_sink</code> public member functions</h3>
  98 <div class="orderedlist"><ol class="orderedlist" type="1">
  99 <li class="listitem">
 100 <pre class="literallayout"><span class="identifier">locked_backend_ptr</span> <a name="idp65297168-bb"></a><span class="identifier">locked_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 101 <p>Locking accessor to the attached backend.</p>
 102 <div class="note"><table border="0" summary="Note">
 103 <tr>
 104 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
 105 <th align="left">Note</th>
 106 </tr>
 107 <tr><td align="left" valign="top"><p>Does not do any actual locking, provided only for interface consistency with other frontends. </p></td></tr>
 108 </table></div>
 109 <p>
 110 </p>
 111 </li>
 112 <li class="listitem">
 113 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp65299248-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></pre>
 114 <p>Passes the log record to the backend </p>
 115 </li>
 116 <li class="listitem">
 117 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp65301488-bb"></a><span class="identifier">flush</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 118 <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>
 119 </li>
 120 </ol></div>
 121 </div>
 122 </div>
 123 </div>
 124 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 125 <td align="left"></td>
 126 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 127         Distributed under the Boost Software License, Version 1.0. (See accompanying
 128         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>).
 129       </p>
 130 </div></td>
 131 </tr></table>
 132 <hr>
 133 <div class="spirit-nav">
 134 <a accesskey="p" href="unbounded_ordering_queue.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.unlocked_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="../../../utilities.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 135 </div>
 136 </body>
 137 </html>