libs/log/doc/html/boost/log/sinks/asynchronous_sink/scoped_thread_id.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class scoped_thread_id</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="../asynchronous_sink.html#idm45554735618304" title="Description">
   9 <link rel="prev" href="scoped_flag.html" title="Class scoped_flag">
  10 <link rel="next" href="../basic_custom_mapping.html" title="Class template basic_custom_mapping">
  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="scoped_flag.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../asynchronous_sink.html#idm45554735618304"><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="../basic_custom_mapping.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.asynchronous_sink.scoped_thread_id"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class scoped_thread_id</span></h2>
  22 <p>boost::log::sinks::asynchronous_sink::scoped_thread_id &#8212; A scope guard that implements thread ID management. </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="../../../../sinks.html#header.boost.log.sinks.async_frontend_hpp" title="Header &lt;boost/log/sinks/async_frontend.hpp&gt;">boost/log/sinks/async_frontend.hpp</a>&gt;
  26
  27 </span>
  28
  29 <span class="comment">// A scope guard that implements thread ID management.</span>
  30
  31 <span class="keyword">class</span> <a class="link" href="scoped_thread_id.html" title="Class scoped_thread_id">scoped_thread_id</a> <span class="special">{</span>
  32 <span class="keyword">public</span><span class="special">:</span>
  33   <span class="comment">// <a class="link" href="scoped_thread_id.html#boost.log.sinks.asynchronous_sink.scoped_thread_idconstruct-copy-destruct">construct/copy/destruct</a></span>
  34   <a class="link" href="scoped_thread_id.html#idm45711349788592-bb"><span class="identifier">scoped_thread_id</span></a><span class="special">(</span><span class="identifier">frontend_mutex_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">condition_variable_any</span> <span class="special">&amp;</span><span class="special">,</span>
  35                    <span class="identifier">thread</span><span class="special">::</span><span class="identifier">id</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">atomic</span><span class="special">&lt;</span> <span class="keyword">bool</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  36   <a class="link" href="scoped_thread_id.html#idm45711350601440-bb"><span class="identifier">scoped_thread_id</span></a><span class="special">(</span><span class="identifier">unique_lock</span><span class="special">&lt;</span> <span class="identifier">frontend_mutex_type</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span>
  37                    <span class="identifier">condition_variable_any</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">thread</span><span class="special">::</span><span class="identifier">id</span> <span class="special">&amp;</span><span class="special">,</span>
  38                    <span class="identifier">boost</span><span class="special">::</span><span class="identifier">atomic</span><span class="special">&lt;</span> <span class="keyword">bool</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="scoped_thread_id.html#idm45711350597488-bb"><span class="identifier">scoped_thread_id</span></a><span class="special">(</span><span class="identifier">scoped_thread_id</span> <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>
  40   <span class="identifier">scoped_thread_id</span> <span class="special">&amp;</span> <a class="link" href="scoped_thread_id.html#idm45711350596224-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">scoped_thread_id</span> <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>
  41   <a class="link" href="scoped_thread_id.html#idm45711350598064-bb"><span class="special">~</span><span class="identifier">scoped_thread_id</span></a><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="idm45554735381168"></a><h2>Description</h2>
  45 <div class="refsect2">
  46 <a name="idm45554735380752"></a><h3>
  47 <a name="boost.log.sinks.asynchronous_sink.scoped_thread_idconstruct-copy-destruct"></a><code class="computeroutput">scoped_thread_id</code>
  48         public
  49        construct/copy/destruct</h3>
  50 <div class="orderedlist"><ol class="orderedlist" type="1">
  51 <li class="listitem">
  52 <pre class="literallayout"><a name="idm45711349788592-bb"></a><span class="identifier">scoped_thread_id</span><span class="special">(</span><span class="identifier">frontend_mutex_type</span> <span class="special">&amp;</span> mut<span class="special">,</span> <span class="identifier">condition_variable_any</span> <span class="special">&amp;</span> cond<span class="special">,</span>
  53                  <span class="identifier">thread</span><span class="special">::</span><span class="identifier">id</span> <span class="special">&amp;</span> tid<span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">atomic</span><span class="special">&lt;</span> <span class="keyword">bool</span> <span class="special">&gt;</span> <span class="special">&amp;</span> sr<span class="special">)</span><span class="special">;</span></pre>Initializing constructor. </li>
  54 <li class="listitem">
  55 <pre class="literallayout"><a name="idm45711350601440-bb"></a><span class="identifier">scoped_thread_id</span><span class="special">(</span><span class="identifier">unique_lock</span><span class="special">&lt;</span> <span class="identifier">frontend_mutex_type</span> <span class="special">&gt;</span> <span class="special">&amp;</span> l<span class="special">,</span>
  56                  <span class="identifier">condition_variable_any</span> <span class="special">&amp;</span> cond<span class="special">,</span> <span class="identifier">thread</span><span class="special">::</span><span class="identifier">id</span> <span class="special">&amp;</span> tid<span class="special">,</span>
  57                  <span class="identifier">boost</span><span class="special">::</span><span class="identifier">atomic</span><span class="special">&lt;</span> <span class="keyword">bool</span> <span class="special">&gt;</span> <span class="special">&amp;</span> sr<span class="special">)</span><span class="special">;</span></pre>Initializing constructor. </li>
  58 <li class="listitem"><pre class="literallayout"><a name="idm45711350597488-bb"></a><span class="identifier">scoped_thread_id</span><span class="special">(</span><span class="identifier">scoped_thread_id</span> <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>
  59 <li class="listitem"><pre class="literallayout"><span class="identifier">scoped_thread_id</span> <span class="special">&amp;</span> <a name="idm45711350596224-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">scoped_thread_id</span> <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>
  60 <li class="listitem">
  61 <pre class="literallayout"><a name="idm45711350598064-bb"></a><span class="special">~</span><span class="identifier">scoped_thread_id</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destructor. </li>
  62 </ol></div>
  63 </div>
  64 </div>
  65 </div>
  66 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  67 <td align="left"></td>
  68 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  69         Distributed under the Boost Software License, Version 1.0. (See accompanying
  70         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>).
  71       </p>
  72 </div></td>
  73 </tr></table>
  74 <hr>
  75 <div class="spirit-nav">
  76 <a accesskey="p" href="scoped_flag.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../asynchronous_sink.html#idm45554735618304"><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="../basic_custom_mapping.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  77 </div>
  78 </body>
  79 </html>