doc/html/boost/signals2/slot_base.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class slot_base</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../signals2/reference.html#header.boost.signals2.slot_base_hpp" title="Header &lt;boost/signals2/slot_base.hpp&gt;">
   9 <link rel="prev" href="slot/arg.html" title="Class template arg">
  10 <link rel="next" href="expired_slot.html" title="Class expired_slot">
  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="slot/arg.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals2/reference.html#header.boost.signals2.slot_base_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="expired_slot.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.signals2.slot_base"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class slot_base</span></h2>
  29 <p>boost::signals2::slot_base &#8212; Base class for slots.</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="../../signals2/reference.html#header.boost.signals2.slot_base_hpp" title="Header &lt;boost/signals2/slot_base.hpp&gt;">boost/signals2/slot_base.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="slot_base.html" title="Class slot_base">slot_base</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">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">detail</span></em></span><span class="special">&gt;</span> <a name="boost.signals2.slot_base.locked_container_type"></a><span class="identifier">locked_container_type</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="slot_base.html#id825649-bb">tracking</a></span>
  41   <span class="keyword">bool</span> <a class="link" href="slot_base.html#id825652-bb"><span class="identifier">expired</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  42   <span class="identifier">locked_container_type</span> <a class="link" href="slot_base.html#id825669-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43 <span class="special">}</span><span class="special">;</span></pre></div>
  44 <div class="refsect1">
  45 <a name="id3232467"></a><h2>Description</h2>
  46 <p></p>
  47 <div class="refsect2">
  48 <a name="id3232474"></a><h3>
  49 <a name="id825649-bb"></a><code class="computeroutput">slot_base</code> tracking</h3>
  50 <div class="orderedlist"><ol class="orderedlist" type="1">
  51 <li class="listitem">
  52 <pre class="literallayout"><span class="keyword">bool</span> <a name="id825652-bb"></a><span class="identifier">expired</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  53 <div class="variablelist"><table border="0">
  54 <col align="left" valign="top">
  55 <tbody><tr>
  56 <td><p><span class="term">Returns:</span></p></td>
  57 <td><p><code class="computeroutput">true</code> if any tracked object has expired.</p></td>
  58 </tr></tbody>
  59 </table></div>
  60 </li>
  61 <li class="listitem">
  62 <pre class="literallayout"><span class="identifier">locked_container_type</span> <a name="id825669-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  63 <div class="variablelist"><table border="0">
  64 <col align="left" valign="top">
  65 <tbody>
  66 <tr>
  67 <td><p><span class="term">Returns:</span></p></td>
  68 <td>A container holding <code class="computeroutput">shared_ptr</code>s to each of the slot's tracked objects.  As long
  69             as the returned container is kept in scope, none of the slot's tracked objects can expire.</td>
  70 </tr>
  71 <tr>
  72 <td><p><span class="term">Throws:</span></p></td>
  73 <td>
  74 <a class="link" href="expired_slot.html" title="Class expired_slot">expired_slot</a> if any of the slot's tracked objects have expired.</td>
  75 </tr>
  76 </tbody>
  77 </table></div>
  78 </li>
  79 </ol></div>
  80 </div>
  81 </div>
  82 </div>
  83 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  84 <td align="left"></td>
  85 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2004 Douglas Gregor<br>Copyright &#169; 2007-2009 Frank Mori Hess<p>Distributed under the Boost
  86     Software License, Version 1.0. (See accompanying file
  87     <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
  88 </div></td>
  89 </tr></table>
  90 <hr>
  91 <div class="spirit-nav">
  92 <a accesskey="p" href="slot/arg.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals2/reference.html#header.boost.signals2.slot_base_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="expired_slot.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  93 </div>
  94 </body>
  95 </html>