doc/html/boost/signals2/slot_base.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Class slot_base</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="../../signals2/reference.html#header.boost.signals2.slot_base_hpp" title="Header &lt;boost/signals2/slot_base.hpp&gt;">
  10 <link rel="prev" href="slot/arg.html" title="Class template arg">
  11 <link rel="next" href="expired_slot.html" title="Class expired_slot">
  12 </head>
  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>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <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>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.signals2.slot_base"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class slot_base</span></h2>
  30 <p>boost::signals2::slot_base &#8212; Base class for slots.</p>
  31 </div>
  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: &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;
  34
  35 </span>
  36 <span class="keyword">class</span> <a class="link" href="slot_base.html" title="Class slot_base">slot_base</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">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>
  40
  41   <span class="comment">// <a class="link" href="slot_base.html#idp720175552-bb">tracking</a></span>
  42   <span class="keyword">bool</span> <a class="link" href="slot_base.html#idp720176112-bb"><span class="identifier">expired</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43   <span class="identifier">locked_container_type</span> <a class="link" href="slot_base.html#idp720178432-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  44 <span class="special">}</span><span class="special">;</span></pre></div>
  45 <div class="refsect1">
  46 <a name="idp524835232"></a><h2>Description</h2>
  47 <p></p>
  48 <div class="refsect2">
  49 <a name="idp524836032"></a><h3>
  50 <a name="idp720175552-bb"></a><code class="computeroutput">slot_base</code> tracking</h3>
  51 <div class="orderedlist"><ol class="orderedlist" type="1">
  52 <li class="listitem">
  53 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp720176112-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>
  54 <div class="variablelist"><table border="0" class="variablelist compact">
  55 <colgroup>
  56 <col align="left" valign="top">
  57 <col>
  58 </colgroup>
  59 <tbody><tr>
  60 <td><p><span class="term">Returns:</span></p></td>
  61 <td><p><code class="computeroutput">true</code> if any tracked object has expired.</p></td>
  62 </tr></tbody>
  63 </table></div>
  64 </li>
  65 <li class="listitem">
  66 <pre class="literallayout"><span class="identifier">locked_container_type</span> <a name="idp720178432-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>
  67 <div class="variablelist"><table border="0" class="variablelist compact">
  68 <colgroup>
  69 <col align="left" valign="top">
  70 <col>
  71 </colgroup>
  72 <tbody>
  73 <tr>
  74 <td><p><span class="term">Returns:</span></p></td>
  75 <td>A container holding <code class="computeroutput">shared_ptr</code>s to each of the slot's tracked objects.  As long
  76             as the returned container is kept in scope, none of the slot's tracked objects can expire.</td>
  77 </tr>
  78 <tr>
  79 <td><p><span class="term">Throws:</span></p></td>
  80 <td>
  81 <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>
  82 </tr>
  83 </tbody>
  84 </table></div>
  85 </li>
  86 </ol></div>
  87 </div>
  88 </div>
  89 </div>
  90 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  91 <td align="left"></td>
  92 <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
  93     Software License, Version 1.0. (See accompanying file
  94     <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>
  95 </div></td>
  96 </tr></table>
  97 <hr>
  98 <div class="spirit-nav">
  99 <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>
 100 </div>
 101 </body>
 102 </html>