| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Class template synchronous_sink</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 1. Boost.Log v2"> |
| <link rel="up" href="../../../sinks.html#header.boost.log.sinks.sync_frontend_hpp" title="Header <boost/log/sinks/sync_frontend.hpp>"> |
| <link rel="prev" href="sink.html" title="Class sink"> |
| <link rel="next" href="syslog/custom_severity_mapping.html" title="Class template custom_severity_mapping"> |
| </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="sink.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.sync_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="syslog/custom_severity_mapping.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="refentry"> |
| <a name="boost.log.sinks.synchronous_sink"></a><div class="titlepage"></div> |
| <div class="refnamediv"> |
| <h2><span class="refentrytitle">Class template synchronous_sink</span></h2> |
| <p>boost::log::sinks::synchronous_sink — Synchronous logging sink frontend. </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: <<a class="link" href="../../../sinks.html#header.boost.log.sinks.sync_frontend_hpp" title="Header <boost/log/sinks/sync_frontend.hpp>">boost/log/sinks/sync_frontend.hpp</a>> |
| |
| </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SinkBackendT<span class="special">></span> |
| <span class="keyword">class</span> <a class="link" href="synchronous_sink.html" title="Class template synchronous_sink">synchronous_sink</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">basic_sink_frontend</span> <span class="special">{</span> |
| <span class="keyword">public</span><span class="special">:</span> |
| <span class="comment">// types</span> |
| <span class="keyword">typedef</span> <span class="identifier">SinkBackendT</span> <a name="boost.log.sinks.synchronous_sink.sink_backend_type"></a><span class="identifier">sink_backend_type</span><span class="special">;</span> <span class="comment">// Sink implementation type. </span> |
| <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <a name="boost.log.sinks.synchronous_sink.locked_backend_ptr"></a><span class="identifier">locked_backend_ptr</span><span class="special">;</span> <span class="comment">// A pointer type that locks the backend until it's destroyed. </span> |
| |
| <span class="comment">// <a class="link" href="synchronous_sink.html#boost.log.sinks.synchronous_sinkconstruct-copy-destruct">construct/copy/destruct</a></span> |
| <a class="link" href="synchronous_sink.html#idp44663120-bb"><span class="identifier">synchronous_sink</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">explicit</span> <a class="link" href="synchronous_sink.html#idp44663920-bb"><span class="identifier">synchronous_sink</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">sink_backend_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="synchronous_sink.html#idp44654816-bb">public member functions</a></span> |
| <span class="identifier">locked_backend_ptr</span> <a class="link" href="synchronous_sink.html#idp44655376-bb"><span class="identifier">locked_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="synchronous_sink.html#idp44656672-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">&</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="synchronous_sink.html#idp44658912-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">&</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="synchronous_sink.html#idp44661184-bb"><span class="identifier">flush</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> |
| <span class="special">}</span><span class="special">;</span></pre></div> |
| <div class="refsect1"> |
| <a name="idp125462624"></a><h2>Description</h2> |
| <p>The sink frontend serializes threads before passing logging records to the backend </p> |
| <div class="refsect2"> |
| <a name="idp125463392"></a><h3> |
| <a name="boost.log.sinks.synchronous_sinkconstruct-copy-destruct"></a><code class="computeroutput">synchronous_sink</code> |
| public |
| construct/copy/destruct</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><a name="idp44663120-bb"></a><span class="identifier">synchronous_sink</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> |
| <p>Default constructor. Constructs the sink backend instance. Requires the backend to be default-constructible. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp44663920-bb"></a><span class="identifier">synchronous_sink</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">sink_backend_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> backend<span class="special">)</span><span class="special">;</span></pre> |
| <p>Constructor attaches user-constructed backend instance</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0" class="variablelist compact"> |
| <colgroup> |
| <col align="left" valign="top"> |
| <col> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0" class="variablelist compact"> |
| <colgroup> |
| <col align="left" valign="top"> |
| <col> |
| </colgroup> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">backend</code></span></p></td> |
| <td><p>Pointer to the backend instance</p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Requires:</span></p></td> |
| <td><p><span class="emphasis"><em>backend</em></span> is not <code class="computeroutput">NULL</code>. </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| </ol></div> |
| </div> |
| <div class="refsect2"> |
| <a name="idp125483408"></a><h3> |
| <a name="idp44654816-bb"></a><code class="computeroutput">synchronous_sink</code> public member functions</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">locked_backend_ptr</span> <a name="idp44655376-bb"></a><span class="identifier">locked_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> |
| <p>Locking accessor to the attached backend </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp44656672-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">&</span> rec<span class="special">)</span><span class="special">;</span></pre> |
| <p>Passes the log record to the backend </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp44658912-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">&</span> rec<span class="special">)</span><span class="special">;</span></pre> |
| <p>The method attempts to pass logging record to the backend </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp44661184-bb"></a><span class="identifier">flush</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> |
| <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> |
| </li> |
| </ol></div> |
| </div> |
| </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 © 2007-2015 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="sink.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.sync_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="syslog/custom_severity_mapping.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
