doc/html/boost/interprocess/mapped_region/advice_types.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Type advice_types</title>
   6 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../mapped_region.html#idp281988000" title="Description">
  10 <link rel="prev" href="../mapped_region.html" title="Class mapped_region">
  11 <link rel="next" href="../rbtree_best_fit.html" title="Class template rbtree_best_fit">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="../mapped_region.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mapped_region.html#idp281988000"><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="../rbtree_best_fit.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.interprocess.mapped_region.advice_types"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Type advice_types</span></h2>
  30 <p>boost::interprocess::mapped_region::advice_types</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../interprocess/indexes_reference.html#header.boost.interprocess.mapped_region_hpp" title="Header &lt;boost/interprocess/mapped_region.hpp&gt;">boost/interprocess/mapped_region.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">enum</span> <span class="identifier">advice_types</span> <span class="special">{</span> <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_normal">advice_normal</a>, <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_sequential">advice_sequential</a>, <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_random">advice_random</a>,
  37                     <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_willneed">advice_willneed</a>, <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_dontneed">advice_dontneed</a> <span class="special">}</span><span class="special">;</span></pre></div>
  38 <div class="refsect1">
  39 <a name="idp282117728"></a><h2>Description</h2>
  40 <p>This enum specifies region usage behaviors that an application can specify to the mapped region implementation. </p>
  41 <div class="variablelist"><dl class="variablelist compact">
  42 <dt><span class="term"><code class="computeroutput">advice_normal</code><a name="boost.interprocess.mapped_region.advice_types.advice_normal"></a></span></dt>
  43 <dd><p>Specifies that the application has no advice to give on its behavior with respect to the region. It is the default characteristic if no advice is given for a range of memory. </p></dd>
  44 <dt><span class="term"><code class="computeroutput">advice_sequential</code><a name="boost.interprocess.mapped_region.advice_types.advice_sequential"></a></span></dt>
  45 <dd><p>Specifies that the application expects to access the region sequentially from lower addresses to higher addresses. The implementation can lower the priority of preceding pages within the region once a page have been accessed. </p></dd>
  46 <dt><span class="term"><code class="computeroutput">advice_random</code><a name="boost.interprocess.mapped_region.advice_types.advice_random"></a></span></dt>
  47 <dd><p>Specifies that the application expects to access the region in a random order, and prefetching is likely not advantageous. </p></dd>
  48 <dt><span class="term"><code class="computeroutput">advice_willneed</code><a name="boost.interprocess.mapped_region.advice_types.advice_willneed"></a></span></dt>
  49 <dd><p>Specifies that the application expects to access the region in the near future. The implementation can prefetch pages of the region. </p></dd>
  50 <dt><span class="term"><code class="computeroutput">advice_dontneed</code><a name="boost.interprocess.mapped_region.advice_types.advice_dontneed"></a></span></dt>
  51 <dd><p>Specifies that the application expects that it will not access the region in the near future. The implementation can unload pages within the range to save system resources. </p></dd>
  52 </dl></div>
  53 </div>
  54 </div>
  55 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  56 <td align="left"></td>
  57 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
  58         Distributed under the Boost Software License, Version 1.0. (See accompanying
  59         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>)
  60       </p>
  61 </div></td>
  62 </tr></table>
  63 <hr>
  64 <div class="spirit-nav">
  65 <a accesskey="p" href="../mapped_region.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mapped_region.html#idp281988000"><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="../rbtree_best_fit.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  66 </div>
  67 </body>
  68 </html>