doc/html/boost/interprocess/basic_ma_idm45963400686528.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_windows_shared_memory</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_windows_shared_memory_hpp" title="Header &lt;boost/interprocess/managed_windows_shared_memory.hpp&gt;">
  10 <link rel="prev" href="wfixed_m_idm45963400692480.html" title="Type definition wfixed_managed_shared_memory">
  11 <link rel="next" href="managed__idm45963400647456.html" title="Type definition managed_windows_shared_memory">
  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="wfixed_m_idm45963400692480.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__idm45963400647456.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.interprocess.basic_ma_idm45963400686528"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template basic_managed_windows_shared_memory</span></h2>
  30 <p>boost::interprocess::basic_managed_windows_shared_memory</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_windows_shared_memory_hpp" title="Header &lt;boost/interprocess/managed_windows_shared_memory.hpp&gt;">boost/interprocess/managed_windows_shared_memory.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_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</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_ma_idm45963400686528.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="basic_ma_idm45963400686528.html#boost.interprocess.basic_ma_idm45963400686528construct-copy-destruct">construct/copy/destruct</a></span>
  43   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400675808-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  44   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400675040-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>
  45                                       <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>
  46                                       <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&amp;</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>
  47   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400669104-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>
  48                                       <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>
  49                                       <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&amp;</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>
  50   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400663088-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>
  51                                       <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>
  52   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400659840-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>
  53                                       <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>
  54   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400656576-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>
  55                                       <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>
  56   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400653312-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  57   <a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&amp;</span>
  58   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400651552-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  59   <a class="link" href="basic_ma_idm45963400686528.html#idm45963400649200-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>
  60
  61   <span class="comment">// <a class="link" href="basic_ma_idm45963400686528.html#idm45963400678864-bb">public member functions</a></span>
  62   <span class="keyword">void</span> <a class="link" href="basic_ma_idm45963400686528.html#idm45963400678304-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  63 <span class="special">}</span><span class="special">;</span></pre></div>
  64 <div class="refsect1">
  65 <a name="id-1.3.19.17.3.39.3.4"></a><h2>Description</h2>
  66 <p>A basic managed windows shared memory creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; Unlike <a class="link" href="basic_ma_idm45963400744272.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>
  67 <p>Warning: <a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> and <a class="link" href="basic_ma_idm45963400744272.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> can't communicate between them. </p>
  68 <div class="refsect2">
  69 <a name="id-1.3.19.17.3.39.3.4.4"></a><h3>
  70 <a name="boost.interprocess.basic_ma_idm45963400686528construct-copy-destruct"></a><code class="computeroutput">basic_managed_windows_shared_memory</code>
  71         public
  72        construct/copy/destruct</h3>
  73 <div class="orderedlist"><ol class="orderedlist" type="1">
  74 <li class="listitem">
  75 <pre class="literallayout"><a name="idm45963400675808-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  76 <p>Default constructor. Does nothing. Useful in combination with move semantics </p>
  77 </li>
  78 <li class="listitem">
  79 <pre class="literallayout"><a name="idm45963400675040-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>
  80                                     <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>
  81                                     <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&amp;</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>
  82 <p>Creates shared memory and creates and places the segment manager. This can throw. </p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><a name="idm45963400669104-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>
  86                                     <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>
  87                                     <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&amp;</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>
  88 <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>
  89 </li>
  90 <li class="listitem">
  91 <pre class="literallayout"><a name="idm45963400663088-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>
  92                                     <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>
  93 <p>Connects to a created shared memory and its segment manager. This can throw. </p>
  94 </li>
  95 <li class="listitem">
  96 <pre class="literallayout"><a name="idm45963400659840-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>
  97                                     <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>
  98 <p>Connects to a created shared memory and its segment manager in copy_on_write mode. This can throw. </p>
  99 </li>
 100 <li class="listitem">
 101 <pre class="literallayout"><a name="idm45963400656576-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>
 102                                     <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>
 103 <p>Connects to a created shared memory and its segment manager in read-only mode. This can throw. </p>
 104 </li>
 105 <li class="listitem">
 106 <pre class="literallayout"><a name="idm45963400653312-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&amp;&amp;</span> moved<span class="special">)</span><span class="special">;</span></pre>
 107 <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p>
 108 </li>
 109 <li class="listitem">
 110 <pre class="literallayout"><a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&amp;</span>
 111 <a name="idm45963400651552-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&amp;&amp;</span> moved<span class="special">)</span><span class="special">;</span></pre>
 112 <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p>
 113 </li>
 114 <li class="listitem">
 115 <pre class="literallayout"><a name="idm45963400649200-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>
 116 <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_ma_idm45963400686528.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>
 117 </li>
 118 </ol></div>
 119 </div>
 120 <div class="refsect2">
 121 <a name="id-1.3.19.17.3.39.3.4.5"></a><h3>
 122 <a name="idm45963400678864-bb"></a><code class="computeroutput">basic_managed_windows_shared_memory</code> public member functions</h3>
 123 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 124 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45963400678304-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_ma_idm45963400686528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
 125 <p>Swaps the ownership of the managed mapped memories managed by *this and other. Never throws. </p>
 126 </li></ol></div>
 127 </div>
 128 </div>
 129 </div>
 130 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 131 <td align="left"></td>
 132 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
 133         Distributed under the Boost Software License, Version 1.0. (See accompanying
 134         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>)
 135       </p>
 136 </div></td>
 137 </tr></table>
 138 <hr>
 139 <div class="spirit-nav">
 140 <a accesskey="p" href="wfixed_m_idm45963400692480.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__idm45963400647456.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 141 </div>
 142 </body>
 143 </html>