ceph/src/boost/libs/context/doc/html/context/stack/stack_traits.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class stack_traits</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Context">
   8 <link rel="up" href="../stack.html" title="Stack allocation">
   9 <link rel="prev" href="segmented.html" title="Class segmented_stack">
  10 <link rel="next" href="stack_context.html" title="Class stack_context">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="segmented.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stack.html"><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="stack_context.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="context.stack.stack_traits"></a><a class="link" href="stack_traits.html" title="Class stack_traits">Class <span class="emphasis"><em>stack_traits</em></span></a>
  28 </h3></div></div></div>
  29 <p>
  30         <span class="emphasis"><em>stack_traits</em></span> models a <span class="emphasis"><em>stack-traits</em></span>
  31         providing a way to access certain properites defined by the enironment. Stack
  32         allocators use <span class="emphasis"><em>stack-traits</em></span> to allocate stacks.
  33       </p>
  34 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">context</span><span class="special">/</span><span class="identifier">stack_traits</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  35
  36 <span class="keyword">struct</span> <span class="identifier">stack_traits</span> <span class="special">{</span>
  37     <span class="keyword">static</span> <span class="keyword">bool</span> <span class="identifier">is_unbounded</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span>
  38
  39     <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">page_size</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span>
  40
  41     <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">default_size</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span>
  42
  43     <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">minimum_size</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span>
  44
  45     <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">maximum_size</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span>
  46 <span class="special">}</span>
  47 </pre>
  48 <h5>
  49 <a name="context.stack.stack_traits.h0"></a>
  50         <span><a name="context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__keyword__bool__phrase___phrase_role__identifier__is_unbounded__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_traits.html#context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__keyword__bool__phrase___phrase_role__identifier__is_unbounded__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="keyword">static</span> <span class="keyword">bool</span> <span class="identifier">is_unbounded</span><span class="special">()</span></code></a>
  51       </h5>
  52 <div class="variablelist">
  53 <p class="title"><b></b></p>
  54 <dl>
  55 <dt><span class="term">Returns:</span></dt>
  56 <dd><p>
  57               Returns <code class="computeroutput"><span class="keyword">true</span></code> if the environment
  58               defines no limit for the size of a stack.
  59             </p></dd>
  60 <dt><span class="term">Throws:</span></dt>
  61 <dd><p>
  62               Nothing.
  63             </p></dd>
  64 </dl>
  65 </div>
  66 <h5>
  67 <a name="context.stack.stack_traits.h1"></a>
  68         <span><a name="context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__page_size__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_traits.html#context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__page_size__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">page_size</span><span class="special">()</span></code></a>
  69       </h5>
  70 <div class="variablelist">
  71 <p class="title"><b></b></p>
  72 <dl>
  73 <dt><span class="term">Returns:</span></dt>
  74 <dd><p>
  75               Returns the page size in bytes.
  76             </p></dd>
  77 <dt><span class="term">Throws:</span></dt>
  78 <dd><p>
  79               Nothing.
  80             </p></dd>
  81 </dl>
  82 </div>
  83 <h5>
  84 <a name="context.stack.stack_traits.h2"></a>
  85         <span><a name="context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__default_size__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_traits.html#context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__default_size__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">default_size</span><span class="special">()</span></code></a>
  86       </h5>
  87 <div class="variablelist">
  88 <p class="title"><b></b></p>
  89 <dl>
  90 <dt><span class="term">Returns:</span></dt>
  91 <dd><p>
  92               Returns a default stack size, which may be platform specific. If the
  93               stack is unbounded then the present implementation returns the maximum
  94               of <code class="computeroutput"><span class="number">64</span> <span class="identifier">kB</span></code>
  95               and <code class="computeroutput"><span class="identifier">minimum_size</span><span class="special">()</span></code>.
  96             </p></dd>
  97 <dt><span class="term">Throws:</span></dt>
  98 <dd><p>
  99               Nothing.
 100             </p></dd>
 101 </dl>
 102 </div>
 103 <h5>
 104 <a name="context.stack.stack_traits.h3"></a>
 105         <span><a name="context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__minimum_size__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_traits.html#context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__minimum_size__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">minimum_size</span><span class="special">()</span></code></a>
 106       </h5>
 107 <div class="variablelist">
 108 <p class="title"><b></b></p>
 109 <dl>
 110 <dt><span class="term">Returns:</span></dt>
 111 <dd><p>
 112               Returns the minimum size in bytes of stack defined by the environment
 113               (Win32 4kB/Win64 8kB, defined by rlimit on POSIX).
 114             </p></dd>
 115 <dt><span class="term">Throws:</span></dt>
 116 <dd><p>
 117               Nothing.
 118             </p></dd>
 119 </dl>
 120 </div>
 121 <h5>
 122 <a name="context.stack.stack_traits.h4"></a>
 123         <span><a name="context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__maximum_size__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_traits.html#context.stack.stack_traits._code__phrase_role__keyword__static__phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__maximum_size__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">maximum_size</span><span class="special">()</span></code></a>
 124       </h5>
 125 <div class="variablelist">
 126 <p class="title"><b></b></p>
 127 <dl>
 128 <dt><span class="term">Preconditions:</span></dt>
 129 <dd><p>
 130               <code class="computeroutput"><span class="identifier">is_unbounded</span><span class="special">()</span></code>
 131               returns <code class="computeroutput"><span class="keyword">false</span></code>.
 132             </p></dd>
 133 <dt><span class="term">Returns:</span></dt>
 134 <dd><p>
 135               Returns the maximum size in bytes of stack defined by the environment.
 136             </p></dd>
 137 <dt><span class="term">Throws:</span></dt>
 138 <dd><p>
 139               Nothing.
 140             </p></dd>
 141 </dl>
 142 </div>
 143 </div>
 144 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 145 <td align="left"></td>
 146 <td align="right"><div class="copyright-footer">Copyright &#169; 2014 Oliver Kowalke<p>
 147         Distributed under the Boost Software License, Version 1.0. (See accompanying
 148         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>)
 149       </p>
 150 </div></td>
 151 </tr></table>
 152 <hr>
 153 <div class="spirit-nav">
 154 <a accesskey="p" href="segmented.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stack.html"><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="stack_context.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 155 </div>
 156 </body>
 157 </html>