libs/log/doc/html/boost/log/attributes/named_scope/sentry.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct sentry</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="../named_scope.html#idm45554751027088" title="Description">
   9 <link rel="prev" href="../named_scope.html" title="Class named_scope">
  10 <link rel="next" href="../named_scope_entry.html" title="Struct named_scope_entry">
  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="../named_scope.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../named_scope.html#idm45554751027088"><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="../named_scope_entry.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.attributes.named_scope.sentry"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Struct sentry</span></h2>
  22 <p>boost::log::attributes::named_scope::sentry &#8212; Sentry object class to automatically push and pop scopes. </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="../../../../attributes.html#header.boost.log.attributes.named_scope_hpp" title="Header &lt;boost/log/attributes/named_scope.hpp&gt;">boost/log/attributes/named_scope.hpp</a>&gt;
  26
  27 </span>
  28
  29 <span class="comment">// Sentry object class to automatically push and pop scopes.</span>
  30
  31 <span class="keyword">struct</span> <a class="link" href="sentry.html" title="Struct sentry">sentry</a> <span class="special">{</span>
  32   <span class="comment">// <a class="link" href="sentry.html#boost.log.attributes.named_scope.sentryconstruct-copy-destruct">construct/copy/destruct</a></span>
  33   <a class="link" href="sentry.html#idm45711348601696-bb"><span class="identifier">sentry</span></a><span class="special">(</span><span class="identifier">string_literal</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">string_literal</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span>
  34          <span class="identifier">scope_entry</span><span class="special">::</span><span class="identifier">scope_name_type</span> <span class="special">=</span> <span class="identifier">scope_entry</span><span class="special">::</span><span class="identifier">general</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  35   <a class="link" href="sentry.html#idm45711348595248-bb"><span class="identifier">sentry</span></a><span class="special">(</span><a class="link" href="sentry.html" title="Struct sentry">sentry</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  36   <a class="link" href="sentry.html" title="Struct sentry">sentry</a> <span class="special">&amp;</span> <a class="link" href="sentry.html#idm45711348593712-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="sentry.html" title="Struct sentry">sentry</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  37   <a class="link" href="sentry.html#idm45711348596016-bb"><span class="special">~</span><span class="identifier">sentry</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  38 <span class="special">}</span><span class="special">;</span></pre></div>
  39 <div class="refsect1">
  40 <a name="idm45554750939824"></a><h2>Description</h2>
  41 <div class="refsect2">
  42 <a name="idm45554750939408"></a><h3>
  43 <a name="boost.log.attributes.named_scope.sentryconstruct-copy-destruct"></a><code class="computeroutput">sentry</code>
  44         public
  45        construct/copy/destruct</h3>
  46 <div class="orderedlist"><ol class="orderedlist" type="1">
  47 <li class="listitem">
  48 <pre class="literallayout"><a name="idm45711348601696-bb"></a><span class="identifier">sentry</span><span class="special">(</span><span class="identifier">string_literal</span> <span class="keyword">const</span> <span class="special">&amp;</span> sn<span class="special">,</span> <span class="identifier">string_literal</span> <span class="keyword">const</span> <span class="special">&amp;</span> fn<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> ln<span class="special">,</span>
  49        <span class="identifier">scope_entry</span><span class="special">::</span><span class="identifier">scope_name_type</span> t <span class="special">=</span> <span class="identifier">scope_entry</span><span class="special">::</span><span class="identifier">general</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  50 <p>Constructor. Pushes the specified scope to the end of the thread-local list of scopes.</p>
  51 <p>
  52 </p>
  53 <div class="variablelist"><table border="0" class="variablelist compact">
  54 <colgroup>
  55 <col align="left" valign="top">
  56 <col>
  57 </colgroup>
  58 <tbody><tr>
  59 <td><p><span class="term">Parameters:</span></p></td>
  60 <td><div class="variablelist"><table border="0" class="variablelist compact">
  61 <colgroup>
  62 <col align="left" valign="top">
  63 <col>
  64 </colgroup>
  65 <tbody>
  66 <tr>
  67 <td><p><span class="term"><code class="computeroutput">fn</code></span></p></td>
  68 <td><p>File name, in which the scope is located. </p></td>
  69 </tr>
  70 <tr>
  71 <td><p><span class="term"><code class="computeroutput">ln</code></span></p></td>
  72 <td><p>Line number in the file. </p></td>
  73 </tr>
  74 <tr>
  75 <td><p><span class="term"><code class="computeroutput">sn</code></span></p></td>
  76 <td><p>Scope name. </p></td>
  77 </tr>
  78 </tbody>
  79 </table></div></td>
  80 </tr></tbody>
  81 </table></div>
  82 </li>
  83 <li class="listitem"><pre class="literallayout"><a name="idm45711348595248-bb"></a><span class="identifier">sentry</span><span class="special">(</span><a class="link" href="sentry.html" title="Struct sentry">sentry</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  84 <li class="listitem"><pre class="literallayout"><a class="link" href="sentry.html" title="Struct sentry">sentry</a> <span class="special">&amp;</span> <a name="idm45711348593712-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="sentry.html" title="Struct sentry">sentry</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  85 <li class="listitem">
  86 <pre class="literallayout"><a name="idm45711348596016-bb"></a><span class="special">~</span><span class="identifier">sentry</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  87 <p>Destructor. Removes the last pushed scope from the thread-local list of scopes. </p>
  88 </li>
  89 </ol></div>
  90 </div>
  91 </div>
  92 </div>
  93 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  94 <td align="left"></td>
  95 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  96         Distributed under the Boost Software License, Version 1.0. (See accompanying
  97         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>).
  98       </p>
  99 </div></td>
 100 </tr></table>
 101 <hr>
 102 <div class="spirit-nav">
 103 <a accesskey="p" href="../named_scope.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../named_scope.html#idm45554751027088"><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="../named_scope_entry.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 104 </div>
 105 </body>
 106 </html>