1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template basic_debug_output_backend</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 1. Boost.Log v2"> 8<link rel="up" href="../../../sinks.html#header.boost.log.sinks.debug_output_backend_hpp" title="Header <boost/log/sinks/debug_output_backend.hpp>"> 9<link rel="prev" href="bounded_ordering_queue.html" title="Class template bounded_ordering_queue"> 10<link rel="next" href="drop_on_overflow.html" title="Class drop_on_overflow"> 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="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> 17</div> 18<div class="refentry"> 19<a name="boost.log.sinks.basic_debug_output_backend"></a><div class="titlepage"></div> 20<div class="refnamediv"> 21<h2><span class="refentrytitle">Class template basic_debug_output_backend</span></h2> 22<p>boost::log::sinks::basic_debug_output_backend — An implementation of a logging sink backend that outputs to the debugger. </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: <<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>> 26 27</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">></span> 28<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> 29 <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> 30<span class="special">{</span> 31<span class="keyword">public</span><span class="special">:</span> 32 <span class="comment">// types</span> 33 <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> 34 <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> 35 36 <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> 37 <a class="link" href="basic_debug_output_backend.html#idm46079576720960-bb"><span class="identifier">basic_debug_output_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 38 <a class="link" href="basic_debug_output_backend.html#idm46079576720224-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> 39 40 <span class="comment">// <a class="link" href="basic_debug_output_backend.html#idm46079576724352-bb">public member functions</a></span> 41 <span class="keyword">void</span> <a class="link" href="basic_debug_output_backend.html#idm46079576723792-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> 42<span class="special">}</span><span class="special">;</span></pre></div> 43<div class="refsect1"> 44<a name="idm44984864506704"></a><h2>Description</h2> 45<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> 46<div class="refsect2"> 47<a name="idm44984864505744"></a><h3> 48<a name="boost.log.sinks.basic_debug_output_backendconstruct-copy-destruct"></a><code class="computeroutput">basic_debug_output_backend</code> 49 public 50 construct/copy/destruct</h3> 51<div class="orderedlist"><ol class="orderedlist" type="1"> 52<li class="listitem"> 53<pre class="literallayout"><a name="idm46079576720960-bb"></a><span class="identifier">basic_debug_output_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 54<p>Constructor. Initializes the sink backend. </p> 55</li> 56<li class="listitem"> 57<pre class="literallayout"><a name="idm46079576720224-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> 58<p>Destructor </p> 59</li> 60</ol></div> 61</div> 62<div class="refsect2"> 63<a name="idm44984864494960"></a><h3> 64<a name="idm46079576724352-bb"></a><code class="computeroutput">basic_debug_output_backend</code> public member functions</h3> 65<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 66<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576723792-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> 67<p>The method passes the formatted message to debugger </p> 68</li></ol></div> 69</div> 70</div> 71</div> 72<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 73<td align="left"></td> 74<td align="right"><div class="copyright-footer">Copyright © 2007-2019 Andrey Semashev<p> 75 Distributed under the Boost Software License, Version 1.0. (See accompanying 76 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>). 77 </p> 78</div></td> 79</tr></table> 80<hr> 81<div class="spirit-nav"> 82<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> 83</div> 84</body> 85</html> 86
