1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template basic_text_ostream_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.text_ostream_backend_hpp" title="Header <boost/log/sinks/text_ostream_backend.hpp>"> 9<link rel="prev" href="text_multifile_backend.html" title="Class text_multifile_backend"> 10<link rel="next" href="unbounded_fifo_queue.html" title="Class unbounded_fifo_queue"> 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="text_multifile_backend.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.text_ostream_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="unbounded_fifo_queue.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 17</div> 18<div class="refentry"> 19<a name="boost.log.sinks.basic_text_ostream_backend"></a><div class="titlepage"></div> 20<div class="refnamediv"> 21<h2><span class="refentrytitle">Class template basic_text_ostream_backend</span></h2> 22<p>boost::log::sinks::basic_text_ostream_backend — An implementation of a text output stream logging sink backend. </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.text_ostream_backend_hpp" title="Header <boost/log/sinks/text_ostream_backend.hpp>">boost/log/sinks/text_ostream_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_text_ostream_backend.html" title="Class template basic_text_ostream_backend">basic_text_ostream_backend</a> <span class="special">:</span> <span class="keyword">public</span> basic_formatted_sink_backend< CharT, combine_requirements< synchronized_feeding, flushing >::type > 29<span class="special">{</span> 30<span class="keyword">public</span><span class="special">:</span> 31 <span class="comment">// types</span> 32 <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_text_ostream_backend.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> <span class="comment">// Character type. </span> 33 <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_text_ostream_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> 34 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">char_type</span> <span class="special">></span> <a name="boost.log.sinks.basic_text_ostream_backend.stream_type"></a><span class="identifier">stream_type</span><span class="special">;</span> <span class="comment">// Output stream type. </span> 35 36 <span class="comment">// <a class="link" href="basic_text_ostream_backend.html#boost.log.sinks.basic_text_ostream_backendconstruct-copy-destruct">construct/copy/destruct</a></span> 37 <a class="link" href="basic_text_ostream_backend.html#idm46079576071840-bb"><span class="identifier">basic_text_ostream_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 38 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> ArgsT<span class="special">></span> 39 <span class="keyword">explicit</span> <a class="link" href="basic_text_ostream_backend.html#idm46079576071056-bb"><span class="identifier">basic_text_ostream_backend</span></a><span class="special">(</span><span class="identifier">ArgsT</span><span class="special">...</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 40 <a class="link" href="basic_text_ostream_backend.html#idm46079576064000-bb"><span class="special">~</span><span class="identifier">basic_text_ostream_backend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 41 42 <span class="comment">// <a class="link" href="basic_text_ostream_backend.html#idm46079576088384-bb">public member functions</a></span> 43 <span class="keyword">void</span> <a class="link" href="basic_text_ostream_backend.html#idm46079576087824-bb"><span class="identifier">add_stream</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">stream_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 44 <span class="keyword">void</span> <a class="link" href="basic_text_ostream_backend.html#idm46079576085088-bb"><span class="identifier">remove_stream</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">stream_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 45 <span class="keyword">void</span> <a class="link" href="basic_text_ostream_backend.html#idm46079576082288-bb"><span class="identifier">auto_flush</span></a><span class="special">(</span><span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> 46 <span class="keyword">void</span> <a class="link" href="basic_text_ostream_backend.html#idm46079576079200-bb"><span class="identifier">set_auto_newline_mode</span></a><span class="special">(</span><span class="identifier">auto_newline_mode</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">void</span> <a class="link" href="basic_text_ostream_backend.html#idm46079576075968-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> 48 <span class="keyword">void</span> <a class="link" href="basic_text_ostream_backend.html#idm46079576073296-bb"><span class="identifier">flush</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 49<span class="special">}</span><span class="special">;</span></pre></div> 50<div class="refsect1"> 51<a name="idm44984861392512"></a><h2>Description</h2> 52<p>The sink backend puts formatted log records to one or more text streams. </p> 53<div class="refsect2"> 54<a name="idm44984861391744"></a><h3> 55<a name="boost.log.sinks.basic_text_ostream_backendconstruct-copy-destruct"></a><code class="computeroutput">basic_text_ostream_backend</code> 56 public 57 construct/copy/destruct</h3> 58<div class="orderedlist"><ol class="orderedlist" type="1"> 59<li class="listitem"> 60<pre class="literallayout"><a name="idm46079576071840-bb"></a><span class="identifier">basic_text_ostream_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 61<p>Constructor. No streams attached to the constructed backend, auto flush feature disabled. </p> 62</li> 63<li class="listitem"> 64<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> ArgsT<span class="special">></span> 65 <span class="keyword">explicit</span> <a name="idm46079576071056-bb"></a><span class="identifier">basic_text_ostream_backend</span><span class="special">(</span><span class="identifier">ArgsT</span><span class="special">...</span> <span class="keyword">const</span> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre> 66<p>Constructor. Creates a sink backend with the specified named parameters. The following named parameters are supported:</p> 67<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 68<li class="listitem"><p><code class="computeroutput">auto_flush</code> - Specifies a flag, whether or not to automatically flush the attached streams after each written log record. By default, is <code class="computeroutput">false</code>. </p></li> 69<li class="listitem"><p><code class="computeroutput">auto_newline_mode</code> - Specifies automatic trailing newline insertion mode. Must be a value of the <code class="computeroutput">auto_newline_mode</code> enum. By default, is <code class="computeroutput">auto_newline_mode::insert_if_missing</code>. </p></li> 70</ul></div> 71<p> 72</p> 73</li> 74<li class="listitem"> 75<pre class="literallayout"><a name="idm46079576064000-bb"></a><span class="special">~</span><span class="identifier">basic_text_ostream_backend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 76<p>Destructor </p> 77</li> 78</ol></div> 79</div> 80<div class="refsect2"> 81<a name="idm44984861365440"></a><h3> 82<a name="idm46079576088384-bb"></a><code class="computeroutput">basic_text_ostream_backend</code> public member functions</h3> 83<div class="orderedlist"><ol class="orderedlist" type="1"> 84<li class="listitem"> 85<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576087824-bb"></a><span class="identifier">add_stream</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">stream_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> strm<span class="special">)</span><span class="special">;</span></pre> 86<p>The method adds a new stream to the sink.</p> 87<p> 88</p> 89<div class="variablelist"><table border="0" class="variablelist compact"> 90<colgroup> 91<col align="left" valign="top"> 92<col> 93</colgroup> 94<tbody><tr> 95<td><p><span class="term">Parameters:</span></p></td> 96<td><div class="variablelist"><table border="0" class="variablelist compact"> 97<colgroup> 98<col align="left" valign="top"> 99<col> 100</colgroup> 101<tbody><tr> 102<td><p><span class="term"><code class="computeroutput">strm</code></span></p></td> 103<td><p>Pointer to the stream. Must not be NULL. </p></td> 104</tr></tbody> 105</table></div></td> 106</tr></tbody> 107</table></div> 108</li> 109<li class="listitem"> 110<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576085088-bb"></a><span class="identifier">remove_stream</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">stream_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> strm<span class="special">)</span><span class="special">;</span></pre> 111<p>The method removes a stream from the sink. If the stream is not attached to the sink, the method has no effect.</p> 112<p> 113</p> 114<div class="variablelist"><table border="0" class="variablelist compact"> 115<colgroup> 116<col align="left" valign="top"> 117<col> 118</colgroup> 119<tbody><tr> 120<td><p><span class="term">Parameters:</span></p></td> 121<td><div class="variablelist"><table border="0" class="variablelist compact"> 122<colgroup> 123<col align="left" valign="top"> 124<col> 125</colgroup> 126<tbody><tr> 127<td><p><span class="term"><code class="computeroutput">strm</code></span></p></td> 128<td><p>Pointer to the stream. Must not be NULL. </p></td> 129</tr></tbody> 130</table></div></td> 131</tr></tbody> 132</table></div> 133</li> 134<li class="listitem"> 135<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576082288-bb"></a><span class="identifier">auto_flush</span><span class="special">(</span><span class="keyword">bool</span> enable <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre> 136<p>Sets the flag to automatically flush buffers of all attached streams after each log record.</p> 137<p> 138</p> 139<div class="variablelist"><table border="0" class="variablelist compact"> 140<colgroup> 141<col align="left" valign="top"> 142<col> 143</colgroup> 144<tbody><tr> 145<td><p><span class="term">Parameters:</span></p></td> 146<td><div class="variablelist"><table border="0" class="variablelist compact"> 147<colgroup> 148<col align="left" valign="top"> 149<col> 150</colgroup> 151<tbody><tr> 152<td><p><span class="term"><code class="computeroutput">enable</code></span></p></td> 153<td><p>The flag indicates whether the automatic buffer flush should be performed. </p></td> 154</tr></tbody> 155</table></div></td> 156</tr></tbody> 157</table></div> 158</li> 159<li class="listitem"> 160<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576079200-bb"></a><span class="identifier">set_auto_newline_mode</span><span class="special">(</span><span class="identifier">auto_newline_mode</span> mode<span class="special">)</span><span class="special">;</span></pre> 161<p>Selects whether a trailing newline should be automatically inserted after every log record. See <code class="computeroutput">auto_newline_mode</code> description for the possible modes of operation.</p> 162<p> 163</p> 164<div class="variablelist"><table border="0" class="variablelist compact"> 165<colgroup> 166<col align="left" valign="top"> 167<col> 168</colgroup> 169<tbody><tr> 170<td><p><span class="term">Parameters:</span></p></td> 171<td><div class="variablelist"><table border="0" class="variablelist compact"> 172<colgroup> 173<col align="left" valign="top"> 174<col> 175</colgroup> 176<tbody><tr> 177<td><p><span class="term"><code class="computeroutput">mode</code></span></p></td> 178<td><p>The trailing newline insertion mode. </p></td> 179</tr></tbody> 180</table></div></td> 181</tr></tbody> 182</table></div> 183</li> 184<li class="listitem"> 185<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576075968-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> 186<p>The method writes the message to the sink. </p> 187</li> 188<li class="listitem"> 189<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576073296-bb"></a><span class="identifier">flush</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 190<p>The method flushes all attached streams. </p> 191</li> 192</ol></div> 193</div> 194</div> 195</div> 196<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 197<td align="left"></td> 198<td align="right"><div class="copyright-footer">Copyright © 2007-2019 Andrey Semashev<p> 199 Distributed under the Boost Software License, Version 1.0. (See accompanying 200 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>). 201 </p> 202</div></td> 203</tr></table> 204<hr> 205<div class="spirit-nav"> 206<a accesskey="p" href="text_multifile_backend.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.text_ostream_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="unbounded_fifo_queue.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 207</div> 208</body> 209</html> 210
