Imported Upstream version 1.63.0
[platform/upstream/boost.git] / doc / html / boost / interprocess / basic_managed__idp46619440.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>Class template basic_managed_external_buffer</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="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_external_buffer_hpp" title="Header &lt;boost/interprocess/managed_external_buffer.hpp&gt;">
10 <link rel="prev" href="message_queue.html" title="Type definition message_queue">
11 <link rel="next" href="managed_external_buffer.html" title="Type definition managed_external_buffer">
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="message_queue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_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="managed_external_buffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.interprocess.basic_managed__idp46619440"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class template basic_managed_external_buffer</span></h2>
30 <p>boost::interprocess::basic_managed_external_buffer</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.managed_external_buffer_hpp" title="Header &lt;boost/interprocess/managed_external_buffer.hpp&gt;">boost/interprocess/managed_external_buffer.hpp</a>&gt;
34
35 </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> 
36          <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> 
37 <span class="keyword">class</span> <a class="link" href="basic_managed__idp46619440.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">{</span>
38 <span class="keyword">public</span><span class="special">:</span>
39   <span class="comment">// types</span>
40   <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__idp46619440.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
41
42   <span class="comment">// <a class="link" href="basic_managed__idp46619440.html#boost.interprocess.basic_managed__idp46619440construct-copy-destruct">construct/copy/destruct</a></span>
43   <a class="link" href="basic_managed__idp46619440.html#idp46628128-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
44   <a class="link" href="basic_managed__idp46619440.html#idp46628896-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>
45   <a class="link" href="basic_managed__idp46619440.html#idp46631712-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>
46   <a class="link" href="basic_managed__idp46619440.html#idp46634528-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="basic_managed__idp46619440.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   <a class="link" href="basic_managed__idp46619440.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&amp;</span> <a class="link" href="basic_managed__idp46619440.html#idp46636160-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp46619440.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>
48
49   <span class="comment">// <a class="link" href="basic_managed__idp46619440.html#idp46623536-bb">public member functions</a></span>
50   <span class="keyword">void</span> <a class="link" href="basic_managed__idp46619440.html#idp46624096-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>
51   <span class="keyword">void</span> <a class="link" href="basic_managed__idp46619440.html#idp46625632-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp46619440.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>
52 <span class="special">}</span><span class="special">;</span></pre></div>
53 <div class="refsect1">
54 <a name="idp375772864"></a><h2>Description</h2>
55 <p>A basic user memory named object creation class. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; </p>
56 <div class="refsect2">
57 <a name="idp375773776"></a><h3>
58 <a name="boost.interprocess.basic_managed__idp46619440construct-copy-destruct"></a><code class="computeroutput">basic_managed_external_buffer</code> 
59         public
60        construct/copy/destruct</h3>
61 <div class="orderedlist"><ol class="orderedlist" type="1">
62 <li class="listitem">
63 <pre class="literallayout"><a name="idp46628128-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
64 <p>Default constructor. Does nothing. Useful in combination with move semantics </p>
65 </li>
66 <li class="listitem">
67 <pre class="literallayout"><a name="idp46628896-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>
68 <li class="listitem">
69 <pre class="literallayout"><a name="idp46631712-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>
70 <li class="listitem">
71 <pre class="literallayout"><a name="idp46634528-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="basic_managed__idp46619440.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>
72 <li class="listitem">
73 <pre class="literallayout"><a class="link" href="basic_managed__idp46619440.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&amp;</span> 
74 <a name="idp46636160-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp46619440.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>
75 </ol></div>
76 </div>
77 <div class="refsect2">
78 <a name="idp375808816"></a><h3>
79 <a name="idp46623536-bb"></a><code class="computeroutput">basic_managed_external_buffer</code> public member functions</h3>
80 <div class="orderedlist"><ol class="orderedlist" type="1">
81 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp46624096-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>
82 <li class="listitem">
83 <pre class="literallayout"><span class="keyword">void</span> <a name="idp46625632-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp46619440.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>
84 <p>Swaps the ownership of the managed heap memories managed by *this and other. Never throws. </p>
85 </li>
86 </ol></div>
87 </div>
88 </div>
89 </div>
90 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
91 <td align="left"></td>
92 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
93         Distributed under the Boost Software License, Version 1.0. (See accompanying
94         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>)
95       </p>
96 </div></td>
97 </tr></table>
98 <hr>
99 <div class="spirit-nav">
100 <a accesskey="p" href="message_queue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_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="managed_external_buffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
101 </div>
102 </body>
103 </html>