memory
/
classfoonathan_1_1memory_1_1temporary...

<!-- HTML header for doxygen 1.8.16-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>memory: temporary_stack_initializer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">memory
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<div id="main-nav">
    <ul class="sm sm-dox" id="main-menu">
        <li><a href="index.html">Main Page</a></li>
        <li><a href="md_doc_tutorial.html">Tutorial</a></li>
        <li><a href="namespacefoonathan_1_1memory.html">Index</a></li>
        <li><a href="files.html">Files</a></li>
    </ul>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacefoonathan.html">foonathan</a></li><li class="navelem"><a class="el" href="namespacefoonathan_1_1memory.html">memory</a></li><li class="navelem"><a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html">temporary_stack_initializer</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-attribs">Constants</a> &#124;
<a href="#pub-methods">Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">temporary_stack_initializer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manually takes care of the lifetime of the per-thread <a class="el" href="classfoonathan_1_1memory_1_1temporary__stack.html">temporary_stack</a>. </p>
<p>The constructor will create it, if not already done, and the destructor will destroy it, if not already done. </p><dl class="section note"><dt>Note</dt><dd>If there are multiple objects in a thread, this will lead to unnecessary construction and destruction of the stack. It is thus adviced to create one object on the top-level function of the thread, e.g. in <code>main()</code>. </dd>
<dd>
If <code>FOONATHAN_MEMORY_TEMPORARY_STACK_MODE == 2</code>, it is not necessary to use this class, the nifty counter will clean everything upon program termination. But it can still be used as an optimization if you have a thread that is terminated long before program exit. The automatic clean up will only occur much later. </dd>
<dd>
If <code>FOONATHAN_MEMORY_TEMPORARY_STACK_MODE == 0</code>, the use of this class has no effect, because the per-thread stack is disabled. </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Constants</h2></td></tr>
<tr class="memitem:a65cd8cbf191f53bd776cff6f3f14ea11"><td class="memItemLeft" align="right" valign="top"><a id="a65cd8cbf191f53bd776cff6f3f14ea11"></a>
static constexpr std::size_t&#160;</td><td class="memItemRight" valign="bottom"><b>default_stack_size</b></td></tr>
<tr class="separator:a65cd8cbf191f53bd776cff6f3f14ea11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b19314a477a5974aa97b036c5dfdc1b"><td class="memItemLeft" align="right" valign="top"><a id="a5b19314a477a5974aa97b036c5dfdc1b"></a>
static const struct foonathan::memory::temporary_stack_initializer::defer_create_t&#160;</td><td class="memItemRight" valign="bottom"><b>defer_create</b></td></tr>
<tr class="separator:a5b19314a477a5974aa97b036c5dfdc1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Member Functions</h2></td></tr>
<tr class="memitem:abb910440a03fe0c6f180d4de884bf980"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html#abb910440a03fe0c6f180d4de884bf980">temporary_stack_initializer</a> (defer_create_t) noexcept</td></tr>
<tr class="separator:abb910440a03fe0c6f180d4de884bf980"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac339e7bac0a3383ace6d22380dd4382"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html#aac339e7bac0a3383ace6d22380dd4382">temporary_stack_initializer</a> (std::size_t initial_size=default_stack_size)</td></tr>
<tr class="separator:aac339e7bac0a3383ace6d22380dd4382"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace31ea47b6021b3b1a66b81b262e8960"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html#ace31ea47b6021b3b1a66b81b262e8960">~temporary_stack_initializer</a> () noexcept</td></tr>
<tr class="separator:ace31ea47b6021b3b1a66b81b262e8960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa7875601c0334e9db5046a8a77a4b9e"><td class="memItemLeft" align="right" valign="top"><a id="aaa7875601c0334e9db5046a8a77a4b9e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>temporary_stack_initializer</b> (<a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html">temporary_stack_initializer</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:aaa7875601c0334e9db5046a8a77a4b9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3950de4d3bdae492be667a283af2ebbb"><td class="memItemLeft" align="right" valign="top"><a id="a3950de4d3bdae492be667a283af2ebbb"></a>
<a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html">temporary_stack_initializer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html">temporary_stack_initializer</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:a3950de4d3bdae492be667a283af2ebbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructors</h2>
<a id="abb910440a03fe0c6f180d4de884bf980"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb910440a03fe0c6f180d4de884bf980">&#9670;&nbsp;</a></span>temporary_stack_initializer() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html">temporary_stack_initializer</a> </td>
          <td>(</td>
          <td class="paramtype">defer_create_t&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Does not create the per-thread stack. It will be created by the first call to <a class="el" href="namespacefoonathan_1_1memory.html#a7f311d60d4857926d16396fc6a3be15a">get_temporary_stack()</a> in the current thread. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>If <code>FOONATHAN_MEMORY_TEMPORARY_STACK_MODE == 0</code>, this function has no effect. </dd></dl>

</div>
</div>
<a id="aac339e7bac0a3383ace6d22380dd4382"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac339e7bac0a3383ace6d22380dd4382">&#9670;&nbsp;</a></span>temporary_stack_initializer() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html">temporary_stack_initializer</a> </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>initial_size</em> = <code>default_stack_size</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Creates the per-thread stack with the given default size if it wasn't already created. </dd></dl>
<dl class="section user"><dt>Requires:</dt><dd><code>initial_size</code> must not be <code>0</code> if <code>FOONATHAN_MEMORY_TEMPORARY_STACK_MODE != 0</code>. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>If <code>FOONATHAN_MEMORY_TEMPORARY_STACK_MODE == 0</code>, this function will issue a warning in debug mode. This can be disabled by passing <code>0</code> as the initial size. </dd></dl>

</div>
</div>
<a id="ace31ea47b6021b3b1a66b81b262e8960"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace31ea47b6021b3b1a66b81b262e8960">&#9670;&nbsp;</a></span>~temporary_stack_initializer()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html">temporary_stack_initializer</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Destroys the per-thread stack if it isn't already destroyed. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.16-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>