mirror of
https://github.com/boostorg/smart_ptr.git
synced 2025-07-31 21:24:40 +02:00
Casts removed as unsafe, added intro paragraph about make_shared.
[SVN r13180]
This commit is contained in:
Peter Dimov
99
weak_ptr.htm
99
weak_ptr.htm
@@ -18,6 +18,40 @@
|
|||||||
<p>The class template is parameterized on <b>T</b>, the type of the object pointed
|
<p>The class template is parameterized on <b>T</b>, the type of the object pointed
|
||||||
to. <b>T</b> must meet the smart pointer <a href="smart_ptr.htm#Common requirements">
|
to. <b>T</b> must meet the smart pointer <a href="smart_ptr.htm#Common requirements">
|
||||||
common requirements</a>.</p>
|
common requirements</a>.</p>
|
||||||
|
<P>Compared to <STRONG>shared_ptr</STRONG>, <STRONG>weak_ptr</STRONG> provides
|
||||||
|
a very limited subset of operations since accessing its stored pointer is
|
||||||
|
unsafe in multithreaded programs (that is, it may invoke undefined
|
||||||
|
behavior.) Consider, for example, this innocent piece of code:</P>
|
||||||
|
<pre>
|
||||||
|
shared_ptr<int> p(new int(5));
|
||||||
|
weak_ptr<int> q(p);
|
||||||
|
|
||||||
|
// some time later
|
||||||
|
|
||||||
|
if(int * r = q.get())
|
||||||
|
{
|
||||||
|
// use *r
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
<P>Imagine that after the <STRONG>if</STRONG>, but immediately before <STRONG>r</STRONG>
|
||||||
|
is used, another thread executes the statement <code>p.reset()</code>. Now <STRONG>r</STRONG>
|
||||||
|
is a dangling pointer.</P>
|
||||||
|
<P>The solution to this problem is to create a temporary <STRONG>shared_ptr</STRONG>
|
||||||
|
from <STRONG>q</STRONG>:</P>
|
||||||
|
<pre>
|
||||||
|
shared_ptr<int> p(new int(5));
|
||||||
|
weak_ptr<int> q(p);
|
||||||
|
|
||||||
|
// some time later
|
||||||
|
|
||||||
|
if(shared_ptr<int> r = <a href="#make_shared">make_shared</a>(q))
|
||||||
|
{
|
||||||
|
// use *r
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
<p>Now <STRONG>r</STRONG> holds a reference to the object that was pointed by <STRONG>q</STRONG>.
|
||||||
|
Even if <code>p.reset()</code> is executed in another thread, the object will
|
||||||
|
stay alive until <STRONG>r</STRONG> goes out of scope (or is reset.)</p>
|
||||||
<h2><a name="Synopsis">Synopsis</a></h2>
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
<pre>namespace boost {
|
<pre>namespace boost {
|
||||||
|
|
||||||
@@ -58,15 +92,6 @@
|
|||||||
template<typename T>
|
template<typename T>
|
||||||
shared_ptr<T> <a href="#make_shared">make_shared</a>(weak_ptr<T> const & r); // never throws
|
shared_ptr<T> <a href="#make_shared">make_shared</a>(weak_ptr<T> const & r); // never throws
|
||||||
|
|
||||||
template<typename T, typename U>
|
|
||||||
weak_ptr<T> <a href="#shared_static_cast">shared_static_cast</a>(weak_ptr<U> const & r); // never throws
|
|
||||||
template<typename T, typename U>
|
|
||||||
weak_ptr<T> <a href="#shared_dynamic_cast">shared_dynamic_cast</a>(weak_ptr<U> const & r);
|
|
||||||
template<typename T, typename U>
|
|
||||||
weak_ptr<T> <a href="#shared_polymorphic_cast">shared_polymorphic_cast</a>(weak_ptr<U> const & r);
|
|
||||||
template<typename T, typename U>
|
|
||||||
weak_ptr<T> <a href="#shared_polymorphic_downcast">shared_polymorphic_downcast</a>(weak_ptr<U> const & r); // never throws
|
|
||||||
|
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h2><a name="Members">Members</a></h2>
|
<h2><a name="Members">Members</a></h2>
|
||||||
@@ -206,62 +231,8 @@ template<typename T, typename U>
|
|||||||
<P><B>Returns:</B> <code>r.expired()? shared_ptr<T>(): shared_ptr<T>(r)</code>.</P>
|
<P><B>Returns:</B> <code>r.expired()? shared_ptr<T>(): shared_ptr<T>(r)</code>.</P>
|
||||||
<P><B>Throws:</B> nothing.</P>
|
<P><B>Throws:</B> nothing.</P>
|
||||||
</BLOCKQUOTE>
|
</BLOCKQUOTE>
|
||||||
<h3><a name="shared_static_cast">shared_static_cast</a></h3>
|
|
||||||
<pre>template<typename T, typename U>
|
|
||||||
weak_ptr<T> shared_static_cast(weak_ptr<U> const & r); // never throws</pre>
|
|
||||||
<BLOCKQUOTE>
|
|
||||||
<P><STRONG>Requires:</STRONG> The expression <code>static_cast<T*>(r.get())</code>
|
|
||||||
must be well-formed.</P>
|
|
||||||
<P><B>Returns:</B> A <STRONG>weak_ptr<T></STRONG> object that stores a copy
|
|
||||||
of <code>static_cast<T*>(r.get())</code> and shares ownership with <b>r</b>.</P>
|
|
||||||
<P><B>Throws:</B> nothing.</P>
|
|
||||||
</BLOCKQUOTE>
|
|
||||||
<h3><a name="shared_dynamic_cast">shared_dynamic_cast</a></h3>
|
|
||||||
<pre>template<typename T, typename U>
|
|
||||||
weak_ptr<T> shared_dynamic_cast(weak_ptr<U> const & r);</pre>
|
|
||||||
<BLOCKQUOTE>
|
|
||||||
<P><STRONG>Requires:</STRONG> The expression <CODE>dynamic_cast<T*>(r.get())</CODE>
|
|
||||||
must be well-formed and its behavior defined.</P>
|
|
||||||
<P><B>Returns:</B></P>
|
|
||||||
<UL>
|
|
||||||
<LI>
|
|
||||||
When <CODE>dynamic_cast<T*>(r.get())</CODE> returns a nonzero
|
|
||||||
value, a <STRONG>weak_ptr<T></STRONG> object that stores a copy of
|
|
||||||
it and shares ownership with <STRONG>r</STRONG>;
|
|
||||||
<LI>
|
|
||||||
Otherwise, a default-constructed <STRONG>weak_ptr<T></STRONG> object.</LI></UL>
|
|
||||||
<P><B>Throws:</B> <STRONG>std::bad_alloc</STRONG>.</P>
|
|
||||||
<P><B>Exception safety:</B> If an exception is thrown, the function has no effect.</P>
|
|
||||||
</BLOCKQUOTE>
|
|
||||||
<h3><a name="shared_polymorphic_cast">shared_polymorphic_cast</a></h3>
|
|
||||||
<pre>template<typename T, typename U>
|
|
||||||
weak_ptr<T> shared_polymorphic_cast(weak_ptr<U> const & r);</pre>
|
|
||||||
<BLOCKQUOTE>
|
|
||||||
<p><STRONG>Requires:</STRONG> The expression <CODE><A href="../conversion/cast.htm#Polymorphic_cast">
|
|
||||||
polymorphic_cast</A><T*>(r.get())</CODE> must be well-formed and
|
|
||||||
its behavior defined.</p>
|
|
||||||
<P><B>Returns:</B> A <STRONG>weak_ptr<T></STRONG> object that stores a copy
|
|
||||||
of <CODE><A href="../conversion/cast.htm#Polymorphic_cast">polymorphic_cast</A><T*>(r.get())</CODE>
|
|
||||||
and shares ownership with <B>r</B>.</P>
|
|
||||||
<P><B>Throws:</B> <STRONG>std::bad_cast</STRONG> when the pointer cannot be
|
|
||||||
converted.</P>
|
|
||||||
<P><B>Exception safety:</B> If an exception is thrown, the function has no effect.</P>
|
|
||||||
</BLOCKQUOTE>
|
|
||||||
<h3><a name="shared_polymorphic_downcast">shared_polymorphic_downcast</a></h3>
|
|
||||||
<pre>template<typename T, typename U>
|
|
||||||
weak_ptr<T> shared_polymorphic_downcast(weak_ptr<U> const & r); // never throws</pre>
|
|
||||||
<BLOCKQUOTE>
|
|
||||||
<p><STRONG>Requires:</STRONG> The expression <CODE><A href="../conversion/cast.htm#Polymorphic_cast">
|
|
||||||
polymorphic_downcast</A><T*>(r.get())</CODE> must be well-formed
|
|
||||||
and its behavior defined.</p>
|
|
||||||
<P><B>Returns:</B> A <STRONG>weak_ptr<T></STRONG> object that stores a copy
|
|
||||||
of <CODE><A href="../conversion/cast.htm#Polymorphic_cast">polymorphic_downcast</A><T*>(r.get())</CODE>
|
|
||||||
and shares ownership with <B>r</B>.</P>
|
|
||||||
<P><B>Throws:</B> nothing.</P>
|
|
||||||
</BLOCKQUOTE>
|
|
||||||
<hr>
|
<hr>
|
||||||
<p>Revised <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->
|
<p>Revised 12 March 2002<!--webbot bot="Timestamp" i-checksum="38439" endspan --></p>
|
||||||
8 March 2002<!--webbot bot="Timestamp" i-checksum="38439" endspan --></p>
|
|
||||||
<p>Copyright 1999 Greg Colvin and Beman Dawes. Copyright 2002 Darin Adler.
|
<p>Copyright 1999 Greg Colvin and Beman Dawes. Copyright 2002 Darin Adler.
|
||||||
Copyright 2002 Peter Dimov. Permission to copy, use, modify, sell and
|
Copyright 2002 Peter Dimov. Permission to copy, use, modify, sell and
|
||||||
distribute this document is granted provided this copyright notice appears in
|
distribute this document is granted provided this copyright notice appears in
|
||||||
|
|||||||
Reference in New Issue
Block a user