diff options
Diffstat (limited to 'doc/html/boost/interprocess/scoped_ptr.html')
| -rw-r--r-- | doc/html/boost/interprocess/scoped_ptr.html | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/doc/html/boost/interprocess/scoped_ptr.html b/doc/html/boost/interprocess/scoped_ptr.html index d67772284a..4475f2d14f 100644 --- a/doc/html/boost/interprocess/scoped_ptr.html +++ b/doc/html/boost/interprocess/scoped_ptr.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_hpp" title="Header <boost/interprocess/smart_ptr/scoped_ptr.hpp>"> -<link rel="prev" href="to_raw_pointer_idp56218800.html" title="Function template to_raw_pointer"> -<link rel="next" href="swap_idp56259376.html" title="Function template swap"> +<link rel="prev" href="to_raw_pointer_idp40322096.html" title="Function template to_raw_pointer"> +<link rel="next" href="swap_idp40362672.html" title="Function template swap"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="to_raw_pointer_idp56218800.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_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="swap_idp56259376.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="to_raw_pointer_idp40322096.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_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="swap_idp40362672.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.scoped_ptr"></a><div class="titlepage"></div> @@ -42,21 +42,21 @@ <span class="keyword">typedef</span> <span class="identifier">pointer</span> <span class="identifier">this_type</span><span class="special">::</span><span class="special">*</span> <a name="boost.interprocess.scoped_ptr.unspecified_bool_type"></a><span class="identifier">unspecified_bool_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="scoped_ptr.html#boost.interprocess.scoped_ptrconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="scoped_ptr.html#idp56254656-bb"><span class="identifier">scoped_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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_ptr.html#idp56258368-bb"><span class="special">~</span><span class="identifier">scoped_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="scoped_ptr.html#idp40357952-bb"><span class="identifier">scoped_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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_ptr.html#idp40361664-bb"><span class="special">~</span><span class="identifier">scoped_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="scoped_ptr.html#idp56234096-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp56234656-bb"><span class="identifier">reset</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="number">0</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp56236976-bb"><span class="identifier">reset</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">const</span> <span class="identifier">Deleter</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">pointer</span> <a class="link" href="scoped_ptr.html#idp56239696-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">reference</span> <a class="link" href="scoped_ptr.html#idp56241040-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> - <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp56242640-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp56243936-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> - <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp56245504-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp56246800-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="scoped_ptr.html#idp56248368-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> - <span class="keyword">bool</span> <a class="link" href="scoped_ptr.html#idp56249920-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> - <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp56251488-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="scoped_ptr.html#idp40337392-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp40337952-bb"><span class="identifier">reset</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="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp40340272-bb"><span class="identifier">reset</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">const</span> <span class="identifier">Deleter</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="scoped_ptr.html#idp40342992-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="scoped_ptr.html#idp40344336-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> + <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp40345936-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp40347232-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> + <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp40348800-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp40350096-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="scoped_ptr.html#idp40351664-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> + <span class="keyword">bool</span> <a class="link" href="scoped_ptr.html#idp40353216-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> + <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp40354784-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> <a name="id-1.3.18.17.3.51.4.4"></a><h2>Description</h2> @@ -68,61 +68,61 @@ construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56254656-bb"></a><span class="identifier">scoped_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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> d <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp40357952-bb"></a><span class="identifier">scoped_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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> d <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs a <code class="computeroutput"><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a></code>, storing a copy of p(which can be 0) and d. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp56258368-bb"></a><span class="special">~</span><span class="identifier">scoped_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp40361664-bb"></a><span class="special">~</span><span class="identifier">scoped_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>If the stored pointer is not 0, destroys the object pointed to by the stored pointer. calling the operator() of the stored deleter. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> <a name="id-1.3.18.17.3.51.4.4.4"></a><h3> -<a name="idp56234096-bb"></a><code class="computeroutput">scoped_ptr</code> public member functions</h3> +<a name="idp40337392-bb"></a><code class="computeroutput">scoped_ptr</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp56234656-bb"></a><span class="identifier">reset</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="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp40337952-bb"></a><span class="identifier">reset</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="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Deletes the object pointed to by the stored pointer and then stores a copy of p. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp56236976-bb"></a><span class="identifier">reset</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">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> d<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp40340272-bb"></a><span class="identifier">reset</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">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> d<span class="special">)</span><span class="special">;</span></pre> <p>Deletes the object pointed to by the stored pointer and then stores a copy of p and a copy of d. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp56239696-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp40342992-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Assigns internal pointer as 0 and returns previous pointer. This will avoid deletion on destructor </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">reference</span> <a name="idp56241040-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> +<pre class="literallayout"><span class="identifier">reference</span> <a name="idp40344336-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> <p>Returns a reference to the object pointed to by the stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56242640-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp40345936-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the internal stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56243936-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> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp40347232-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> <p>Returns the internal stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56245504-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp40348800-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56246800-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> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp40350096-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> <p>Returns the stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp56248368-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> +<pre class="literallayout"><a name="idp40351664-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> <p>Conversion to bool Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56249920-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> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp40353216-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> <p>Returns true if the stored pointer is 0. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp56251488-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp40354784-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre> <p>Exchanges the internal pointer and deleter with other <code class="computeroutput"><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a></code> Never throws. </p> </li> </ol></div> @@ -139,7 +139,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="to_raw_pointer_idp56218800.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_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="swap_idp56259376.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="to_raw_pointer_idp40322096.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_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="swap_idp40362672.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |