doc/html/boost/interprocess/xsi_key.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class xsi_key</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../boost_interprocess_reference.html#header.boost.interprocess.xsi_key_hpp" title="Header &lt;boost/interprocess/xsi_key.hpp&gt;">
   9 <link rel="prev" href="windows_shared_memory.html" title="Class windows_shared_memory">
  10 <link rel="next" href="xsi_shared_memory.html" title="Class xsi_shared_memory">
  11 </head>
  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>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="windows_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.xsi_key_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="xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.interprocess.xsi_key"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class xsi_key</span></h2>
  29 <p>boost::interprocess::xsi_key</p>
  30 </div>
  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: &lt;<a class="link" href="../../boost_interprocess_reference.html#header.boost.interprocess.xsi_key_hpp" title="Header &lt;boost/interprocess/xsi_key.hpp&gt;">boost/interprocess/xsi_key.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="xsi_key.html#boost.interprocess.xsi_keyconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="xsi_key.html#id1009145-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="xsi_key.html#id1009157-bb"><span class="identifier">xsi_key</span></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">boost</span><span class="special">::</span><span class="identifier">uint8_t</span><span class="special">)</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="xsi_key.html#id1009131-bb">public member functions</a></span>
  42   <span class="identifier">key_t</span> <a class="link" href="xsi_key.html#id1009135-bb"><span class="identifier">get_key</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43 <span class="special">}</span><span class="special">;</span></pre></div>
  44 <div class="refsect1">
  45 <a name="id1903829"></a><h2>Description</h2>
  46 <p>A class that wraps XSI (System V) key_t type. This type calculates key_t from path and id using ftok or sets key to IPC_PRIVATE using the default constructor. </p>
  47 <div class="refsect2">
  48 <a name="id1903837"></a><h3>
  49 <a name="boost.interprocess.xsi_keyconstruct-copy-destruct"></a><code class="computeroutput">xsi_key</code>
  50         public
  51        construct/copy/destruct</h3>
  52 <div class="orderedlist"><ol class="orderedlist" type="1">
  53 <li class="listitem">
  54 <pre class="literallayout"><a name="id1009145-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  55 <p>Default constructor. Represents a private <code class="computeroutput"><a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a></code>. </p>
  56 </li>
  57 <li class="listitem">
  58 <pre class="literallayout"><a name="id1009157-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> path<span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span> id<span class="special">)</span><span class="special">;</span></pre>
  59 <p>Creates a new XSI shared memory with a key obtained from a call to ftok (with path "path" and id "id"), of size "size" and permissions "perm". If the shared memory previously exists, throws an error. </p>
  60 </li>
  61 </ol></div>
  62 </div>
  63 <div class="refsect2">
  64 <a name="id1903970"></a><h3>
  65 <a name="id1009131-bb"></a><code class="computeroutput">xsi_key</code> public member functions</h3>
  66 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  67 <pre class="literallayout"><span class="identifier">key_t</span> <a name="id1009135-bb"></a><span class="identifier">get_key</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the internal key_t value. </li></ol></div>
  68 </div>
  69 </div>
  70 </div>
  71 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  72 <td align="left"></td>
  73 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2011 Ion Gaztanaga<p>
  74         Distributed under the Boost Software License, Version 1.0. (See accompanying
  75         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>)
  76       </p>
  77 </div></td>
  78 </tr></table>
  79 <hr>
  80 <div class="spirit-nav">
  81 <a accesskey="p" href="windows_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.xsi_key_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="xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  82 </div>
  83 </body>
  84 </html>