| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Class template basic_debug_output_backend</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.debug_output_backend_hpp" title="Header <boost/log/sinks/debug_output_backend.hpp>"> |
| <link rel="prev" href="bounded_ordering_queue.html" title="Class template bounded_ordering_queue"> |
| <link rel="next" href="drop_on_overflow.html" title="Class drop_on_overflow"> |
| </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="bounded_ordering_queue.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.debug_output_backend_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="drop_on_overflow.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="refentry"> |
| <a name="boost.log.sinks.basic_debug_output_backend"></a><div class="titlepage"></div> |
| <div class="refnamediv"> |
| <h2><span class="refentrytitle">Class template basic_debug_output_backend</span></h2> |
| <p>boost::log::sinks::basic_debug_output_backend — An implementation of a logging sink backend that outputs to the debugger. </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.debug_output_backend_hpp" title="Header <boost/log/sinks/debug_output_backend.hpp>">boost/log/sinks/debug_output_backend.hpp</a>> |
| |
| </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">></span> |
| <span class="keyword">class</span> <a class="link" href="basic_debug_output_backend.html" title="Class template basic_debug_output_backend">basic_debug_output_backend</a> <span class="special">:</span> |
| <span class="keyword">public</span> <span class="identifier">basic_formatted_sink_backend</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">concurrent_feeding</span> <span class="special">></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">base_type</span><span class="special">::</span><span class="identifier">char_type</span> <a name="boost.log.sinks.basic_debug_output_backend.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> <span class="comment">// Character type. </span> |
| <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">string_type</span> <a name="boost.log.sinks.basic_debug_output_backend.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> <span class="comment">// String type to be used as a message text holder. </span> |
| |
| <span class="comment">// <a class="link" href="basic_debug_output_backend.html#boost.log.sinks.basic_debug_output_backendconstruct-copy-destruct">construct/copy/destruct</a></span> |
| <a class="link" href="basic_debug_output_backend.html#idp44406240-bb"><span class="identifier">basic_debug_output_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> |
| <a class="link" href="basic_debug_output_backend.html#idp44406976-bb"><span class="special">~</span><span class="identifier">basic_debug_output_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="basic_debug_output_backend.html#idp44402848-bb">public member functions</a></span> |
| <span class="keyword">void</span> <a class="link" href="basic_debug_output_backend.html#idp44403408-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="identifier">string_type</span> <span class="keyword">const</span> <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="idp124127792"></a><h2>Description</h2> |
| <p>The sink uses Windows API in order to write log records as debug messages, if the application process is run under debugger. The sink backend also provides a specific filter that allows to check whether the debugger is available and thus elide unnecessary formatting. </p> |
| <div class="refsect2"> |
| <a name="idp124128752"></a><h3> |
| <a name="boost.log.sinks.basic_debug_output_backendconstruct-copy-destruct"></a><code class="computeroutput">basic_debug_output_backend</code> |
| public |
| construct/copy/destruct</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><a name="idp44406240-bb"></a><span class="identifier">basic_debug_output_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> |
| <p>Constructor. Initializes the sink backend. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><a name="idp44406976-bb"></a><span class="special">~</span><span class="identifier">basic_debug_output_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> |
| <p>Destructor </p> |
| </li> |
| </ol></div> |
| </div> |
| <div class="refsect2"> |
| <a name="idp124139536"></a><h3> |
| <a name="idp44402848-bb"></a><code class="computeroutput">basic_debug_output_backend</code> public member functions</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> |
| <pre class="literallayout"><span class="keyword">void</span> <a name="idp44403408-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="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span> formatted_message<span class="special">)</span><span class="special">;</span></pre> |
| <p>The method passes the formatted message to debugger </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="bounded_ordering_queue.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.debug_output_backend_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="drop_on_overflow.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
