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=UTF-8"> 5<title>Class xsi_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.xsi_shared_memory_hpp" title="Header <boost/interprocess/xsi_shared_memory.hpp>"> 10<link rel="prev" href="xsi_key.html" title="Class xsi_key"> 11<link rel="next" href="../../intrusive.html" title="Chapter 19. Boost.Intrusive"> 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="xsi_key.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.xsi_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="../../intrusive.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.interprocess.xsi_shared_memory"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class xsi_shared_memory</span></h2> 30<p>boost::interprocess::xsi_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: <<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.xsi_shared_memory_hpp" title="Header <boost/interprocess/xsi_shared_memory.hpp>">boost/interprocess/xsi_shared_memory.hpp</a>> 34 35</span> 36<span class="keyword">class</span> <a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// <a class="link" href="xsi_shared_memory.html#boost.interprocess.xsi_shared_memoryconstruct-copy-destruct">construct/copy/destruct</a></span> 39 <a class="link" href="xsi_shared_memory.html#idm45304009611360-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 40 <a class="link" href="xsi_shared_memory.html#idm45304009609888-bb"><span class="identifier">xsi_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">int</span><span class="special">)</span><span class="special">;</span> 41 <a class="link" href="xsi_shared_memory.html#idm45304009607536-bb"><span class="identifier">xsi_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> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <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> 42 <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> 43 <a class="link" href="xsi_shared_memory.html#idm45304009602064-bb"><span class="identifier">xsi_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> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <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> 44 <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> 45 <a class="link" href="xsi_shared_memory.html#idm45304009596576-bb"><span class="identifier">xsi_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> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 <a class="link" href="xsi_shared_memory.html#idm45304009593808-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 47 <a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> <a class="link" href="xsi_shared_memory.html#idm45304009592000-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 48 <a class="link" href="xsi_shared_memory.html#idm45304009589632-bb"><span class="special">~</span><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 49 50 <span class="comment">// <a class="link" href="xsi_shared_memory.html#idm45304009617376-bb">public member functions</a></span> 51 <span class="keyword">void</span> <a class="link" href="xsi_shared_memory.html#idm45304009616816-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 52 <span class="keyword">int</span> <a class="link" href="xsi_shared_memory.html#idm45304009614672-bb"><span class="identifier">get_shmid</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 53 <span class="identifier">mapping_handle_t</span> <a class="link" href="xsi_shared_memory.html#idm45304009613088-bb"><span class="identifier">get_mapping_handle</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 54 55 <span class="comment">// <a class="link" href="xsi_shared_memory.html#idm45304009588816-bb">public static functions</a></span> 56 <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="xsi_shared_memory.html#idm45304009588256-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> 57<span class="special">}</span><span class="special">;</span></pre></div> 58<div class="refsect1"> 59<a name="id-1.3.19.17.3.80.4.4"></a><h2>Description</h2> 60<p>A class that wraps XSI (System V) shared memory. Unlike <a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a>, <a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> needs a valid <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> to identify a shared memory object.</p> 61<p>Warning: XSI shared memory and interprocess portable shared memory (<a class="link" href="shared_memory_object.html" title="Class shared_memory_object">boost::interprocess::shared_memory_object</a>) can't communicate between them. </p> 62<div class="refsect2"> 63<a name="id-1.3.19.17.3.80.4.4.4"></a><h3> 64<a name="boost.interprocess.xsi_shared_memoryconstruct-copy-destruct"></a><code class="computeroutput">xsi_shared_memory</code> 65 public 66 construct/copy/destruct</h3> 67<div class="orderedlist"><ol class="orderedlist" type="1"> 68<li class="listitem"> 69<pre class="literallayout"><a name="idm45304009611360-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 70<p>Default constructor. Represents an empty <code class="computeroutput"><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a></code>. </p> 71</li> 72<li class="listitem"> 73<pre class="literallayout"><a name="idm45304009609888-bb"></a><span class="identifier">xsi_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">int</span> shmid<span class="special">)</span><span class="special">;</span></pre> 74<p>Initializes *this with a shmid previously obtained (possibly from another process) This lower-level initializer allows shared memory mapping without having a key. </p> 75</li> 76<li class="listitem"> 77<pre class="literallayout"><a name="idm45304009607536-bb"></a><span class="identifier">xsi_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> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> 78 <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> 79<p>Creates a new XSI shared memory from 'key', with size "size" and permissions "perm". If the shared memory previously exists, throws an error. </p> 80</li> 81<li class="listitem"> 82<pre class="literallayout"><a name="idm45304009602064-bb"></a><span class="identifier">xsi_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> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> 83 <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> 84<p>Opens an existing shared memory with identifier 'key' or creates a new XSI shared memory from identifier 'key', with size "size" and permissions "perm". </p> 85</li> 86<li class="listitem"> 87<pre class="literallayout"><a name="idm45304009596576-bb"></a><span class="identifier">xsi_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> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre> 88<p>Tries to open a XSI shared memory with identifier 'key' If the shared memory does not previously exist, it throws an error. </p> 89</li> 90<li class="listitem"> 91<pre class="literallayout"><a name="idm45304009593808-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> 92<p>Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw </p> 93</li> 94<li class="listitem"> 95<pre class="literallayout"><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> <a name="idm45304009592000-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> 96<p>Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw </p> 97</li> 98<li class="listitem"> 99<pre class="literallayout"><a name="idm45304009589632-bb"></a><span class="special">~</span><span class="identifier">xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 100<p>Destroys *this. The shared memory won't be destroyed, just this connection to it. Use remove() to destroy the shared memory. </p> 101</li> 102</ol></div> 103</div> 104<div class="refsect2"> 105<a name="id-1.3.19.17.3.80.4.4.5"></a><h3> 106<a name="idm45304009617376-bb"></a><code class="computeroutput">xsi_shared_memory</code> public member functions</h3> 107<div class="orderedlist"><ol class="orderedlist" type="1"> 108<li class="listitem"> 109<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304009616816-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Swaps two xsi_shared_memorys. Does not throw. </li> 110<li class="listitem"> 111<pre class="literallayout"><span class="keyword">int</span> <a name="idm45304009614672-bb"></a><span class="identifier">get_shmid</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 112<p>Returns the shared memory ID that identifies the shared memory </p> 113</li> 114<li class="listitem"> 115<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idm45304009613088-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 116<p>Returns the mapping handle. Never throws </p> 117</li> 118</ol></div> 119</div> 120<div class="refsect2"> 121<a name="id-1.3.19.17.3.80.4.4.6"></a><h3> 122<a name="idm45304009588816-bb"></a><code class="computeroutput">xsi_shared_memory</code> public static functions</h3> 123<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 124<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idm45304009588256-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">int</span> shmid<span class="special">)</span><span class="special">;</span></pre> 125<p>Erases the XSI shared memory object identified by shmid from the system. Returns false on error. 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 © 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="xsi_key.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.xsi_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="../../intrusive.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 141</div> 142</body> 143</html> 144
