projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 7c673cae FG |
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 1. 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><h4 class="title"> | |
| 27 | <a name="context.abstract_context.stack.stack_traits"></a><a class="link" href="stack_traits.html" title="Class stack_traits">Class | |
| 28 | <span class="emphasis"><em>stack_traits</em></span></a> | |
| 29 | </h4></div></div></div> | |
| 30 | <p> | |
| 31 | <span class="emphasis"><em>stack_traits</em></span> models a <span class="emphasis"><em>stack-traits</em></span> | |
| 32 | providing a way to access certain properites defined by the enironment. | |
| 33 | Stack allocators use <span class="emphasis"><em>stack-traits</em></span> to allocate stacks. | |
| 34 | </p> | |
| 35 | <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</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">></span> | |
| 36 | ||
| 37 | <span class="keyword">struct</span> <span class="identifier">stack_traits</span> | |
| 38 | <span class="special">{</span> | |
| 39 | <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> | |
| 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">page_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">default_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">minimum_size</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span> | |
| 46 | ||
| 47 | <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> | |
| 48 | <span class="special">}</span> | |
| 49 | </pre> | |
| 50 | <h6> | |
| 51 | <a name="context.abstract_context.stack.stack_traits.h0"></a> | |
| 52 | <span><a name="context.abstract_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.abstract_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> | |
| 53 | </h6> | |
| 54 | <div class="variablelist"> | |
| 55 | <p class="title"><b></b></p> | |
| 56 | <dl> | |
| 57 | <dt><span class="term">Returns:</span></dt> | |
| 58 | <dd><p> | |
| 59 | Returns <code class="computeroutput"><span class="keyword">true</span></code> if the | |
| 60 | environment defines no limit for the size of a stack. | |
| 61 | </p></dd> | |
| 62 | <dt><span class="term">Throws:</span></dt> | |
| 63 | <dd><p> | |
| 64 | Nothing. | |
| 65 | </p></dd> | |
| 66 | </dl> | |
| 67 | </div> | |
| 68 | <h6> | |
| 69 | <a name="context.abstract_context.stack.stack_traits.h1"></a> | |
| 70 | <span><a name="context.abstract_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.abstract_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> | |
| 71 | </h6> | |
| 72 | <div class="variablelist"> | |
| 73 | <p class="title"><b></b></p> | |
| 74 | <dl> | |
| 75 | <dt><span class="term">Returns:</span></dt> | |
| 76 | <dd><p> | |
| 77 | Returns the page size in bytes. | |
| 78 | </p></dd> | |
| 79 | <dt><span class="term">Throws:</span></dt> | |
| 80 | <dd><p> | |
| 81 | Nothing. | |
| 82 | </p></dd> | |
| 83 | </dl> | |
| 84 | </div> | |
| 85 | <h6> | |
| 86 | <a name="context.abstract_context.stack.stack_traits.h2"></a> | |
| 87 | <span><a name="context.abstract_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.abstract_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> | |
| 88 | </h6> | |
| 89 | <div class="variablelist"> | |
| 90 | <p class="title"><b></b></p> | |
| 91 | <dl> | |
| 92 | <dt><span class="term">Returns:</span></dt> | |
| 93 | <dd><p> | |
| 94 | Returns a default stack size, which may be platform specific. If | |
| 95 | the stack is unbounded then the present implementation returns the | |
| 96 | maximum of <code class="computeroutput"><span class="number">64</span> <span class="identifier">kB</span></code> | |
| 97 | and <code class="computeroutput"><span class="identifier">minimum_size</span><span class="special">()</span></code>. | |
| 98 | </p></dd> | |
| 99 | <dt><span class="term">Throws:</span></dt> | |
| 100 | <dd><p> | |
| 101 | Nothing. | |
| 102 | </p></dd> | |
| 103 | </dl> | |
| 104 | </div> | |
| 105 | <h6> | |
| 106 | <a name="context.abstract_context.stack.stack_traits.h3"></a> | |
| 107 | <span><a name="context.abstract_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.abstract_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> | |
| 108 | </h6> | |
| 109 | <div class="variablelist"> | |
| 110 | <p class="title"><b></b></p> | |
| 111 | <dl> | |
| 112 | <dt><span class="term">Returns:</span></dt> | |
| 113 | <dd><p> | |
| 114 | Returns the minimum size in bytes of stack defined by the environment | |
| 115 | (Win32 4kB/Win64 8kB, defined by rlimit on POSIX). | |
| 116 | </p></dd> | |
| 117 | <dt><span class="term">Throws:</span></dt> | |
| 118 | <dd><p> | |
| 119 | Nothing. | |
| 120 | </p></dd> | |
| 121 | </dl> | |
| 122 | </div> | |
| 123 | <h6> | |
| 124 | <a name="context.abstract_context.stack.stack_traits.h4"></a> | |
| 125 | <span><a name="context.abstract_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.abstract_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> | |
| 126 | </h6> | |
| 127 | <div class="variablelist"> | |
| 128 | <p class="title"><b></b></p> | |
| 129 | <dl> | |
| 130 | <dt><span class="term">Preconditions:</span></dt> | |
| 131 | <dd><p> | |
| 132 | <code class="computeroutput"><span class="identifier">is_unbounded</span><span class="special">()</span></code> | |
| 133 | returns <code class="computeroutput"><span class="keyword">false</span></code>. | |
| 134 | </p></dd> | |
| 135 | <dt><span class="term">Returns:</span></dt> | |
| 136 | <dd><p> | |
| 137 | Returns the maximum size in bytes of stack defined by the environment. | |
| 138 | </p></dd> | |
| 139 | <dt><span class="term">Throws:</span></dt> | |
| 140 | <dd><p> | |
| 141 | Nothing. | |
| 142 | </p></dd> | |
| 143 | </dl> | |
| 144 | </div> | |
| 145 | </div> | |
| 146 | <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> | |
| 147 | <td align="left"></td> | |
| 148 | <td align="right"><div class="copyright-footer">Copyright © 2014 Oliver Kowalke<p> | |
| 149 | Distributed under the Boost Software License, Version 1.0. (See accompanying | |
| 150 | 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>) | |
| 151 | </p> | |
| 152 | </div></td> | |
| 153 | </tr></table> | |
| 154 | <hr> | |
| 155 | <div class="spirit-nav"> | |
| 156 | <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> | |
| 157 | </div> | |
| 158 | </body> | |
| 159 | </html> |