doc/html/boost/interprocess/intrusive_ptr.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template intrusive_ptr</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.smart_ptr.intrusive_ptr_hpp" title="Header &lt;boost/interprocess/smart_ptr/intrusive_ptr.hpp&gt;">
   9 <link rel="prev" href="enable_shared_from_this.html" title="Class template enable_shared_from_this">
  10 <link rel="next" href="operator___idp66031168.html" title="Function template operator==">
  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="enable_shared_from_this.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp66031168.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.interprocess.intrusive_ptr"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template intrusive_ptr</span></h2>
  29 <p>boost::interprocess::intrusive_ptr</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="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header &lt;boost/interprocess/smart_ptr/intrusive_ptr.hpp&gt;">boost/interprocess/smart_ptr/intrusive_ptr.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> VoidPointer<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">intrusive</span><span class="special">::</span><span class="identifier">pointer_traits</span><span class="special">&lt;</span> <span class="identifier">VoidPointer</span> <span class="special">&gt;</span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">rebind_pointer</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.interprocess.intrusive_ptr.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>       <span class="comment">// Provides the type of the internal stored pointer. </span>
  39   <span class="keyword">typedef</span> <span class="identifier">T</span>                                                                                   <a name="boost.interprocess.intrusive_ptr.element_type"></a><span class="identifier">element_type</span><span class="special">;</span>  <span class="comment">// Provides the type of the stored pointer. </span>
  40
  41   <span class="comment">// <a class="link" href="intrusive_ptr.html#boost.interprocess.intrusive_ptrconstruct-copy-destruct">construct/copy/destruct</a></span>
  42   <a class="link" href="intrusive_ptr.html#idp66014976-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  43   <a class="link" href="intrusive_ptr.html#idp66015728-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span>
  44   <a class="link" href="intrusive_ptr.html#idp66018224-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <a class="link" href="intrusive_ptr.html#idp66020016-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special">&lt;</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&amp;</span> <a class="link" href="intrusive_ptr.html#idp66023472-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
  48     <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&amp;</span> <a class="link" href="intrusive_ptr.html#idp66025792-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special">&lt;</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  49   <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&amp;</span> <a class="link" href="intrusive_ptr.html#idp66028960-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span><span class="special">;</span>
  50   <a class="link" href="intrusive_ptr.html#idp66022672-bb"><span class="special">~</span><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51
  52   <span class="comment">// <a class="link" href="intrusive_ptr.html#idp66001584-bb">public member functions</a></span>
  53   <span class="identifier">pointer</span> <span class="special">&amp;</span> <a class="link" href="intrusive_ptr.html#idp66002144-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> <a class="link" href="intrusive_ptr.html#idp66003456-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55   <span class="identifier">T</span> <span class="special">&amp;</span> <a class="link" href="intrusive_ptr.html#idp66005040-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56   <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> <a class="link" href="intrusive_ptr.html#idp66006592-bb"><span class="keyword">operator</span><span class="special">-&gt;</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57   <span class="identifier">pointer</span> <span class="special">&amp;</span> <a class="link" href="intrusive_ptr.html#idp66008144-bb"><span class="keyword">operator</span><span class="special">-&gt;</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  58   <a class="link" href="intrusive_ptr.html#idp66009424-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="keyword">bool</span> <a class="link" href="intrusive_ptr.html#idp66010976-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  60   <span class="keyword">void</span> <a class="link" href="intrusive_ptr.html#idp66012528-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  61 <span class="special">}</span><span class="special">;</span></pre></div>
  62 <div class="refsect1">
  63 <a name="idp244666256"></a><h2>Description</h2>
  64 <p>The <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> class template stores a pointer to an object with an embedded reference count. <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> is parameterized on T (the type of the object pointed to) and VoidPointer(a void pointer type that defines the type of pointer that <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> will store). intrusive_ptr&lt;T, void *&gt; defines a class with a T* member whereas <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a>&lt;T, offset_ptr&lt;void&gt; &gt; defines a class with a offset_ptr&lt;T&gt; member. Relies on unqualified calls to:</p>
  65 <p>void intrusive_ptr_add_ref(T * p); void intrusive_ptr_release(T * p);</p>
  66 <p>with (p != 0)</p>
  67 <p>The object is responsible for destroying itself. </p>
  68 <div class="refsect2">
  69 <a name="idp244671872"></a><h3>
  70 <a name="boost.interprocess.intrusive_ptrconstruct-copy-destruct"></a><code class="computeroutput">intrusive_ptr</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="idp66014976-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  76 <p>Constructor. Initializes internal pointer to 0. Does not throw </p>
  77 </li>
  78 <li class="listitem">
  79 <pre class="literallayout"><a name="idp66015728-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> p<span class="special">,</span> <span class="keyword">bool</span> add_ref <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre>
  80 <p>Constructor. Copies pointer and if "p" is not zero and "add_ref" is true calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </p>
  81 </li>
  82 <li class="listitem">
  83 <pre class="literallayout"><a name="idp66018224-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
  84 <p>Copy constructor. Copies the internal pointer and if "p" is not zero calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </p>
  85 </li>
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <a name="idp66020016-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special">&lt;</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
  88 <p>Constructor from related. Copies the internal pointer and if "p" is not zero calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </p>
  89 </li>
  90 <li class="listitem">
  91 <pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&amp;</span> <a name="idp66023472-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
  92 <p>Assignment operator. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p>
  93 </li>
  94 <li class="listitem">
  95 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
  96   <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&amp;</span> <a name="idp66025792-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special">&lt;</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
  97 <p>Assignment from related. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p>
  98 </li>
  99 <li class="listitem">
 100 <pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&amp;</span> <a name="idp66028960-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">pointer</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 101 <p>Assignment from pointer. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p>
 102 </li>
 103 <li class="listitem">
 104 <pre class="literallayout"><a name="idp66022672-bb"></a><span class="special">~</span><span class="identifier">intrusive_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 105 <p>Destructor. If internal pointer is not 0, calls intrusive_ptr_release(to_raw_pointer(m_ptr)). Does not throw </p>
 106 </li>
 107 </ol></div>
 108 </div>
 109 <div class="refsect2">
 110 <a name="idp244737840"></a><h3>
 111 <a name="idp66001584-bb"></a><code class="computeroutput">intrusive_ptr</code> public member functions</h3>
 112 <div class="orderedlist"><ol class="orderedlist" type="1">
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&amp;</span> <a name="idp66002144-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 115 <p>Returns a reference to the internal pointer. Does not throw </p>
 116 </li>
 117 <li class="listitem">
 118 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> <a name="idp66003456-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 119 <p>Returns a reference to the internal pointer. Does not throw </p>
 120 </li>
 121 <li class="listitem">
 122 <pre class="literallayout"><span class="identifier">T</span> <span class="special">&amp;</span> <a name="idp66005040-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 123 <p>Returns *get(). Does not throw </p>
 124 </li>
 125 <li class="listitem">
 126 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> <a name="idp66006592-bb"></a><span class="keyword">operator</span><span class="special">-&gt;</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 127 <p>Returns *get(). Does not throw </p>
 128 </li>
 129 <li class="listitem">
 130 <pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&amp;</span> <a name="idp66008144-bb"></a><span class="keyword">operator</span><span class="special">-&gt;</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 131 <p>Returns get(). Does not throw </p>
 132 </li>
 133 <li class="listitem">
 134 <pre class="literallayout"><a name="idp66009424-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 135 <p>Conversion to boolean. Does not throw </p>
 136 </li>
 137 <li class="listitem">
 138 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp66010976-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 139 <p>Not operator. Does not throw </p>
 140 </li>
 141 <li class="listitem">
 142 <pre class="literallayout"><span class="keyword">void</span> <a name="idp66012528-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 143 <p>Exchanges the contents of the two smart pointers. Does not throw </p>
 144 </li>
 145 </ol></div>
 146 </div>
 147 </div>
 148 </div>
 149 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 150 <td align="left"></td>
 151 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2012 Ion Gaztanaga<p>
 152         Distributed under the Boost Software License, Version 1.0. (See accompanying
 153         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>)
 154       </p>
 155 </div></td>
 156 </tr></table>
 157 <hr>
 158 <div class="spirit-nav">
 159 <a accesskey="p" href="enable_shared_from_this.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp66031168.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 160 </div>
 161 </body>
 162 </html>