doc/html/boost/interprocess/basic_managed_ext_id992111.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_managed_external_buffer</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../boost_interprocess_reference.html#header.boost.interprocess.managed_external_buffer_hpp" title="Header &lt;boost/interprocess/managed_external_buffer.hpp&gt;">
   9 <link rel="prev" href="message_queue_t.html" title="Class template message_queue_t">
  10 <link rel="next" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">
  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="message_queue_t.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.managed_external_buffer_hpp"><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="basic_managed_heap_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.interprocess.basic_managed_ext_id992111"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template basic_managed_external_buffer</span></h2>
  29 <p>boost::interprocess::basic_managed_external_buffer</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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="../../boost_interprocess_reference.html#header.boost.interprocess.managed_external_buffer_hpp" title="Header &lt;boost/interprocess/managed_external_buffer.hpp&gt;">boost/interprocess/managed_external_buffer.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharType<span class="special">,</span> <span class="keyword">typename</span> AllocationAlgorithm<span class="special">,</span>
  35          <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IndexConfig</span> <span class="special">&gt;</span> <span class="keyword">class</span> IndexType<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="basic_managed_ext_id992111.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <span class="keyword">typedef</span> <span class="identifier">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.basic_managed_ext_id992111.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="basic_managed_ext_id992111.html#boost.interprocess.basic_managed_ext_id992111construct-copy-destruct">construct/copy/destruct</a></span>
  42   <a class="link" href="basic_managed_ext_id992111.html#id992183-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  43   <a class="link" href="basic_managed_ext_id992111.html#id992189-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  44   <a class="link" href="basic_managed_ext_id992111.html#id992211-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  45   <a class="link" href="basic_managed_ext_id992111.html#id992233-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="basic_managed_ext_id992111.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  46   basic_managed_external_buffer&amp; <a class="link" href="basic_managed_ext_id992111.html#id992246-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed_ext_id992111.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="basic_managed_ext_id992111.html#id992145-bb">public member functions</a></span>
  49   <span class="keyword">void</span> <a class="link" href="basic_managed_ext_id992111.html#id992149-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  50   <span class="keyword">void</span> <a class="link" href="basic_managed_ext_id992111.html#id992162-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed_ext_id992111.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  51 <span class="special">}</span><span class="special">;</span></pre></div>
  52 <div class="refsect1">
  53 <a name="id1803132"></a><h2>Description</h2>
  54 <p>A basic user memory named object creation class. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; </p>
  55 <div class="refsect2">
  56 <a name="id1803143"></a><h3>
  57 <a name="boost.interprocess.basic_managed_ext_id992111construct-copy-destruct"></a><code class="computeroutput">basic_managed_external_buffer</code>
  58         public
  59        construct/copy/destruct</h3>
  60 <div class="orderedlist"><ol class="orderedlist" type="1">
  61 <li class="listitem">
  62 <pre class="literallayout"><a name="id992183-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  63 <p>Default constructor. Does nothing. Useful in combination with move semantics </p>
  64 </li>
  65 <li class="listitem">
  66 <pre class="literallayout"><a name="id992189-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> addr<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre>Creates and places the segment manager. This can throw. </li>
  67 <li class="listitem">
  68 <pre class="literallayout"><a name="id992211-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> addr<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre>Creates and places the segment manager. This can throw. </li>
  69 <li class="listitem">
  70 <pre class="literallayout"><a name="id992233-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="basic_managed_ext_id992111.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&amp;&amp;</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li>
  71 <li class="listitem">
  72 <pre class="literallayout">basic_managed_external_buffer&amp;
  73 <a name="id992246-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed_ext_id992111.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&amp;&amp;</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li>
  74 </ol></div>
  75 </div>
  76 <div class="refsect2">
  77 <a name="id1803422"></a><h3>
  78 <a name="id992145-bb"></a><code class="computeroutput">basic_managed_external_buffer</code> public member functions</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1">
  80 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id992149-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre></li>
  81 <li class="listitem">
  82 <pre class="literallayout"><span class="keyword">void</span> <a name="id992162-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed_ext_id992111.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
  83 <p>Swaps the ownership of the managed heap memories managed by *this and other. Never throws. </p>
  84 </li>
  85 </ol></div>
  86 </div>
  87 </div>
  88 </div>
  89 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  90 <td align="left"></td>
  91 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2011 Ion Gaztanaga<p>
  92         Distributed under the Boost Software License, Version 1.0. (See accompanying
  93         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>)
  94       </p>
  95 </div></td>
  96 </tr></table>
  97 <hr>
  98 <div class="spirit-nav">
  99 <a accesskey="p" href="message_queue_t.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.managed_external_buffer_hpp"><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="basic_managed_heap_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 100 </div>
 101 </body>
 102 </html>