Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / log / doc / html / boost / log / attributes / mutable_constant.html
index 80986f0..35a36cc 100644 (file)
   <span class="keyword">class</span> <a class="link" href="mutable_constant/impl.html" title="Class impl">impl</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">attribute</span><span class="special">::</span><span class="identifier">impl</span> <span class="special">{</span>
   <span class="keyword">public</span><span class="special">:</span>
     <span class="comment">// <a class="link" href="mutable_constant/impl.html#boost.log.attributes.mutable_constant.implconstruct-copy-destruct">construct/copy/destruct</a></span>
-    <span class="keyword">explicit</span> <a class="link" href="mutable_constant/impl.html#idm45185967061584-bb"><span class="identifier">impl</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-    <span class="keyword">explicit</span> <a class="link" href="mutable_constant/impl.html#idm45185967059904-bb"><span class="identifier">impl</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
+    <span class="keyword">explicit</span> <a class="link" href="mutable_constant/impl.html#idm45711348662304-bb"><span class="identifier">impl</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+    <span class="keyword">explicit</span> <a class="link" href="mutable_constant/impl.html#idm45711348660624-bb"><span class="identifier">impl</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
 
-    <span class="comment">// <a class="link" href="mutable_constant/impl.html#idm45185967071696-bb">private member functions</a></span>
-     <a class="link" href="mutable_constant/impl.html#idm45185967071120-bb"><span class="identifier">BOOST_STATIC_ASSERT_MSG</span></a><span class="special">(</span><span class="special">!</span><span class="special">,</span> 
+    <span class="comment">// <a class="link" href="mutable_constant/impl.html#idm45711348672416-bb">private member functions</a></span>
+     <a class="link" href="mutable_constant/impl.html#idm45711348671840-bb"><span class="identifier">BOOST_STATIC_ASSERT_MSG</span></a><span class="special">(</span><span class="special">!</span><span class="special">,</span> 
                              <span class="string">"Boost.Log: Mutex and both lock types either must not be void or must all be void"</span><span class="special">)</span><span class="special">;</span>
 
-    <span class="comment">// <a class="link" href="mutable_constant/impl.html#idm45185967068832-bb">public member functions</a></span>
-    <span class="keyword">virtual</span> <a class="link" href="../attribute_value.html" title="Class attribute_value">attribute_value</a> <a class="link" href="mutable_constant/impl.html#idm45185967068272-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-    <span class="keyword">void</span> <a class="link" href="mutable_constant/impl.html#idm45185967065936-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-    <span class="keyword">void</span> <a class="link" href="mutable_constant/impl.html#idm45185967064400-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
-    <span class="identifier">value_type</span> <a class="link" href="mutable_constant/impl.html#idm45185967062864-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+    <span class="comment">// <a class="link" href="mutable_constant/impl.html#idm45711348669552-bb">public member functions</a></span>
+    <span class="keyword">virtual</span> <a class="link" href="../attribute_value.html" title="Class attribute_value">attribute_value</a> <a class="link" href="mutable_constant/impl.html#idm45711348668992-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+    <span class="keyword">void</span> <a class="link" href="mutable_constant/impl.html#idm45711348666656-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+    <span class="keyword">void</span> <a class="link" href="mutable_constant/impl.html#idm45711348665120-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
+    <span class="identifier">value_type</span> <a class="link" href="mutable_constant/impl.html#idm45711348663584-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
   <span class="special">}</span><span class="special">;</span>
 
   <span class="comment">// <a class="link" href="mutable_constant.html#boost.log.attributes.mutable_constantconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <span class="keyword">explicit</span> <a class="link" href="mutable_constant.html#idm45185967050656-bb"><span class="identifier">mutable_constant</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">explicit</span> <a class="link" href="mutable_constant.html#idm45185967048960-bb"><span class="identifier">mutable_constant</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">explicit</span> <a class="link" href="mutable_constant.html#idm45185967047264-bb"><span class="identifier">mutable_constant</span></a><span class="special">(</span><a class="link" href="cast_source.html" title="Class cast_source">cast_source</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="mutable_constant.html#idm45711348651376-bb"><span class="identifier">mutable_constant</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="mutable_constant.html#idm45711348649680-bb"><span class="identifier">mutable_constant</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="mutable_constant.html#idm45711348647984-bb"><span class="identifier">mutable_constant</span></a><span class="special">(</span><a class="link" href="cast_source.html" title="Class cast_source">cast_source</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="mutable_constant.html#idm45185967057072-bb">public member functions</a></span>
-  <span class="keyword">void</span> <a class="link" href="mutable_constant.html#idm45185967056512-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="mutable_constant.html#idm45185967054448-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
-  <span class="identifier">value_type</span> <a class="link" href="mutable_constant.html#idm45185967052480-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="mutable_constant.html#idm45711348657792-bb">public member functions</a></span>
+  <span class="keyword">void</span> <a class="link" href="mutable_constant.html#idm45711348657232-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="mutable_constant.html#idm45711348655168-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="identifier">value_type</span> <a class="link" href="mutable_constant.html#idm45711348653200-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="mutable_constant.html#idm45185967045296-bb">protected member functions</a></span>
-  <a class="link" href="mutable_constant/impl.html" title="Class impl">impl</a> <span class="special">*</span> <a class="link" href="mutable_constant.html#idm45185967044720-bb"><span class="identifier">get_impl</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="mutable_constant.html#idm45711348646016-bb">protected member functions</a></span>
+  <a class="link" href="mutable_constant/impl.html" title="Class impl">impl</a> <span class="special">*</span> <a class="link" href="mutable_constant.html#idm45711348645440-bb"><span class="identifier">get_impl</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm46436920066656"></a><h2>Description</h2>
+<a name="idm45554751559616"></a><h2>Description</h2>
 <p>The <a class="link" href="mutable_constant.html" title="Class template mutable_constant">mutable_constant</a> attribute stores a single value of type, specified as the first template argument. This value is returned on each attribute value acquisition.</p>
 <p>The attribute also allows to modify the stored value, even if the attribute is registered in an attribute set. In order to ensure thread safety of such modifications the <code class="computeroutput"><a class="link" href="mutable_constant.html" title="Class template mutable_constant">mutable_constant</a></code> class is also parametrized with three additional template arguments: mutex type, scoped write and scoped read lock types. If not specified, the lock types are automatically deduced based on the mutex type.</p>
 <p>The implementation may avoid using these types to actually create and use the mutex, if a more efficient synchronization method is available (such as atomic operations on the value type). By default no synchronization is done. </p>
 <div class="refsect2">
-<a name="idm46436920062512"></a><h3>
+<a name="idm45554751555472"></a><h3>
 <a name="boost.log.attributes.mutable_constantconstruct-copy-destruct"></a><code class="computeroutput">mutable_constant</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45185967050656-bb"></a><span class="identifier">mutable_constant</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711348651376-bb"></a><span class="identifier">mutable_constant</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
 <p>Constructor with the stored value initialization </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45185967048960-bb"></a><span class="identifier">mutable_constant</span><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711348649680-bb"></a><span class="identifier">mutable_constant</span><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
 <p>Constructor with the stored value initialization </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45185967047264-bb"></a><span class="identifier">mutable_constant</span><span class="special">(</span><a class="link" href="cast_source.html" title="Class cast_source">cast_source</a> <span class="keyword">const</span> <span class="special">&amp;</span> source<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711348647984-bb"></a><span class="identifier">mutable_constant</span><span class="special">(</span><a class="link" href="cast_source.html" title="Class cast_source">cast_source</a> <span class="keyword">const</span> <span class="special">&amp;</span> source<span class="special">)</span><span class="special">;</span></pre>
 <p>Constructor for casting support </p>
 </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46436920040496"></a><h3>
-<a name="idm45185967057072-bb"></a><code class="computeroutput">mutable_constant</code> public member functions</h3>
+<a name="idm45554751533536"></a><h3>
+<a name="idm45711348657792-bb"></a><code class="computeroutput">mutable_constant</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idm45185967056512-bb"></a><span class="identifier">set</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idm45711348657232-bb"></a><span class="identifier">set</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
 <p>The method sets a new attribute value. The implementation exclusively locks the mutex in order to protect the value assignment. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idm45185967054448-bb"></a><span class="identifier">set</span><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idm45711348655168-bb"></a><span class="identifier">set</span><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
 <p>The method sets a new attribute value. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45185967052480-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45711348653200-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>The method acquires the current attribute value. The implementation non-exclusively locks the mutex in order to protect the value acquisition. </p>
 </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46436920020096"></a><h3>
-<a name="idm45185967045296-bb"></a><code class="computeroutput">mutable_constant</code> protected member functions</h3>
+<a name="idm45554751513200"></a><h3>
+<a name="idm45711348646016-bb"></a><code class="computeroutput">mutable_constant</code> protected member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><a class="link" href="mutable_constant/impl.html" title="Class impl">impl</a> <span class="special">*</span> <a name="idm45185967044720-bb"></a><span class="identifier">get_impl</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><a class="link" href="mutable_constant/impl.html" title="Class impl">impl</a> <span class="special">*</span> <a name="idm45711348645440-bb"></a><span class="identifier">get_impl</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>
 </p>
 <div class="variablelist"><table border="0" class="variablelist compact">
 </li></ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46436919911120"></a><h3>Specializations</h3>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="mutable__idm45185967042144.html" title="Class template mutable_constant&lt;T, void, void, void&gt;">Class template mutable_constant&lt;T, void, void, void&gt;</a></p></li></ul></div>
+<a name="idm45554751404144"></a><h3>Specializations</h3>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="mutable__idm45711348642864.html" title="Class template mutable_constant&lt;T, void, void, void&gt;">Class template mutable_constant&lt;T, void, void, void&gt;</a></p></li></ul></div>
 </div>
 </div>
 </div>