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 fe2a649da9..24ba84ddda 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_p_idm46381346734368.html" title="Function template to_raw_pointer"> -<link rel="next" href="swap_idm46381346693792.html" title="Function template swap"> +<link rel="prev" href="to_raw_p_idm45963400004048.html" title="Function template to_raw_pointer"> +<link rel="next" href="swap_idm45963399963472.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_p_idm46381346734368.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_idm46381346693792.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="to_raw_p_idm45963400004048.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_idm45963399963472.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#idm46381346698512-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#idm46381346694800-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#idm45963399968192-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#idm45963399964480-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#idm46381346719072-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idm46381346718512-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#idm46381346716192-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#idm46381346713472-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#idm46381346712128-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#idm46381346710528-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#idm46381346709232-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#idm46381346707664-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#idm46381346706368-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#idm46381346704800-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#idm46381346703248-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#idm46381346701680-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#idm45963399988752-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idm45963399988192-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#idm45963399985872-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#idm45963399983152-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#idm45963399981808-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#idm45963399980208-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#idm45963399978912-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#idm45963399977344-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#idm45963399976048-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#idm45963399974480-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#idm45963399972928-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#idm45963399971360-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.19.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="idm46381346698512-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="idm45963399968192-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="idm46381346694800-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="idm45963399964480-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.19.17.3.51.4.4.4"></a><h3> -<a name="idm46381346719072-bb"></a><code class="computeroutput">scoped_ptr</code> public member functions</h3> +<a name="idm45963399988752-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="idm46381346718512-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="idm45963399988192-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="idm46381346716192-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="idm45963399985872-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="idm46381346713472-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="idm45963399983152-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="idm46381346712128-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="idm45963399981808-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="idm46381346710528-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="idm45963399980208-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="idm46381346709232-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="idm45963399978912-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="idm46381346707664-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="idm45963399977344-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="idm46381346706368-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="idm45963399976048-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="idm46381346704800-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="idm45963399974480-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="idm46381346703248-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="idm45963399972928-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="idm46381346701680-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="idm45963399971360-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_p_idm46381346734368.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_idm46381346693792.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="to_raw_p_idm45963400004048.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_idm45963399963472.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |