[Boost-commit] svn:boost r49185 - sandbox/thread_safe_signals/trunk/libs/signals2/doc

Subject: [Boost-commit] svn:boost r49185 - sandbox/thread_safe_signals/trunk/libs/signals2/doc
From: fmhess_at_[hidden]
Date: 2008-10-08 14:45:38

Author: fmhess
Date: 2008-10-08 14:45:37 EDT (Wed, 08 Oct 2008)
New Revision: 49185
URL: http://svn.boost.org/trac/boost/changeset/49185

Log:
Updated faq entry on API changes with new extended_slot_type.

Text files modified: 
   sandbox/thread_safe_signals/trunk/libs/signals2/doc/faq.xml |    14 ++++++++++++++                          
   1 files changed, 14 insertions(+), 0 deletions(-)

Modified: sandbox/thread_safe_signals/trunk/libs/signals2/doc/faq.xml
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/faq.xml	(original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/faq.xml	2008-10-08 14:45:37 EDT (Wed, 08 Oct 2008)
@@ -69,9 +69,23 @@
           </listitem>
           <listitem>
             <para>
+              The <classname>signal</classname> class has an additional typedef
+              <classname alt="signalN::extended_slot_type">signal::extended_slot_type</classname>
+              and new <methodname alt="signalN::connect_extended">signal::connect_extended</methodname>()
+              methods.  These allow connection of slots
+              which take an additional <classname>connection</classname> argument, giving them thread-safe
+              access to their signal/slot connection when they are invoked.  There is also an
+              additional ExtendedSlotFunction template parameter for specifying the underlying slot function
+              type for the new extended slots.
+            </para>
+          </listitem>
+          <listitem>
+            <para>
               The <classname>signal</classname> class has an additional template parameter for specifying
               the mutex type used internally by the signal.
             </para>
+          </listitem>
+          <listitem>
             <para>The <code>signal::combiner()</code> method, which formerly returned a reference to the
               signal's combiner has been replaced by <methodname alt="signalN::combiner">signal::combiner</methodname>
               (which now returns the combiner by value) and <methodname alt="signalN::set_combiner">signal::set_combiner</methodname>.