libs/log/doc/html/boost/log/sources/multi_thread_model.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template multi_thread_model</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="../../../logging_sources.html#header.boost.log.sources.threading_models_hpp" title="Header &lt;boost/log/sources/threading_models.hpp&gt;">
   9 <link rel="prev" href="wseverity_logger_mt.html" title="Class template wseverity_logger_mt">
  10 <link rel="next" href="single_thread_model.html" title="Struct single_thread_model">
  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="wseverity_logger_mt.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../logging_sources.html#header.boost.log.sources.threading_models_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="single_thread_model.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sources.multi_thread_model"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Struct template multi_thread_model</span></h2>
  22 <p>boost::log::sources::multi_thread_model &#8212; Multi-thread locking model with maximum locking capabilities. </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="../../../logging_sources.html#header.boost.log.sources.threading_models_hpp" title="Header &lt;boost/log/sources/threading_models.hpp&gt;">boost/log/sources/threading_models.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MutexT<span class="special">&gt;</span>
  28 <span class="keyword">struct</span> <a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="special">{</span>
  29   <span class="comment">// <a class="link" href="multi_thread_model.html#boost.log.sources.multi_thread_modelconstruct-copy-destruct">construct/copy/destruct</a></span>
  30   <a class="link" href="multi_thread_model.html#idm45711346753840-bb"><span class="identifier">multi_thread_model</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  31   <a class="link" href="multi_thread_model.html#idm45711346753552-bb"><span class="identifier">multi_thread_model</span></a><span class="special">(</span><a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  32   <a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="special">&amp;</span> <a class="link" href="multi_thread_model.html#idm45711346752288-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  33
  34   <span class="comment">// <a class="link" href="multi_thread_model.html#idm45711346778928-bb">public member functions</a></span>
  35   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346778368-bb"><span class="identifier">lock_shared</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  36   <span class="keyword">bool</span> <a class="link" href="multi_thread_model.html#idm45711346777248-bb"><span class="identifier">try_lock_shared</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  37   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> TimeT<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="multi_thread_model.html#idm45711346776128-bb"><span class="identifier">timed_lock_shared</span></a><span class="special">(</span><span class="identifier">TimeT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  38   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346773472-bb"><span class="identifier">unlock_shared</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  39   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346772352-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  40   <span class="keyword">bool</span> <a class="link" href="multi_thread_model.html#idm45711346771232-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> TimeT<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="multi_thread_model.html#idm45711346770112-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="identifier">TimeT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  42   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346767456-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346766336-bb"><span class="identifier">lock_upgrade</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  44   <span class="keyword">bool</span> <a class="link" href="multi_thread_model.html#idm45711346765216-bb"><span class="identifier">try_lock_upgrade</span></a><span class="special">(</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> TimeT<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="multi_thread_model.html#idm45711346764096-bb"><span class="identifier">timed_lock_upgrade</span></a><span class="special">(</span><span class="identifier">TimeT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  46   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346761440-bb"><span class="identifier">unlock_upgrade</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346760320-bb"><span class="identifier">unlock_upgrade_and_lock</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346759200-bb"><span class="identifier">unlock_and_lock_upgrade</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346758080-bb"><span class="identifier">unlock_and_lock_shared</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346756960-bb"><span class="identifier">unlock_upgrade_and_lock_shared</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  51   <span class="keyword">void</span> <a class="link" href="multi_thread_model.html#idm45711346755824-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52 <span class="special">}</span><span class="special">;</span></pre></div>
  53 <div class="refsect1">
  54 <a name="idm45554736135216"></a><h2>Description</h2>
  55 <div class="refsect2">
  56 <a name="idm45554736134800"></a><h3>
  57 <a name="boost.log.sources.multi_thread_modelconstruct-copy-destruct"></a><code class="computeroutput">multi_thread_model</code>
  58         public
  59        construct/copy/destruct</h3>
  60 <div class="orderedlist"><ol class="orderedlist" type="1">
  61 <li class="listitem"><pre class="literallayout"><a name="idm45711346753840-bb"></a><span class="identifier">multi_thread_model</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  62 <li class="listitem"><pre class="literallayout"><a name="idm45711346753552-bb"></a><span class="identifier">multi_thread_model</span><span class="special">(</span><a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
  63 <li class="listitem"><pre class="literallayout"><a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="special">&amp;</span> <a name="idm45711346752288-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
  64 </ol></div>
  65 </div>
  66 <div class="refsect2">
  67 <a name="idm45554736115632"></a><h3>
  68 <a name="idm45711346778928-bb"></a><code class="computeroutput">multi_thread_model</code> public member functions</h3>
  69 <div class="orderedlist"><ol class="orderedlist" type="1">
  70 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346778368-bb"></a><span class="identifier">lock_shared</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  71 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711346777248-bb"></a><span class="identifier">try_lock_shared</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  72 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> TimeT<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45711346776128-bb"></a><span class="identifier">timed_lock_shared</span><span class="special">(</span><span class="identifier">TimeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> t<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  73 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346773472-bb"></a><span class="identifier">unlock_shared</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  74 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346772352-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  75 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711346771232-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  76 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> TimeT<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45711346770112-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="identifier">TimeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> t<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  77 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346767456-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  78 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346766336-bb"></a><span class="identifier">lock_upgrade</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  79 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711346765216-bb"></a><span class="identifier">try_lock_upgrade</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  80 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> TimeT<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45711346764096-bb"></a><span class="identifier">timed_lock_upgrade</span><span class="special">(</span><span class="identifier">TimeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> t<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  81 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346761440-bb"></a><span class="identifier">unlock_upgrade</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  82 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346760320-bb"></a><span class="identifier">unlock_upgrade_and_lock</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  83 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346759200-bb"></a><span class="identifier">unlock_and_lock_upgrade</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  84 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346758080-bb"></a><span class="identifier">unlock_and_lock_shared</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  85 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346756960-bb"></a><span class="identifier">unlock_upgrade_and_lock_shared</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  86 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346755824-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="multi_thread_model.html" title="Struct template multi_thread_model">multi_thread_model</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
  87 </ol></div>
  88 </div>
  89 </div>
  90 </div>
  91 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  92 <td align="left"></td>
  93 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  94         Distributed under the Boost Software License, Version 1.0. (See accompanying
  95         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>).
  96       </p>
  97 </div></td>
  98 </tr></table>
  99 <hr>
 100 <div class="spirit-nav">
 101 <a accesskey="p" href="wseverity_logger_mt.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../logging_sources.html#header.boost.log.sources.threading_models_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="single_thread_model.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 102 </div>
 103 </body>
 104 </html>