blob: 41087281872615ca0e5dcc2e05a1da35f7a290fa [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template basic_managed_external_buffer</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<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;">
<link rel="prev" href="message_queue.html" title="Class message_queue">
<link rel="next" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="message_queue.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>
</div>
<div class="refentry">
<a name="boost.interprocess.basic_managed_external__id818699"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_managed_external_buffer</span></h2>
<p>boost::interprocess::basic_managed_external_buffer</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<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;
</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>
<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>
<span class="keyword">class</span> <a class="link" href="basic_managed_external__id818699.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="basic_managed_external__id818699.html#boost.interprocess.basic_managed_external__id818699construct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="basic_managed_external__id818699.html#id818765-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_managed_external__id818699.html#id818771-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">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_managed_external__id818699.html#id818793-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">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_managed_external__id818699.html#id818815-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="basic_managed_external__id818699.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>
basic_managed_external_buffer&amp; <a class="link" href="basic_managed_external__id818699.html#id818828-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed_external__id818699.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>
<span class="comment">// <a class="link" href="basic_managed_external__id818699.html#id818728-bb">public member functions</a></span>
<span class="keyword">void</span> <a class="link" href="basic_managed_external__id818699.html#id818731-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_managed_external__id818699.html#id818745-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed_external__id818699.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>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id1467295"></a><h2>Description</h2>
<p>A basic user memory named object creation class. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; </p>
<div class="refsect2">
<a name="id1467307"></a><h3>
<a name="boost.interprocess.basic_managed_external__id818699construct-copy-destruct"></a><code class="computeroutput">basic_managed_external_buffer</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id818765-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Default constructor. Does nothing. Useful in combination with move semantics </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id818771-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">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">)</span><span class="special">;</span></pre>Creates and places the segment manager. This can throw. </li>
<li class="listitem">
<pre class="literallayout"><a name="id818793-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">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">)</span><span class="special">;</span></pre>Creates and places the segment manager. This can throw. </li>
<li class="listitem">
<pre class="literallayout"><a name="id818815-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="basic_managed_external__id818699.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>
<li class="listitem">
<pre class="literallayout">basic_managed_external_buffer&amp;
<a name="id818828-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed_external__id818699.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>
</ol></div>
</div>
<div class="refsect2">
<a name="id1467606"></a><h3>
<a name="id818728-bb"></a><code class="computeroutput">basic_managed_external_buffer</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id818731-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id818745-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed_external__id818699.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>
<p>Swaps the ownership of the managed heap memories managed by *this and other. Never throws. </p>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2005 - 2010 Ion Gaztanaga<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="message_queue.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>
</div>
</body>
</html>