libs/log/doc/html/boost/log/record.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class record</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="../../core_components.html#header.boost.log.core.record_hpp" title="Header &lt;boost/log/core/record.hpp&gt;">
   9 <link rel="prev" href="core.html" title="Class core">
  10 <link rel="next" href="swap_idm45711350433856.html" title="Function swap">
  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="core.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../core_components.html#header.boost.log.core.record_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="swap_idm45711350433856.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.record"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class record</span></h2>
  22 <p>boost::log::record &#8212; Logging record class. </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="../../core_components.html#header.boost.log.core.record_hpp" title="Header &lt;boost/log/core/record.hpp&gt;">boost/log/core/record.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">class</span> <a class="link" href="record.html" title="Class record">record</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// <a class="link" href="record.html#boost.log.recordconstruct-copy-destruct">construct/copy/destruct</a></span>
  31   <a class="link" href="record.html#idm45711350441632-bb"><span class="identifier">record</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  32   <a class="link" href="record.html#idm45711350439424-bb"><span class="identifier">record</span></a><span class="special">(</span><a class="link" href="record.html" title="Class record">record</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  33   <a class="link" href="record.html" title="Class record">record</a> <span class="special">&amp;</span> <a class="link" href="record.html#idm45711350436608-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="record.html" title="Class record">record</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  34   <a class="link" href="record.html#idm45711350437408-bb"><span class="special">~</span><span class="identifier">record</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  35
  36   <span class="comment">// <a class="link" href="record.html#idm45711350478992-bb">public member functions</a></span>
  37   <span class="identifier">attribute_value_set</span> <span class="special">&amp;</span> <a class="link" href="record.html#idm45711350478432-bb"><span class="identifier">attribute_values</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  38   <span class="identifier">attribute_value_set</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="record.html#idm45711350475408-bb"><span class="identifier">attribute_values</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  39   <span class="keyword">explicit</span> <a class="link" href="record.html#idm45711350472368-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  40   <span class="keyword">bool</span> <a class="link" href="record.html#idm45711350468016-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  41   <span class="keyword">void</span> <a class="link" href="record.html#idm45711350463936-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="record.html" title="Class record">record</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  42   <span class="keyword">void</span> <a class="link" href="record.html#idm45711350459984-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  43   <span class="identifier">attribute_value_set</span><span class="special">::</span><span class="identifier">mapped_type</span>
  44   <a class="link" href="record.html#idm45711350457168-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">attribute_value_set</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> DescriptorT<span class="special">,</span> <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="special">&gt;</span> <span class="keyword">class</span> ActorT<span class="special">&gt;</span>
  46     <span class="identifier">result_of</span><span class="special">::</span><span class="identifier">extract</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special">&lt;</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">DescriptorT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  47     <a class="link" href="record.html#idm45711350453152-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special">&lt;</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48   <a class="link" href="record_view.html" title="Class record_view">record_view</a> <a class="link" href="record.html#idm45711350446864-bb"><span class="identifier">lock</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="idm45554755883232"></a><h2>Description</h2>
  52 <p>The logging record encapsulates all information related to a single logging statement, in particular, attribute values view and the log message string. The record can be updated before pushing for further processing to the logging core. </p>
  53 <div class="refsect2">
  54 <a name="idm45554755882304"></a><h3>
  55 <a name="boost.log.recordconstruct-copy-destruct"></a><code class="computeroutput">record</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="idm45711350441632-bb"></a><span class="identifier">record</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  61 <p>Default constructor. Creates an empty record that is equivalent to the invalid record handle.</p>
  62 <p>
  63 </p>
  64 <div class="variablelist"><table border="0" class="variablelist compact">
  65 <colgroup>
  66 <col align="left" valign="top">
  67 <col>
  68 </colgroup>
  69 <tbody><tr>
  70 <td><p><span class="term">Postconditions:</span></p></td>
  71 <td><p><code class="computeroutput">!*this == true</code> </p></td>
  72 </tr></tbody>
  73 </table></div>
  74 </li>
  75 <li class="listitem">
  76 <pre class="literallayout"><a name="idm45711350439424-bb"></a><span class="identifier">record</span><span class="special">(</span><a class="link" href="record.html" title="Class record">record</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  77 <p>Move constructor. Source record contents unspecified after the operation. </p>
  78 </li>
  79 <li class="listitem">
  80 <pre class="literallayout"><a class="link" href="record.html" title="Class record">record</a> <span class="special">&amp;</span> <a name="idm45711350436608-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="record.html" title="Class record">record</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  81 <p>Move assignment. Source record contents unspecified after the operation. </p>
  82 </li>
  83 <li class="listitem">
  84 <pre class="literallayout"><a name="idm45711350437408-bb"></a><span class="special">~</span><span class="identifier">record</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  85 <p>Destructor. Destroys the record, releases any sinks and attribute values that were involved in processing this record. </p>
  86 </li>
  87 </ol></div>
  88 </div>
  89 <div class="refsect2">
  90 <a name="idm45554755854208"></a><h3>
  91 <a name="idm45711350478992-bb"></a><code class="computeroutput">record</code> public member functions</h3>
  92 <div class="orderedlist"><ol class="orderedlist" type="1">
  93 <li class="listitem">
  94 <pre class="literallayout"><span class="identifier">attribute_value_set</span> <span class="special">&amp;</span> <a name="idm45711350478432-bb"></a><span class="identifier">attribute_values</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  95 <p>
  96
  97 </p>
  98 <div class="variablelist"><table border="0" class="variablelist compact">
  99 <colgroup>
 100 <col align="left" valign="top">
 101 <col>
 102 </colgroup>
 103 <tbody>
 104 <tr>
 105 <td><p><span class="term">Requires:</span></p></td>
 106 <td><p><code class="computeroutput">!!*this</code> </p></td>
 107 </tr>
 108 <tr>
 109 <td><p><span class="term">Returns:</span></p></td>
 110 <td><p>A reference to the set of attribute values attached to this record</p></td>
 111 </tr>
 112 </tbody>
 113 </table></div>
 114 </li>
 115 <li class="listitem">
 116 <pre class="literallayout"><span class="identifier">attribute_value_set</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45711350475408-bb"></a><span class="identifier">attribute_values</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 117 <p>
 118
 119 </p>
 120 <div class="variablelist"><table border="0" class="variablelist compact">
 121 <colgroup>
 122 <col align="left" valign="top">
 123 <col>
 124 </colgroup>
 125 <tbody>
 126 <tr>
 127 <td><p><span class="term">Requires:</span></p></td>
 128 <td><p><code class="computeroutput">!!*this</code> </p></td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term">Returns:</span></p></td>
 132 <td><p>A reference to the set of attribute values attached to this record</p></td>
 133 </tr>
 134 </tbody>
 135 </table></div>
 136 </li>
 137 <li class="listitem">
 138 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711350472368-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 139 <p>Conversion to an unspecified boolean type</p>
 140 <p>
 141 </p>
 142 <div class="variablelist"><table border="0" class="variablelist compact">
 143 <colgroup>
 144 <col align="left" valign="top">
 145 <col>
 146 </colgroup>
 147 <tbody><tr>
 148 <td><p><span class="term">Returns:</span></p></td>
 149 <td><p><code class="computeroutput">true</code>, if the <code class="computeroutput">*this</code> identifies a log record, <code class="computeroutput">false</code>, if the <code class="computeroutput">*this</code> is not valid </p></td>
 150 </tr></tbody>
 151 </table></div>
 152 </li>
 153 <li class="listitem">
 154 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711350468016-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 155 <p>Inverted conversion to an unspecified boolean type</p>
 156 <p>
 157 </p>
 158 <div class="variablelist"><table border="0" class="variablelist compact">
 159 <colgroup>
 160 <col align="left" valign="top">
 161 <col>
 162 </colgroup>
 163 <tbody><tr>
 164 <td><p><span class="term">Returns:</span></p></td>
 165 <td><p><code class="computeroutput">false</code>, if the <code class="computeroutput">*this</code> identifies a log record, <code class="computeroutput">true</code>, if the <code class="computeroutput">*this</code> is not valid </p></td>
 166 </tr></tbody>
 167 </table></div>
 168 </li>
 169 <li class="listitem">
 170 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711350463936-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="record.html" title="Class record">record</a> <span class="special">&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 171 <p>Swaps two handles</p>
 172 <p>
 173 </p>
 174 <div class="variablelist"><table border="0" class="variablelist compact">
 175 <colgroup>
 176 <col align="left" valign="top">
 177 <col>
 178 </colgroup>
 179 <tbody><tr>
 180 <td><p><span class="term">Parameters:</span></p></td>
 181 <td><div class="variablelist"><table border="0" class="variablelist compact">
 182 <colgroup>
 183 <col align="left" valign="top">
 184 <col>
 185 </colgroup>
 186 <tbody><tr>
 187 <td><p><span class="term"><code class="computeroutput">that</code></span></p></td>
 188 <td><p>Another record to swap with <span class="bold"><strong>Throws:</strong></span> Nothing </p></td>
 189 </tr></tbody>
 190 </table></div></td>
 191 </tr></tbody>
 192 </table></div>
 193 </li>
 194 <li class="listitem">
 195 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711350459984-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 196 <p>Resets the log record handle. If there are no other handles left, the log record is closed and all resources referenced by the record are released.</p>
 197 <p>
 198 </p>
 199 <div class="variablelist"><table border="0" class="variablelist compact">
 200 <colgroup>
 201 <col align="left" valign="top">
 202 <col>
 203 </colgroup>
 204 <tbody><tr>
 205 <td><p><span class="term">Postconditions:</span></p></td>
 206 <td><p><code class="computeroutput">!*this == true</code> </p></td>
 207 </tr></tbody>
 208 </table></div>
 209 </li>
 210 <li class="listitem">
 211 <pre class="literallayout"><span class="identifier">attribute_value_set</span><span class="special">::</span><span class="identifier">mapped_type</span>
 212 <a name="idm45711350457168-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">attribute_value_set</span><span class="special">::</span><span class="identifier">key_type</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 213 <p>Attribute value lookup.</p>
 214 <p>
 215
 216 </p>
 217 <div class="variablelist"><table border="0" class="variablelist compact">
 218 <colgroup>
 219 <col align="left" valign="top">
 220 <col>
 221 </colgroup>
 222 <tbody>
 223 <tr>
 224 <td><p><span class="term">Parameters:</span></p></td>
 225 <td><div class="variablelist"><table border="0" class="variablelist compact">
 226 <colgroup>
 227 <col align="left" valign="top">
 228 <col>
 229 </colgroup>
 230 <tbody><tr>
 231 <td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
 232 <td><p>Attribute name. </p></td>
 233 </tr></tbody>
 234 </table></div></td>
 235 </tr>
 236 <tr>
 237 <td><p><span class="term">Returns:</span></p></td>
 238 <td><p>An <code class="computeroutput">attribute_value</code>, non-empty if it is found, empty otherwise. </p></td>
 239 </tr>
 240 </tbody>
 241 </table></div>
 242 </li>
 243 <li class="listitem">
 244 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> DescriptorT<span class="special">,</span> <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="special">&gt;</span> <span class="keyword">class</span> ActorT<span class="special">&gt;</span>
 245   <span class="identifier">result_of</span><span class="special">::</span><span class="identifier">extract</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special">&lt;</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">DescriptorT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
 246   <a name="idm45711350453152-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special">&lt;</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> keyword<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 247 <p>Attribute value lookup.</p>
 248 <p>
 249
 250 </p>
 251 <div class="variablelist"><table border="0" class="variablelist compact">
 252 <colgroup>
 253 <col align="left" valign="top">
 254 <col>
 255 </colgroup>
 256 <tbody>
 257 <tr>
 258 <td><p><span class="term">Parameters:</span></p></td>
 259 <td><div class="variablelist"><table border="0" class="variablelist compact">
 260 <colgroup>
 261 <col align="left" valign="top">
 262 <col>
 263 </colgroup>
 264 <tbody><tr>
 265 <td><p><span class="term"><code class="computeroutput">keyword</code></span></p></td>
 266 <td><p>Attribute keyword. </p></td>
 267 </tr></tbody>
 268 </table></div></td>
 269 </tr>
 270 <tr>
 271 <td><p><span class="term">Returns:</span></p></td>
 272 <td><p>A <code class="computeroutput">value_ref</code> with extracted attribute value if it is found, empty <code class="computeroutput">value_ref</code> otherwise. </p></td>
 273 </tr>
 274 </tbody>
 275 </table></div>
 276 </li>
 277 <li class="listitem">
 278 <pre class="literallayout"><a class="link" href="record_view.html" title="Class record_view">record_view</a> <a name="idm45711350446864-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 279 <p>The function ensures that the log record does not depend on any thread-specific data. Then the record contents are used to construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="record_view.html" title="Class record_view">record_view</a></code></code> which is returned from the function. The record is no longer valid after the call.</p>
 280 <p>
 281
 282
 283 </p>
 284 <div class="variablelist"><table border="0" class="variablelist compact">
 285 <colgroup>
 286 <col align="left" valign="top">
 287 <col>
 288 </colgroup>
 289 <tbody>
 290 <tr>
 291 <td><p><span class="term">Requires:</span></p></td>
 292 <td><p><code class="computeroutput">!!*this</code> </p></td>
 293 </tr>
 294 <tr>
 295 <td><p><span class="term">Postconditions:</span></p></td>
 296 <td><p><code class="computeroutput">!*this</code> </p></td>
 297 </tr>
 298 <tr>
 299 <td><p><span class="term">Returns:</span></p></td>
 300 <td><p>The record view that contains all attribute values from the original record. </p></td>
 301 </tr>
 302 </tbody>
 303 </table></div>
 304 </li>
 305 </ol></div>
 306 </div>
 307 </div>
 308 </div>
 309 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 310 <td align="left"></td>
 311 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 312         Distributed under the Boost Software License, Version 1.0. (See accompanying
 313         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>).
 314       </p>
 315 </div></td>
 316 </tr></table>
 317 <hr>
 318 <div class="spirit-nav">
 319 <a accesskey="p" href="core.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../core_components.html#header.boost.log.core.record_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="swap_idm45711350433856.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 320 </div>
 321 </body>
 322 </html>