Imported Upstream version 1.64.0
[platform/upstream/boost.git] / libs / fiber / doc / html / fiber / fiber_mgmt / fiber.html
index 803bb90..d13c23c 100644 (file)
@@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 <title>Class fiber</title>
 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Fiber">
 <link rel="up" href="../fiber_mgmt.html" title="Fiber management">
 <link rel="prev" href="../fiber_mgmt.html" title="Fiber management">
 </pre>
 <h5>
 <a name="fiber.fiber_mgmt.fiber.h0"></a>
-        <span><a name="fiber.fiber_mgmt.fiber.default_constructor"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.default_constructor">Default
+        <span class="phrase"><a name="fiber.fiber_mgmt.fiber.default_constructor"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.default_constructor">Default
         constructor</a>
       </h5>
 <pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">fiber</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Effects:</span></dt>
 <dd><p>
               Constructs a <a class="link" href="fiber.html#class_fiber"><code class="computeroutput">fiber</code></a> instance that refers to <span class="emphasis"><em>not-a-fiber</em></span>.
 </div>
 <a name="fiber_fiber"></a><h5>
 <a name="fiber.fiber_mgmt.fiber.h1"></a>
-        <span><a name="fiber.fiber_mgmt.fiber.constructor"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.constructor">Constructor</a>
+        <span class="phrase"><a name="fiber.fiber_mgmt.fiber.constructor"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.constructor">Constructor</a>
       </h5>
 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">Fn</span><span class="special">,</span> <span class="keyword">typename</span> <span class="special">...</span> <span class="identifier">Args</span> <span class="special">&gt;</span>
 <span class="identifier">fiber</span><span class="special">(</span> <span class="identifier">Fn</span> <span class="special">&amp;&amp;</span> <span class="identifier">fn</span><span class="special">,</span> <span class="identifier">Args</span> <span class="special">&amp;&amp;</span> <span class="special">...</span> <span class="identifier">args</span><span class="special">);</span>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Preconditions:</span></dt>
 <dd><p>
               <code class="computeroutput"><span class="identifier">Fn</span></code> must be copyable
 </div>
 <h5>
 <a name="fiber.fiber_mgmt.fiber.h2"></a>
-        <span><a name="fiber.fiber_mgmt.fiber.move_constructor"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.move_constructor">Move
+        <span class="phrase"><a name="fiber.fiber_mgmt.fiber.move_constructor"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.move_constructor">Move
         constructor</a>
       </h5>
 <pre class="programlisting"><span class="identifier">fiber</span><span class="special">(</span> <span class="identifier">fiber</span> <span class="special">&amp;&amp;</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Effects:</span></dt>
 <dd><p>
               Transfers ownership of the fiber managed by <code class="computeroutput"><span class="identifier">other</span></code>
 </div>
 <h5>
 <a name="fiber.fiber_mgmt.fiber.h3"></a>
-        <span><a name="fiber.fiber_mgmt.fiber.move_assignment_operator"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.move_assignment_operator">Move
+        <span class="phrase"><a name="fiber.fiber_mgmt.fiber.move_assignment_operator"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.move_assignment_operator">Move
         assignment operator</a>
       </h5>
 <pre class="programlisting"><span class="identifier">fiber</span> <span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">fiber</span> <span class="special">&amp;&amp;</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Effects:</span></dt>
 <dd><p>
               Transfers ownership of the fiber managed by <code class="computeroutput"><span class="identifier">other</span></code>
 </div>
 <h5>
 <a name="fiber.fiber_mgmt.fiber.h4"></a>
-        <span><a name="fiber.fiber_mgmt.fiber.destructor"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.destructor">Destructor</a>
+        <span class="phrase"><a name="fiber.fiber_mgmt.fiber.destructor"></a></span><a class="link" href="fiber.html#fiber.fiber_mgmt.fiber.destructor">Destructor</a>
       </h5>
 <pre class="programlisting"><span class="special">~</span><span class="identifier">fiber</span><span class="special">();</span>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Effects:</span></dt>
 <dd><p>
               If the fiber is <a class="link" href="fiber.html#fiber_joinable"><code class="computeroutput">fiber::joinable()</code></a>, calls std::terminate.
         </p>
 <h5>
 <a name="fiber_joinable_bridgehead"></a>
-  <span><a name="fiber_joinable"></a></span>
+  <span class="phrase"><a name="fiber_joinable"></a></span>
   <a class="link" href="fiber.html#fiber_joinable">Member function <code class="computeroutput">joinable</code>()</a>
 </h5>
 <p>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Returns:</span></dt>
 <dd><p>
               <code class="computeroutput"><span class="keyword">true</span></code> if <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
         </p>
 <h5>
 <a name="fiber_join_bridgehead"></a>
-  <span><a name="fiber_join"></a></span>
+  <span class="phrase"><a name="fiber_join"></a></span>
   <a class="link" href="fiber.html#fiber_join">Member function <code class="computeroutput">join</code>()</a>
 </h5>
 <p>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Preconditions:</span></dt>
 <dd><p>
               the fiber is <a class="link" href="fiber.html#fiber_joinable"><code class="computeroutput">fiber::joinable()</code></a>.
         </p>
 <h5>
 <a name="fiber_detach_bridgehead"></a>
-  <span><a name="fiber_detach"></a></span>
+  <span class="phrase"><a name="fiber_detach"></a></span>
   <a class="link" href="fiber.html#fiber_detach">Member function <code class="computeroutput">detach</code>()</a>
 </h5>
 <p>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Preconditions:</span></dt>
 <dd><p>
               the fiber is <a class="link" href="fiber.html#fiber_joinable"><code class="computeroutput">fiber::joinable()</code></a>.
         </p>
 <h5>
 <a name="fiber_get_id_bridgehead"></a>
-  <span><a name="fiber_get_id"></a></span>
+  <span class="phrase"><a name="fiber_get_id"></a></span>
   <a class="link" href="fiber.html#fiber_get_id">Member function <code class="computeroutput">get_id</code>()</a>
 </h5>
 <p>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Returns:</span></dt>
 <dd><p>
               If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
         </p>
 <h5>
 <a name="fiber_properties_bridgehead"></a>
-  <span><a name="fiber_properties"></a></span>
+  <span class="phrase"><a name="fiber_properties"></a></span>
   <a class="link" href="fiber.html#fiber_properties">Templated member
         function <code class="computeroutput">properties</code>()</a>
 </h5>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Preconditions:</span></dt>
 <dd><p>
               <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
         </p>
 <h5>
 <a name="fiber_swap_bridgehead"></a>
-  <span><a name="fiber_swap"></a></span>
+  <span class="phrase"><a name="fiber_swap"></a></span>
   <a class="link" href="fiber.html#fiber_swap">Member function <code class="computeroutput">swap</code>()</a>
 </h5>
 <p>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Effects:</span></dt>
 <dd><p>
               Exchanges the fiber of execution associated with <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> and <code class="computeroutput"><span class="identifier">other</span></code>,
         </p>
 <h5>
 <a name="swap_for_fiber_bridgehead"></a>
-  <span><a name="swap_for_fiber"></a></span>
+  <span class="phrase"><a name="swap_for_fiber"></a></span>
   <a class="link" href="fiber.html#swap_for_fiber">Non-member function
         <code class="computeroutput">swap()</code></a>
 </h5>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Effects:</span></dt>
 <dd><p>
               Same as <code class="computeroutput"><span class="identifier">l</span><span class="special">.</span><span class="identifier">swap</span><span class="special">(</span> <span class="identifier">r</span><span class="special">)</span></code>.
         </p>
 <h5>
 <a name="operator&lt;_bridgehead"></a>
-  <span><a name="operator&lt;"></a></span>
+  <span class="phrase"><a name="operator&lt;"></a></span>
   <a class="link" href="fiber.html#operator&lt;">Non-member function <code class="computeroutput">operator&lt;()</code></a>
 </h5>
 <p>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Returns:</span></dt>
 <dd><p>
               <code class="computeroutput"><span class="keyword">true</span></code> if <code class="computeroutput"><span class="identifier">l</span><span class="special">.</span><span class="identifier">get_id</span><span class="special">()</span>
         </p>
 <h5>
 <a name="use_scheduling_algorithm_bridgehead"></a>
-  <span><a name="use_scheduling_algorithm"></a></span>
+  <span class="phrase"><a name="use_scheduling_algorithm"></a></span>
   <a class="link" href="fiber.html#use_scheduling_algorithm">Non-member
         function <code class="computeroutput">use_scheduling_algorithm()</code></a>
 </h5>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Effects:</span></dt>
 <dd><p>
               Directs <span class="bold"><strong>Boost.Fiber</strong></span> to use <code class="computeroutput"><span class="identifier">SchedAlgo</span></code>, which must be a concrete
         </p>
 <h5>
 <a name="has_ready_fibers_bridgehead"></a>
-  <span><a name="has_ready_fibers"></a></span>
+  <span class="phrase"><a name="has_ready_fibers"></a></span>
   <a class="link" href="fiber.html#has_ready_fibers">Non-member function
         <code class="computeroutput">has_ready_fibers()</code></a>
 </h5>
 </pre>
 <div class="variablelist">
 <p class="title"><b></b></p>
-<dl>
+<dl class="variablelist">
 <dt><span class="term">Returns:</span></dt>
 <dd><p>
               <code class="computeroutput"><span class="keyword">true</span></code> if scheduler has