diff options
Diffstat (limited to 'doc/html/boost/interprocess/basic_managed__idp35404080.html')
-rw-r--r-- | doc/html/boost/interprocess/basic_managed__idp35404080.html | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/doc/html/boost/interprocess/basic_managed__idp35404080.html b/doc/html/boost/interprocess/basic_managed__idp35404080.html new file mode 100644 index 0000000000..2271e0f78a --- /dev/null +++ b/doc/html/boost/interprocess/basic_managed__idp35404080.html @@ -0,0 +1,143 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template basic_managed_windows_shared_memory</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_hpp" title="Header <boost/interprocess/managed_windows_shared_memory.hpp>"> +<link rel="prev" href="wfixed_managed_idp35398128.html" title="Type definition wfixed_managed_shared_memory"> +<link rel="next" href="managed_window_idp35443152.html" title="Type definition managed_windows_shared_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="wfixed_managed_idp35398128.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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_window_idp35443152.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.interprocess.basic_managed__idp35404080"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template basic_managed_windows_shared_memory</span></h2> +<p>boost::interprocess::basic_managed_windows_shared_memory</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: <<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_hpp" title="Header <boost/interprocess/managed_windows_shared_memory.hpp>">boost/interprocess/managed_windows_shared_memory.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</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"><</span> <span class="keyword">class</span> <span class="identifier">IndexConfig</span> <span class="special">></span> <span class="keyword">class</span> IndexType<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <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__idp35404080.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_managed__idp35404080.html#boost.interprocess.basic_managed__idp35404080construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_managed__idp35404080.html#idp35414800-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp35404080.html#idp35415568-bb"><span class="identifier">basic_managed_windows_shared_memory</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">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp35404080.html#idp35421504-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp35404080.html#idp35427520-bb"><span class="identifier">basic_managed_windows_shared_memory</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">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp35404080.html#idp35430768-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp35404080.html#idp35434032-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp35404080.html#idp35437296-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> + <a class="link" href="basic_managed__idp35404080.html#idp35439056-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp35404080.html#idp35441408-bb"><span class="special">~</span><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_managed__idp35404080.html#idp35411744-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_managed__idp35404080.html#idp35412304-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp242837504"></a><h2>Description</h2> +<p>A basic managed windows shared memory creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> Unlike <a class="link" href="basic_managed__idp35346336.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a>, it has no kernel persistence and the shared memory is destroyed when all processes destroy all their <a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> objects and mapped regions for the same shared memory or the processes end/crash.</p> +<p>Warning: <a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> and <a class="link" href="basic_managed__idp35346336.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> can't communicate between them. </p> +<div class="refsect2"> +<a name="idp242842592"></a><h3> +<a name="boost.interprocess.basic_managed__idp35404080construct-copy-destruct"></a><code class="computeroutput">basic_managed_windows_shared_memory</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idp35414800-bb"></a><span class="identifier">basic_managed_windows_shared_memory</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="idp35415568-bb"></a><span class="identifier">basic_managed_windows_shared_memory</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">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> + <span class="identifier">size_type</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> +<p>Creates shared memory and creates and places the segment manager. This can throw. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp35421504-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> + <span class="identifier">size_type</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> +<p>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp35427520-bb"></a><span class="identifier">basic_managed_windows_shared_memory</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">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<p>Connects to a created shared memory and its segment manager. This can throw. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp35430768-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<p>Connects to a created shared memory and its segment manager in copy_on_write mode. This can throw. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp35434032-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<p>Connects to a created shared memory and its segment manager in read-only mode. This can throw. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp35437296-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> +<a name="idp35439056-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp35441408-bb"></a><span class="special">~</span><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Destroys *this and indicates that the calling process is finished using the resource. All mapped regions are still valid after destruction. When all mapped regions and <code class="computeroutput"><a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a></code> objects referring the shared memory are destroyed, the operating system will destroy the shared memory. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp242938336"></a><h3> +<a name="idp35411744-bb"></a><code class="computeroutput">basic_managed_windows_shared_memory</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="idp35412304-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp35404080.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p>Swaps the ownership of the managed mapped 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 © 2005-2015 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="wfixed_managed_idp35398128.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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_window_idp35443152.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |