3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class xsi_shared_memory</title>
5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8 <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.xsi_shared_memory_hpp" title="Header <boost/interprocess/xsi_shared_memory.hpp>">
9 <link rel="prev" href="xsi_key.html" title="Class xsi_key">
10 <link rel="next" href="../../intrusive.html" title="Chapter 15. Boost.Intrusive">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
15 <td align="center"><a href="../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <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 class="refentry">
26 <a name="boost.interprocess.xsi_shared_memory"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class xsi_shared_memory</span></h2>
29 <p>boost::interprocess::xsi_shared_memory</p>
31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32 <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>>
35 <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>
36 <span class="keyword">public</span><span class="special">:</span>
37 <span class="comment">// <a class="link" href="xsi_shared_memory.html#boost.interprocess.xsi_shared_memoryconstruct-copy-destruct">construct/copy/destruct</a></span>
38 <a class="link" href="xsi_shared_memory.html#idp67408752-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
39 <a class="link" href="xsi_shared_memory.html#idp67410224-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>
40 <a class="link" href="xsi_shared_memory.html#idp67412576-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>
41 <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>
42 <a class="link" href="xsi_shared_memory.html#idp67418048-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>
43 <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>
44 <a class="link" href="xsi_shared_memory.html#idp67423536-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>
45 <a class="link" href="xsi_shared_memory.html#idp67426304-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>
46 <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#idp67428112-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>
47 <a class="link" href="xsi_shared_memory.html#idp67430480-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 <span class="comment">// <a class="link" href="xsi_shared_memory.html#idp67402736-bb">public member functions</a></span>
50 <span class="keyword">void</span> <a class="link" href="xsi_shared_memory.html#idp67403296-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>
51 <span class="keyword">int</span> <a class="link" href="xsi_shared_memory.html#idp67405440-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>
52 <span class="identifier">mapping_handle_t</span> <a class="link" href="xsi_shared_memory.html#idp67407024-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 <span class="comment">// <a class="link" href="xsi_shared_memory.html#idp67431296-bb">public static functions</a></span>
55 <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="xsi_shared_memory.html#idp67431856-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
56 <span class="special">}</span><span class="special">;</span></pre></div>
57 <div class="refsect1">
58 <a name="idp252652896"></a><h2>Description</h2>
59 <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>
60 <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>
61 <div class="refsect2">
62 <a name="idp252657472"></a><h3>
63 <a name="boost.interprocess.xsi_shared_memoryconstruct-copy-destruct"></a><code class="computeroutput">xsi_shared_memory</code>
65 construct/copy/destruct</h3>
66 <div class="orderedlist"><ol class="orderedlist" type="1">
68 <pre class="literallayout"><a name="idp67408752-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
69 <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>
72 <pre class="literallayout"><a name="idp67410224-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>
73 <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>
76 <pre class="literallayout"><a name="idp67412576-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>
77 <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>
78 <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>
81 <pre class="literallayout"><a name="idp67418048-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>
82 <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>
83 <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>
86 <pre class="literallayout"><a name="idp67423536-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>
87 <p>Tries to open a XSI shared memory with identifier 'key' If the shared memory does not previously exist, it throws an error. </p>
90 <pre class="literallayout"><a name="idp67426304-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>
91 <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>
94 <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="idp67428112-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>
95 <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>
98 <pre class="literallayout"><a name="idp67430480-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>
99 <p>Destroys *this. The shared memory won't be destroyed, just this connection to it. Use remove() to destroy the shared memory. </p>
103 <div class="refsect2">
104 <a name="idp252727136"></a><h3>
105 <a name="idp67402736-bb"></a><code class="computeroutput">xsi_shared_memory</code> public member functions</h3>
106 <div class="orderedlist"><ol class="orderedlist" type="1">
107 <li class="listitem">
108 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67403296-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>
109 <li class="listitem">
110 <pre class="literallayout"><span class="keyword">int</span> <a name="idp67405440-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>
111 <p>Returns the shared memory ID that identifies the shared memory </p>
113 <li class="listitem">
114 <pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp67407024-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>
115 <p>Returns the mapping handle. Never throws </p>
119 <div class="refsect2">
120 <a name="idp252745792"></a><h3>
121 <a name="idp67431296-bb"></a><code class="computeroutput">xsi_shared_memory</code> public static functions</h3>
122 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
123 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp67431856-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>
124 <p>Erases the XSI shared memory object identified by shmid from the system. Returns false on error. Never throws </p>
129 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
130 <td align="left"></td>
131 <td align="right"><div class="copyright-footer">Copyright © 2005-2012 Ion Gaztanaga<p>
132 Distributed under the Boost Software License, Version 1.0. (See accompanying
133 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>)
138 <div class="spirit-nav">
139 <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>