1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5 <title>Class template intrusive_ptr</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.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>">
10 <link rel="prev" href="deleter.html" title="Class template deleter">
11 <link rel="next" href="operator_idm45336641201200.html" title="Function template operator==">
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>
23 <div class="spirit-nav">
24 <a accesskey="p" href="deleter.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_idm45336641201200.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="refentry">
27 <a name="boost.interprocess.intrusive_ptr"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class template intrusive_ptr</span></h2>
30 <p>boost::interprocess::intrusive_ptr</p>
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.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>">boost/interprocess/smart_ptr/intrusive_ptr.hpp</a>>
35 </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> VoidPointer<span class="special">></span>
36 <span class="keyword">class</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">{</span>
37 <span class="keyword">public</span><span class="special">:</span>
38 <span class="comment">// types</span>
39 <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"><</span> <span class="identifier">VoidPointer</span> <span class="special">></span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">rebind_pointer</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></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>
40 <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>
42 <span class="comment">// <a class="link" href="intrusive_ptr.html#boost.interprocess.intrusive_ptrconstruct-copy-destruct">construct/copy/destruct</a></span>
43 <a class="link" href="intrusive_ptr.html#idm45336641223696-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
44 <a class="link" href="intrusive_ptr.html#idm45336641222672-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">&</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="keyword">noexcept</span><span class="special">;</span>
45 <a class="link" href="intrusive_ptr.html#idm45336641219904-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">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
46 <a class="link" href="intrusive_ptr.html#idm45336641217840-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">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> <a class="link" href="intrusive_ptr.html#idm45336641215968-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"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
48 <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641212432-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">BOOST_COPY_ASSIGN_REF</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special">)</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
49 <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641209680-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">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
50 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span>
51 <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641207120-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"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
52 <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641203680-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="keyword">noexcept</span><span class="special">;</span>
53 <a class="link" href="intrusive_ptr.html#idm45336641213040-bb"><span class="special">~</span><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
55 <span class="comment">// <a class="link" href="intrusive_ptr.html#idm45336641239568-bb">public member functions</a></span>
56 <span class="keyword">void</span> <a class="link" href="intrusive_ptr.html#idm45336641239008-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
57 <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641237344-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
58 <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641235760-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
59 <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641234176-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="keyword">noexcept</span><span class="special">;</span>
60 <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641232624-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="keyword">noexcept</span><span class="special">;</span>
61 <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idm45336641231072-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
62 <a class="link" href="intrusive_ptr.html#idm45336641229520-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="keyword">noexcept</span><span class="special">;</span>
63 <span class="keyword">bool</span> <a class="link" href="intrusive_ptr.html#idm45336641227968-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="keyword">noexcept</span><span class="special">;</span>
64 <span class="keyword">void</span> <a class="link" href="intrusive_ptr.html#idm45336641226416-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">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
65 <span class="special">}</span><span class="special">;</span></pre></div>
66 <div class="refsect1">
67 <a name="id-1.3.19.17.3.50.4.4"></a><h2>Description</h2>
68 <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<T, void *> defines a class with a T* member whereas <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><T, offset_ptr<void> > defines a class with a offset_ptr<T> member. Relies on unqualified calls to:</p>
69 <p>void intrusive_ptr_add_ref(T * p) BOOST_NOEXCEPT; void intrusive_ptr_release(T * p) BOOST_NOEXCEPT;</p>
71 <p>The object is responsible for destroying itself. </p>
72 <div class="refsect2">
73 <a name="id-1.3.19.17.3.50.4.4.6"></a><h3>
74 <a name="boost.interprocess.intrusive_ptrconstruct-copy-destruct"></a><code class="computeroutput">intrusive_ptr</code>
76 construct/copy/destruct</h3>
77 <div class="orderedlist"><ol class="orderedlist" type="1">
79 <pre class="literallayout"><a name="idm45336641223696-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
80 <p>Constructor. Initializes internal pointer to 0. Does not throw </p>
83 <pre class="literallayout"><a name="idm45336641222672-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">&</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="keyword">noexcept</span><span class="special">;</span></pre>
84 <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>
87 <pre class="literallayout"><a name="idm45336641219904-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">&</span> rhs<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
88 <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>
91 <pre class="literallayout"><a name="idm45336641217840-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">&&</span> rhs<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Move constructor. Moves the internal pointer. Does not throw. </li>
93 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span>
94 <a name="idm45336641215968-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"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
95 <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>
98 <pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idm45336641212432-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">BOOST_COPY_ASSIGN_REF</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special">)</span> rhs<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
99 <p>Assignment operator. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p>
101 <li class="listitem">
102 <pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idm45336641209680-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">&&</span> rhs<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
103 <p>Move Assignment operator Does not throw </p>
105 <li class="listitem">
106 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span>
107 <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idm45336641207120-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"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
108 <p>Assignment from related. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p>
110 <li class="listitem">
111 <pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idm45336641203680-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="keyword">noexcept</span><span class="special">;</span></pre>
112 <p>Assignment from pointer. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p>
114 <li class="listitem">
115 <pre class="literallayout"><a name="idm45336641213040-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>Destructor. Calls reset(). Does not throw. </li>
118 <div class="refsect2">
119 <a name="id-1.3.19.17.3.50.4.4.7"></a><h3>
120 <a name="idm45336641239568-bb"></a><code class="computeroutput">intrusive_ptr</code> public member functions</h3>
121 <div class="orderedlist"><ol class="orderedlist" type="1">
122 <li class="listitem">
123 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336641239008-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
124 <p>Release internal pointer and set it to 0. If internal pointer is not 0, calls intrusive_ptr_release(to_raw_pointer(m_ptr)). Does not throw </p>
126 <li class="listitem">
127 <pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idm45336641237344-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
128 <p>Returns a reference to the internal pointer. Does not throw </p>
130 <li class="listitem">
131 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idm45336641235760-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
132 <p>Returns a reference to the internal pointer. Does not throw </p>
134 <li class="listitem">
135 <pre class="literallayout"><span class="identifier">T</span> <span class="special">&</span> <a name="idm45336641234176-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="keyword">noexcept</span><span class="special">;</span></pre>
136 <p>Returns *get(). Does not throw </p>
138 <li class="listitem">
139 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idm45336641232624-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="keyword">noexcept</span><span class="special">;</span></pre>
140 <p>Returns *get(). Does not throw </p>
142 <li class="listitem">
143 <pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idm45336641231072-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
144 <p>Returns get(). Does not throw </p>
146 <li class="listitem">
147 <pre class="literallayout"><a name="idm45336641229520-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="keyword">noexcept</span><span class="special">;</span></pre>
148 <p>Conversion to boolean. Does not throw </p>
150 <li class="listitem">
151 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45336641227968-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="keyword">noexcept</span><span class="special">;</span></pre>
152 <p>Not operator. Does not throw </p>
154 <li class="listitem">
155 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336641226416-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">&</span> rhs<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
156 <p>Exchanges the contents of the two smart pointers. Does not throw </p>
162 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
163 <td align="left"></td>
164 <td align="right"><div class="copyright-footer">Copyright © 2005-2015 Ion Gaztanaga<p>
165 Distributed under the Boost Software License, Version 1.0. (See accompanying
166 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>)
171 <div class="spirit-nav">
172 <a accesskey="p" href="deleter.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_idm45336641201200.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>